[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: Best Practices

From: Karl Fogel <kfogel_at_newton.ch.collab.net>
Date: 2002-08-01 23:49:20 CEST

Scott Lamb <slamb@slamb.org> writes:
> That's not entirely true. I was interested in a chapter or appendix to
> the Subversion Handbook on general best practices for using SCM,
> including stuff like "use a consistent indentation style/correct line
> endings" These are not specific to Subversion but particularly
> important for SCM systems (so diffs aren't obfuscated with
> reindentation, etc). I lost interest when it was clear it wouldn't be
> accepted as part of the handbook. It just wasn't worth it to me to
> create a whole new project for what I expected to be a couple pages of
> tips.

(Sorry to have forgotten about that post of yours!)

Yeah, we should also teach people about the flags to `svn diff' that
make it ignore whitespace. That's fine to include in the Handbook.

Hmmm. Let me try to explain myself more clearly: There are two paths
this specific example could take:

   1. "You should use consistent formatting because it makes your code
      easier to read, and not everyone has wide screens and
      line-ending-tolerant editors."

versus

   2. "If you use only spaces for indentation, and maintain a
      consistent indentation style, then the 'svn diff' command will
      not show spurious diffs. Also, you should know about the
      following options to 'svn diff -x'..."

They're both about formatting, but (2) is geared toward the Subversion
Handbook, where as (1) is not. I'm always okay with stuff of the (2)
variety, but feel strongly that we shouldn't include stuff of the (1)
variety.

Keep it about Subversion, or clearly related to Subversion, that's all
I'm saying.

Is that clearer?

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Fri Aug 2 00:04:24 2002

This is an archived mail posted to the Subversion Dev mailing list.

This site is subject to the Apache Privacy Policy and the Apache Public Forum Archive Policy.