[PATCH] Clarify documentation of git-cvsserver, particularly in relation to git-shell
From: Scott Collins <hidden>
Date: 2016-06-15 22:44:29
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
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 <redacted> --- 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