diff options
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/Makefile | 6 | ||||
| -rw-r--r-- | Documentation/asciidoc.conf | 10 | ||||
| -rw-r--r-- | Documentation/git-add.txt | 3 | ||||
| -rw-r--r-- | Documentation/git-archimport.txt | 2 | ||||
| -rw-r--r-- | Documentation/git-cvsserver.txt | 85 | ||||
| -rw-r--r-- | Documentation/git-fetch-pack.txt | 2 | ||||
| -rw-r--r-- | Documentation/git-pack-redundant.txt | 2 | ||||
| -rw-r--r-- | Documentation/git-rm.txt | 3 | ||||
| -rw-r--r-- | Documentation/git-shell.txt | 2 | ||||
| -rw-r--r-- | Documentation/git-shortlog.txt | 2 | ||||
| -rw-r--r-- | Documentation/git-show-branch.txt | 6 | ||||
| -rw-r--r-- | Documentation/git-update-ref.txt | 2 | ||||
| -rw-r--r-- | Documentation/git-var.txt | 2 |
13 files changed, 91 insertions, 36 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile index a3bca86cb0..f4cbf7e159 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -1,4 +1,7 @@ -MAN1_TXT=$(wildcard git-*.txt) gitk.txt +MAN1_TXT= \ + $(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \ + $(wildcard git-*.txt)) \ + gitk.txt MAN7_TXT=git.txt DOC_HTML=$(patsubst %.txt,%.html,$(MAN1_TXT) $(MAN7_TXT)) @@ -11,6 +14,7 @@ ARTICLES += howto-index ARTICLES += repository-layout ARTICLES += hooks ARTICLES += everyday +ARTICLES += git-tools # with their own formatting rules. SP_ARTICLES = glossary howto/revert-branch-rebase diff --git a/Documentation/asciidoc.conf b/Documentation/asciidoc.conf index fa0877d483..7ce71510de 100644 --- a/Documentation/asciidoc.conf +++ b/Documentation/asciidoc.conf @@ -18,6 +18,16 @@ ifdef::backend-docbook[] {0#</citerefentry>} endif::backend-docbook[] +ifdef::backend-docbook[] +# "unbreak" docbook-xsl v1.68 for manpages. v1.69 works with or without this. +[listingblock] +<example><title>{title}</title> +<literallayout> +| +</literallayout> +{title#}</example> +endif::backend-docbook[] + ifdef::backend-xhtml11[] [gitlink-inlinemacro] <a href="{target}.html">{target}{0?({0})}</a> diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt index 7e293834d1..5b7c354554 100644 --- a/Documentation/git-add.txt +++ b/Documentation/git-add.txt @@ -65,6 +65,9 @@ git-add git-*.sh:: (i.e. you are listing the files explicitly), it does not add `subdir/git-foo.sh` to the index. +See Also +-------- +gitlink:git-rm[1] Author ------ diff --git a/Documentation/git-archimport.txt b/Documentation/git-archimport.txt index 023d3ae7b9..5a13187a87 100644 --- a/Documentation/git-archimport.txt +++ b/Documentation/git-archimport.txt @@ -9,7 +9,7 @@ git-archimport - Import an Arch repository into git SYNOPSIS -------- [verse] -`git-archimport` [-h] [-v] [-o] [-a] [-f] [-T] [-D depth] [-t tempdir] +'git-archimport' [-h] [-v] [-o] [-a] [-f] [-T] [-D depth] [-t tempdir] <archive/branch> [ <archive/branch> ] DESCRIPTION diff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt index 19c9c51cff..4dc13c35db 100644 --- a/Documentation/git-cvsserver.txt +++ b/Documentation/git-cvsserver.txt @@ -5,14 +5,12 @@ NAME ---- git-cvsserver - A CVS server emulator for git - SYNOPSIS -------- [verse] export CVS_SERVER=git-cvsserver 'cvs' -d :ext:user@server/path/repo.git co <HEAD_name> - DESCRIPTION ----------- @@ -27,48 +25,85 @@ plugin. Most functionality works fine with both of these clients. LIMITATIONS ----------- -Currently gitcvs only works over ssh connections. +Currently cvsserver works over SSH connections for read/write clients, and +over pserver for anonymous CVS access. + +CVS clients cannot tag, branch or perform GIT merges. INSTALLATION ------------ -1. Put server.pl somewhere useful on the same machine that is hosting your git repos + +1. If you are going to offer anonymous CVS access via pserver, add a line in + /etc/inetd.conf like + + cvspserver stream tcp nowait nobody git-cvsserver pserver + + Note: In some cases, you need to pass the 'pserver' argument twice for + git-cvsserver to see it. So the line would look like + + cvspserver stream tcp nowait nobody git-cvsserver pserver pserver + + No special setup is needed for SSH access, other than having GIT tools + in the PATH. If you have clients that do not accept the CVS_SERVER + env variable, you can rename git-cvsserver to cvs. 2. For each repo that you want accessible from CVS you need to edit config in the repo and add the following section. [gitcvs] enabled=1 + # optional for debugging logfile=/path/to/logfile - n.b. you need to ensure each user that is going to invoke server.pl has - write access to the log file. + Note: you need to ensure each user that is going to invoke git-cvsserver has + write access to the log file and to the git repository. When offering anon + access via pserver, this means that the nobody user should have write access + to at least the sqlite database at the root of the repository. + +3. On the client machine you need to set the following variables. + CVSROOT should be set as per normal, but the directory should point at the + appropriate git repo. For example: + + For SSH access, CVS_SERVER should be set to git-cvsserver + + Example: -5. On each client machine you need to set the following variables. - CVSROOT should be set as per normal, but the directory should point at the - appropriate git repo. - CVS_SERVER should be set to the server.pl script that has been put on the - remote machine. + export CVSROOT=:ext:user@server:/var/git/project.git + export CVS_SERVER=git-cvsserver -6. Clients should now be able to check out modules (where modules are the names - of branches in git). - $ cvs co -d mylocaldir master +4. For SSH clients that will make commits, make sure their .bashrc file + sets the GIT_AUTHOR and GIT_COMMITTER variables. + +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: + + cvs co -d project-master master Eclipse CVS Client Notes ------------------------ To get a checkout with the Eclipse CVS client: -1. Create a new project from CVS checkout, giving it repository and module -2. Context Menu->Team->Share Project... -3. Enter the repository and module information again and click Finish -4. The Synchronize view appears. Untick "launch commit wizard" to avoid -committing the .project file, and select HEAD as the tag to synchronize to. -Update all incoming changes. - -Note that most versions of Eclipse ignore CVS_SERVER (which you can set in -the Preferences->Team->CVS->ExtConnection pane), so you may have to -rename, alias or symlink git-cvsserver to 'cvs' on the server. +1. Select "Create a new project -> From CVS checkout" +2. Create a new location. See the notes below for details on how to choose the + right protocol. +3. Browse the 'modules' available. It will give you a list of the heads in + the repository. You will not be able to browse the tree from there. Only + the heads. +4. Pick 'HEAD' when it asks what branch/tag to check out. Untick the + "launch commit wizard" to avoid committing the .project file. + +Protocol notes: If you are using anonymous acces via pserver, just select that. +Those using SSH access should choose the 'ext' protocol, and configure 'ext' +access on the Preferences->Team->CVS->ExtConnection pane. Set CVS_SERVER to +'git-cvsserver'. Not that password support is not good when using 'ext', +you will definitely want to have SSH keys setup. + +Alternatively, you can just use the non-standard extssh protocol that Eclipse +offer. In that case CVS_SERVER is ignored, and you will have to replace +the cvs utility on the server with git-cvsserver or manipulate your .bashrc +so that calling 'cvs' effectively calls git-cvsserver. Clients known to work --------------------- @@ -106,7 +141,7 @@ Authors: Martyn Smith <martyn@catalyst.net.nz> Documentation -------------- -Documentation by Martyn Smith <martyn@catalyst.net.nz> and Martin Langhoff <martin@catalyst.net.nz>Matthias Urlichs <smurf@smurf.noris.de>. +Documentation by Martyn Smith <martyn@catalyst.net.nz> and Martin Langhoff <martin@catalyst.net.nz> Matthias Urlichs <smurf@smurf.noris.de>. GIT --- diff --git a/Documentation/git-fetch-pack.txt b/Documentation/git-fetch-pack.txt index b507e9b648..913b75bb8d 100644 --- a/Documentation/git-fetch-pack.txt +++ b/Documentation/git-fetch-pack.txt @@ -8,7 +8,7 @@ git-fetch-pack - Receive missing objects from another repository. SYNOPSIS -------- -git-fetch-pack [-q] [-k] [--exec=<git-upload-pack>] [<host>:]<directory> [<refs>...] +'git-fetch-pack' [-q] [-k] [--exec=<git-upload-pack>] [<host>:]<directory> [<refs>...] DESCRIPTION ----------- diff --git a/Documentation/git-pack-redundant.txt b/Documentation/git-pack-redundant.txt index 2f4cc46510..a81cb97814 100644 --- a/Documentation/git-pack-redundant.txt +++ b/Documentation/git-pack-redundant.txt @@ -8,7 +8,7 @@ git-pack-redundant - Program used to find redundant pack files. SYNOPSIS -------- -'git-pack-redundant [ --verbose ] [ --alt-odb ] < --all | .pack filename ... >' +'git-pack-redundant' [ --verbose ] [ --alt-odb ] < --all | .pack filename ... > DESCRIPTION ----------- diff --git a/Documentation/git-rm.txt b/Documentation/git-rm.txt index 401bfb2d9c..d8a5afae03 100644 --- a/Documentation/git-rm.txt +++ b/Documentation/git-rm.txt @@ -74,6 +74,9 @@ git-rm -f git-*.sh:: shell expand the asterisk (i.e. you are listing the files explicitly), it does not remove `subdir/git-foo.sh`. +See Also +-------- +gitlink:git-add[1] Author ------ diff --git a/Documentation/git-shell.txt b/Documentation/git-shell.txt index 3f4d804cca..cc4266d83b 100644 --- a/Documentation/git-shell.txt +++ b/Documentation/git-shell.txt @@ -8,7 +8,7 @@ git-shell - Restricted login shell for GIT over SSH only SYNOPSIS -------- -'git-shell -c <command> <argument>' +'git-shell' -c <command> <argument> DESCRIPTION ----------- diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt index 65ca77fbf6..bf8db8bac6 100644 --- a/Documentation/git-shortlog.txt +++ b/Documentation/git-shortlog.txt @@ -8,7 +8,7 @@ git-shortlog - Summarize 'git log' output. SYNOPSIS -------- -'git-log --pretty=short | git shortlog' +git-log --pretty=short | 'git-shortlog' DESCRIPTION ----------- diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt index 7b1a9c9875..e474cd0ba7 100644 --- a/Documentation/git-show-branch.txt +++ b/Documentation/git-show-branch.txt @@ -8,9 +8,9 @@ git-show-branch - Show branches and their commits. SYNOPSIS -------- [verse] -git-show-branch [--all] [--heads] [--tags] [--topo-order] [--current] - [--more=<n> | --list | --independent | --merge-base] - [--no-name | --sha1-name] [<rev> | <glob>]... +'git-show-branch' [--all] [--heads] [--tags] [--topo-order] [--current] + [--more=<n> | --list | --independent | --merge-base] + [--no-name | --sha1-name] [<rev> | <glob>]... DESCRIPTION ----------- diff --git a/Documentation/git-update-ref.txt b/Documentation/git-update-ref.txt index 69715aa061..475237f19e 100644 --- a/Documentation/git-update-ref.txt +++ b/Documentation/git-update-ref.txt @@ -7,7 +7,7 @@ git-update-ref - update the object name stored in a ref safely SYNOPSIS -------- -`git-update-ref` <ref> <newvalue> [<oldvalue>] +'git-update-ref' <ref> <newvalue> [<oldvalue>] DESCRIPTION ----------- diff --git a/Documentation/git-var.txt b/Documentation/git-var.txt index c22d34f5fb..90cb157be5 100644 --- a/Documentation/git-var.txt +++ b/Documentation/git-var.txt @@ -8,7 +8,7 @@ git-var - Print the git users identity SYNOPSIS -------- -git-var [ -l | <variable> ] +'git-var' [ -l | <variable> ] DESCRIPTION ----------- |