Re: [PATCH] cvsserver: Document the GIT branches -> CVS modules mapping more prominently

From: Junio C Hamano <junkio@cox.net>
Date: Apr 12, 2007, 22:05 UTC
Message-ID: <7v3b35jlj4.fsf@assigned-by-dhcp.cox.net>
In-Reply-To: <11763896683800-git-send-email-frank@lichtenheld.de>

Frank Lichtenheld <frank@lichtenheld.de> writes:

Show 11 quoted lines

> Add a note about the branches -> modules mapping to LIMITATIONS because
> I really think it should be noted there and not just at the end of
> the installation step-by-step HOWTO.
>
> I used "git branches" there and changed "heads" to "branches" in
> my section about database configuration. I'm reluctant to replace
> all occourences of "head" with "branch" though because you always
> have to say "git branch" because CVS also has the concept of
> branches. You can say "head" though, because there is no such
> concept in CVS. In all the existing occourences of head other than
> the one I changed I think "head" flows better in the text.

Ah, I tend to agree.  Mind if I applied only the first hunk then?

Show 37 quoted lines

>
> Signed-off-by: Frank Lichtenheld <frank@lichtenheld.de>
> ---
>  Documentation/git-cvsserver.txt |    6 +++++-
>  1 files changed, 5 insertions(+), 1 deletions(-)
>
>  Caused by me thinking about Junio's comment.
>  Better patches welcome but my motivation to try to write clear
>  and concise sentences in English is depleted for now,
>  so no critical comments without patches, plz :)
>
> diff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt
> index 9fbaf75..3615ce5 100644
> --- a/Documentation/git-cvsserver.txt
> +++ b/Documentation/git-cvsserver.txt
> @@ -31,6 +31,10 @@ over pserver for anonymous CVS access.
>  
>  CVS clients cannot tag, branch or perform GIT merges.
>  
> +git-cvsserver maps GIT branches to CVS modules. This is very different
> +from what most CVS users would expect since in CVS modules usually represent
> +one or more directories.
> +
>  INSTALLATION
>  ------------
>  
> @@ -110,7 +114,7 @@ Example:
>  Database Backend
>  ----------------
>  
> -git-cvsserver uses one database per git head (i.e. CVS module) to
> +git-cvsserver uses one database per git branch (i.e. CVS module) to
>  store information about the repository for faster access. The
>  database doesn't contain any persitent data and can be completly
>  regenerated from the git repository at any time. The database
> -- 
> 1.5.1