git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Scott Collins <scc@ScottCollins.net>
To: git@vger.kernel.org
Cc: Scott Collins <scc@ScottCollins.net>
Subject: [PATCH] Clarify documentation of git-cvsserver, particularly in relation to git-shell
Date: Tue, 15 Apr 2008 11:30:02 -0400	[thread overview]
Message-ID: <1208273402-2152-1-git-send-email-scc@ScottCollins.net> (raw)

Currently, git-cvsserver requires CVS_SERVER to be set to 'cvs' if you are
restricted to git-shell, so we need to mention that here.  Previous wording
mentioning GIT_AUTHOR, GIT_COMMITTER variables may not have made clear we
really meant GIT_AUTHOR_(NAME|COMMITTER), etc.  Add a bit of text to
differentiate cvs -d (setting CVSROOT) from cvs co -d (setting the name of
the newly checked out directory).

Signed-off-by: Scott Collins <scc@ScottCollins.net>
---
 Documentation/git-cvsserver.txt |   19 +++++++++++++------
 1 files changed, 13 insertions(+), 6 deletions(-)

diff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt
index 9cec802..5e67a89 100644
--- a/Documentation/git-cvsserver.txt
+++ b/Documentation/git-cvsserver.txt
@@ -106,7 +106,10 @@ Note: Newer CVS versions (>= 1.12.11) also support specifying
 CVS_SERVER directly in CVSROOT like
 
 ------
-cvs -d ":ext;CVS_SERVER=git-cvsserver:user@server/path/repo.git" co <HEAD_name>
+cvs -d ":ext;CVS_SERVER=git-cvsserver:user@server/path/repo.git" co <HEAD_name> -d <dir_name>
+
+# or for git-shell users:
+cvs -d ":ext;CVS_SERVER=cvs:user@server/path/repo.git" co <HEAD_name> -d <dir_name>
 ------
 This has the advantage that it will be saved in your 'CVS/Root' files and
 you don't need to worry about always setting the correct environment
@@ -146,7 +149,8 @@ allowing access over SSH.
    appropriate git repo. For example:
 +
 --
-For SSH access, CVS_SERVER should be set to git-cvsserver
+For normal SSH access, CVS_SERVER should be set to git-cvsserver.  For those
+whose access is restricted to git-shell, CVS_SERVER should be set to cvs.
 
 Example:
 
@@ -155,14 +159,17 @@ Example:
      export CVS_SERVER=git-cvsserver
 ------
 --
-4. For SSH clients that will make commits, make sure their .bashrc file
-   sets the GIT_AUTHOR and GIT_COMMITTER variables.
+4. For SSH clients that will make commits, make sure their (server-side) .bashrc
+   files export GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, GIT_COMMITTER_NAME, and
+   GIT_COMMITTER_EMAIL.
 
 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
 ------
 
 [[dbbackend]]
-- 
1.5.5.49.gf43e2

             reply	other threads:[~2008-04-15 16:13 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-04-15 15:30 Scott Collins [this message]
2008-04-15 18:27 ` [PATCH] Clarify documentation of git-cvsserver, particularly in relation to git-shell Junio C Hamano
2008-04-15 19:33   ` Scott Collins
2008-04-15 21:03     ` Scott Collins
2008-04-19 15:43       ` Johannes Schindelin
2008-04-15 21:44     ` Scott Collins
2008-04-16 20:03       ` Junio C Hamano
2008-04-19 15:45   ` Johannes Schindelin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1208273402-2152-1-git-send-email-scc@ScottCollins.net \
    --to=scc@scottcollins.net \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).