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

Re: [PATCH] Update location of design document in HACKING

From: <kfogel_at_collab.net>
Date: 2004-11-18 06:32:42 CET

VK Sameer <sameer@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
Received on Thu Nov 18 06:33:22 2004

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