You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@subversion.apache.org by VK Sameer <sa...@collab.net> on 2004/11/18 04:15:27 UTC
[PATCH] Update location of design document in HACKING
Hello,
I couldn't locate the design document on the website earlier because
this page (http://subversion.tigris.org/servlets/ProjectDocumentList)
said "There are no files in this folder". Technically, that is correct,
there are only folders in that folder! Ben Collins-Sussman was kind
enough to point out that one had to expand/open the Documentation folder
to see the documents. Attached is a patch to HACKING that uses '->'
instead of '/' to suggest more clearly that opening the folder is
required. Once Documentation is opened, it becomes obvious that Releases
has to be treated the same way.
Regards
Sameer
Log:
* HACKING
Make location of design docs in Subversion website clearer.
Re: [PATCH] Update location of design document in HACKING
Posted by VK Sameer <sa...@collab.net>.
On Fri, 2004-11-19 at 00:08, kfogel@collab.net wrote:
> VK Sameer <sa...@collab.net> writes:
> > I thought it was because the extra words exceeded the 72-char limit and
> > pushed some words onto the next line. Is it better to let the extra
> > words push the limit out to 80 chars?
>
> Well, in fact the extra character (there was only one) left that line
> still shorter than the lines either above and below it, which were at
> 71 and 70 chars respectively.
Huh, thought I'd put "" around Documentation->Design. That would have
pushed it to 73. Guess I took them out.
> I think it's fine to refill when things are getting long; just in this
> case, it wasn't necessary.
OK.
> I never even knew the 'fmt' command existed until now, thanks for the
> (accidental) tip :-).
There's also a fold command, but my fingers have memorized fmt :)
Sameer
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: [PATCH] Update location of design document in HACKING
Posted by kf...@collab.net.
VK Sameer <sa...@collab.net> writes:
> I thought it was because the extra words exceeded the 72-char limit and
> pushed some words onto the next line. Is it better to let the extra
> words push the limit out to 80 chars?
Well, in fact the extra character (there was only one) left that line
still shorter than the lines either above and below it, which were at
71 and 70 chars respectively. So, I don't know why fmt made the
decision it did.
I think it's fine to refill when things are getting long; just in this
case, it wasn't necessary.
> OK, will do that next time. It looks like fmt already has an option.
> >From 'fmt --help':
> [...]
> -u, --uniform-spacing one space between words, two after sentences
> [...]
I never even knew the 'fmt' command existed until now, thanks for the
(accidental) tip :-).
-K
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: [PATCH] Update location of design document in HACKING
Posted by VK Sameer <sa...@collab.net>.
On Thu, 2004-11-18 at 11:02, kfogel@collab.net wrote:
> VK Sameer <sa...@collab.net> writes:
>
> Couple of (minor) things to watch out for:
Thanks, I'm a little nitpicky myself, so this is useful.
> I think after you changed
> "/" to "->" in the first hunk, you must have used your editor's
> refill-paragraph function (or reflow, or whatever it's called).
Actually, I shell'd out to 'fmt -72' ...
> This
> had two interesting effects: it made the diff look bigger than it
> actually is,
I thought it was because the extra words exceeded the 72-char limit and
pushed some words onto the next line. Is it better to let the extra
words push the limit out to 80 chars?
> and it made there be one space after a sentence-ending
> period instead of two spaces. We actually try to use two spaces.
> I've never been clear on how exactly standard this is, although I know
> it didn't start with us. The benefits of using two spaces are
> slightly improved readability, and being able to use sentence-motion
> commands in editors.
OK, will do that next time. It looks like fmt already has an option.
From 'fmt --help':
[...]
-u, --uniform-spacing one space between words, two after sentences
[...]
> Again, very minor, just pointing these things out for next time.
Thanks
Sameer
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: [PATCH] Update location of design document in HACKING
Posted by kf...@collab.net.
VK Sameer <sa...@collab.net> writes:
> I couldn't locate the design document on the website earlier because
> this page (http://subversion.tigris.org/servlets/ProjectDocumentList)
> said "There are no files in this folder". Technically, that is correct,
> there are only folders in that folder! Ben Collins-Sussman was kind
> enough to point out that one had to expand/open the Documentation folder
> to see the documents. Attached is a patch to HACKING that uses '->'
> instead of '/' to suggest more clearly that opening the folder is
> required. Once Documentation is opened, it becomes obvious that Releases
> has to be treated the same way.
Thanks! Applied in r11941.
Couple of (minor) things to watch out for: I think after you changed
"/" to "->" in the first hunk, you must have used your editor's
refill-paragraph function (or reflow, or whatever it's called). This
had two interesting effects: it made the diff look bigger than it
actually is, and it made there be one space after a sentence-ending
period instead of two spaces. We actually try to use two spaces.
I've never been clear on how exactly standard this is, although I know
it didn't start with us. The benefits of using two spaces are
slightly improved readability, and being able to use sentence-motion
commands in editors.
Again, very minor, just pointing these things out for next time.
-Karl
> Log:
>
> * HACKING
> Make location of design docs in Subversion website clearer.
> Index: HACKING
> ===================================================================
> --- HACKING (revision 11940)
> +++ HACKING (working copy)
> @@ -62,9 +62,9 @@
>
> * Print out and digest the Subversion design specification.
> This document can be found in the "Documents & files" area of the
> - website in the Documentation/Design folder. A PDF and an HTML
> - version are available on the web. The design spec will give you
> - a theoretical overview of Subversion's design.
> + website in the "Documentation->Design" folder. A PDF
> + and an HTML version are available on the web. The design spec
> + will give you a theoretical overview of Subversion's design.
>
> There are many ways to join the project, either by writing code, or by
> testing and/or helping to manage the bug database. If you'd like to
> @@ -112,7 +112,7 @@
> Greg Stein has written an introduction to Subversion's network
> protocol, which is an extended dialect of HTTP. The document is
> 'www/webdav-usage.html', and is also posted on the website in
> - the "File sharing" section.
> + the "Documents & files" section in "Documentation->Design".
>
>
> 3. USER MANUAL
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
> For additional commands, e-mail: dev-help@subversion.tigris.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org