Re: [PATCH] Clarify documentation of git-cvsserver, particularly in relation to git-shell

["Scott Collins" <scc@scottcollins.net>]

On Tue, Apr 15, 2008 at 2:27 PM, Junio C Hamano <gitster@pobox.com> wrote:
>  Thanks; please make it a habit to give a final round of proofreading
>  before you send your messages out.  For example, I do not think we meant
>  "GIT_AUTHOR_(NAME|COMMITTER)" ;-)

Yikes!  Correct.

>  Hmm.  Can't this be further improved?
>
>  My undestanding of the reasoning behind 0c696fe (Support cvs via
>  git-shell, 2007-10-09) is by doing this people do not have to say
>  CVS_SERVER and do this instead:
>
>         cvs -d :ext:[user@]cvs.example.com:/path/to/repo checkout foo
>
>  which would truly hide the fact that the server end is running something
>  funky, because the command line exactly matches how you would access the
>  real CVS repository over ssh.

If that's the case, then I should mention instead that users
restricted to git-shell should _not_ set or change CVS_SERVER, and
remove the extra examples.

>  Dscho, care to comment?  This commit happened while I was away so I do not
>  really _recall_ the discussion that led to it, but I have always thought
>  that was the intention.

I actually was very tempted to modify git-shell to understand
git-cvsserver; but decided to submit a documentation patch first,
hoping from the discussion I would learn if that was the right path.


>  >  5. Clients should now be able to check out the project. Use the CVS 'module'
>  > -   name to indicate what GIT 'head' you want to check out. Example:
>  > +   name to indicate what GIT 'head' you want to check out.  This also sets the
>  > +   name of your newly checked-out directory, unless you tell it otherwise with
>  > +   `-d <dir_name>` Example:
>  >  +
>  >  ------
>  > -     cvs co -d project-master master
>  > +     cvs co master -d project-master
>  >  ------
>
>  Are you sure you wanted to do this?  In any case this is different from
>  what I read you changed in your commit log message, where you clarified
>  distinction between d1 and d2 in "cvs -d d1 co -d d2 module".  Instead
>  what you did here is to change "cvs co -d d module" (which looks more
>  natural) to "cvs co module -d d" (which might work if the options are
>  reordered across parameters, but is unusual).

Hmmm.  My intent was to make it read more naturally, which for me is
"checkout this module, put it into this directory".  At least that's
how I've always said it to CVS.  Warning readers that there are two
different meanings for -d, and they probably want them both in the
same command is more important to me than moving the -d to the end.  A
better fix to that example would be something along the lines of:

  cvs -d <CVSROOT-as-above> co -d <dir-name> <head-name>

I didn't do that, though, because it looked like this example was
intended to be concrete.

I'll update my patch and re-submit after I test not setting
CVS_SERVER, and feel I have the right replacement example, if any, for
the text just above.
__________
Scott Collins