From 34b18118d2302c38d59cfd7ddc6c124836741b00 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Thu, 23 Feb 2006 11:21:40 +0000 Subject: [PATCH] Autogenerated HTML docs for v1.2.2-g9821 --- git-cvsserver.html | 370 ++++++++++++++++++++++++++++++++++++++++++++++++ git-cvsserver.txt | 89 ++++++++++++ git-rm.html | 402 +++++++++++++++++++++++++++++++++++++++++++++++++++++ git-rm.txt | 89 ++++++++++++ 4 files changed, 950 insertions(+) create mode 100644 git-cvsserver.html create mode 100644 git-cvsserver.txt create mode 100644 git-rm.html create mode 100644 git-rm.txt diff --git a/git-cvsserver.html b/git-cvsserver.html new file mode 100644 index 00000000..ca2f3ab5 --- /dev/null +++ b/git-cvsserver.html @@ -0,0 +1,370 @@ + + + + + + +git-cvsserver(1) + + + +

SYNOPSIS

+
+
+
export CVS_SERVER=git-cvsserver +cvs -d :ext:user@server/path/repo.git co <HEAD_name>
+
+

DESCRIPTION

+
+

This application is a CVS emulation layer for git.

+

It is highly functional. However, not all methods are implemented, +and for those methods that are implemented, +not all switches are implemented.

+

Testing has been done using both the CLI CVS client, and the Eclipse CVS +plugin. Most functionality works fine with both of these clients.

+
+

LIMITATIONS

+
+

Currently gitcvs only works over ssh connections.

+
+

INSTALLATION

+
+
    +
  1. +

    +Put server.pl somewhere useful on the same machine that is hosting your git repos +

    +
    2. +
  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
+     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.
    +
    +
    3. +
  3. +

    +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. +

    +
    4. +
  4. +

    +Clients should now be able to check out modules (where modules are the names + of branches in git). + $ cvs co -d mylocaldir master +

    +
    5. +
+
+

Operations supported

+
+

All the operations required for normal use are supported, including +checkout, diff, status, update, log, add, remove, commit. +Legacy monitoring operations are not supported (edit, watch and related). +Exports and tagging (tags and branches) are not supported at this stage.

+

The server will set the -k mode to binary when relevant. In proper GIT +tradition, the contents of the files are always respected. +No keyword expansion or newline munging is supported.

+
+

Dependencies

+
+

git-cvsserver depends on DBD::SQLite.

+
+

Copyright and Authors

+
+

This program is copyright The Open University UK - 2006.

+

Authors: Martyn Smith <martyn@catalyst.net.nz> + Martin Langhoff <martin@catalyst.net.nz> + with ideas and patches from participants of the git-list <git@vger.kernel.org>.

+
+

Documentation

+
+

Documentation by Martyn Smith <martyn@catalyst.net.nz> and Martin Langhoff <martin@catalyst.net.nz>Matthias Urlichs <smurf@smurf.noris.de>.

+
+

GIT

+
+

Part of the git(7) suite

+
+ + + diff --git a/git-cvsserver.txt b/git-cvsserver.txt new file mode 100644 index 00000000..88f07ff1 --- /dev/null +++ b/git-cvsserver.txt @@ -0,0 +1,89 @@ +git-cvsserver(1) +================ + +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 + + +DESCRIPTION +----------- + +This application is a CVS emulation layer for git. + +It is highly functional. However, not all methods are implemented, +and for those methods that are implemented, +not all switches are implemented. + +Testing has been done using both the CLI CVS client, and the Eclipse CVS +plugin. Most functionality works fine with both of these clients. + +LIMITATIONS +----------- +Currently gitcvs only works over ssh connections. + + +INSTALLATION +------------ +1. Put server.pl somewhere useful on the same machine that is hosting your git repos + +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 + 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. + +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. + +6. Clients should now be able to check out modules (where modules are the names + of branches in git). + $ cvs co -d mylocaldir master + +Operations supported +-------------------- + +All the operations required for normal use are supported, including +checkout, diff, status, update, log, add, remove, commit. +Legacy monitoring operations are not supported (edit, watch and related). +Exports and tagging (tags and branches) are not supported at this stage. + +The server will set the -k mode to binary when relevant. In proper GIT +tradition, the contents of the files are always respected. +No keyword expansion or newline munging is supported. + +Dependencies +------------ + +git-cvsserver depends on DBD::SQLite. + +Copyright and Authors +--------------------- + +This program is copyright The Open University UK - 2006. + +Authors: Martyn Smith + Martin Langhoff + with ideas and patches from participants of the git-list . + +Documentation +-------------- +Documentation by Martyn Smith and Martin Langhoff Matthias Urlichs . + +GIT +--- +Part of the gitlink:git[7] suite diff --git a/git-rm.html b/git-rm.html new file mode 100644 index 00000000..a9df33f1 --- /dev/null +++ b/git-rm.html @@ -0,0 +1,402 @@ + + + + + + +git-rm(1) + + + +

SYNOPSIS

+
+

git-rm [-f] [-n] [-v] [--] <file>…

+
+

DESCRIPTION

+
+

A convenience wrapper for git-update-index --remove. For those coming +from cvs, git-rm provides an operation similar to "cvs rm" or "cvs +remove".

+
+

OPTIONS

+
+
+
+<file>… +
+
+

+ Files to remove from the index and optionally, from the + working tree as well. +

+
+
+-f +
+
+

+ Remove files from the working tree as well as from the index. +

+
+
+-n +
+
+

+ Don't actually remove the file(s), just show if they exist in + the index. +

+
+
+-v +
+
+

+ Be verbose. +

+
+
+— +
+
+

+ This option can be used to separate command-line options from + the list of files, (useful when filenames might be mistaken + for command-line options). +

+
+
+
+

DISCUSSION

+
+

The list of <file> given to the command is fed to git-ls-files +command to list files that are registered in the index and +are not ignored/excluded by $GIT_DIR/info/exclude file or +.gitignore file in each directory. This means two things:

+
    +
  1. +

    +You can put the name of a directory on the command line, and the + command will remove all files in it and its subdirectories (the + directories themselves are never removed from the working tree); +

    +
    2. +
  2. +

    +Giving the name of a file that is not in the index does not + remove that file. +

    +
    3. +
+
+

EXAMPLES

+
+
+
+git-rm Documentation/\*.txt +
+
+

+ Removes all *.txt files from the index that are under the + Documentation directory and any of its subdirectories. The + files are not removed from the working tree. +

+

Note that the asterisk * is quoted from the shell in this +example; this lets the command include the files from +subdirectories of Documentation/ directory.

+
+
+git-rm -f git-*.sh +
+
+

+ Remove all git-*.sh scripts that are in the index. The files + are removed from the index, and (because of the -f option), + from the working tree as well. Because this example lets the + shell expand the asterisk (i.e. you are listing the files + explicitly), it does not remove subdir/git-foo.sh. +

+
+
+
+

Author

+
+

Written by Linus Torvalds <torvalds@osdl.org>

+
+

Documentation

+
+

Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.

+
+

GIT

+
+

Part of the git(7) suite

+
+ + + diff --git a/git-rm.txt b/git-rm.txt new file mode 100644 index 00000000..401bfb2d --- /dev/null +++ b/git-rm.txt @@ -0,0 +1,89 @@ +git-rm(1) +========= + +NAME +---- +git-rm - Remove files from the working tree and from the index. + +SYNOPSIS +-------- +'git-rm' [-f] [-n] [-v] [--] ... + +DESCRIPTION +----------- +A convenience wrapper for git-update-index --remove. For those coming +from cvs, git-rm provides an operation similar to "cvs rm" or "cvs +remove". + + +OPTIONS +------- +...:: + Files to remove from the index and optionally, from the + working tree as well. + +-f:: + Remove files from the working tree as well as from the index. + +-n:: + Don't actually remove the file(s), just show if they exist in + the index. + +-v:: + Be verbose. + +--:: + This option can be used to separate command-line options from + the list of files, (useful when filenames might be mistaken + for command-line options). + + +DISCUSSION +---------- + +The list of given to the command is fed to `git-ls-files` +command to list files that are registered in the index and +are not ignored/excluded by `$GIT_DIR/info/exclude` file or +`.gitignore` file in each directory. This means two things: + +. You can put the name of a directory on the command line, and the + command will remove all files in it and its subdirectories (the + directories themselves are never removed from the working tree); + +. Giving the name of a file that is not in the index does not + remove that file. + + +EXAMPLES +-------- +git-rm Documentation/\\*.txt:: + + Removes all `\*.txt` files from the index that are under the + `Documentation` directory and any of its subdirectories. The + files are not removed from the working tree. ++ +Note that the asterisk `\*` is quoted from the shell in this +example; this lets the command include the files from +subdirectories of `Documentation/` directory. + +git-rm -f git-*.sh:: + + Remove all git-*.sh scripts that are in the index. The files + are removed from the index, and (because of the -f option), + from the working tree as well. Because this example lets the + shell expand the asterisk (i.e. you are listing the files + explicitly), it does not remove `subdir/git-foo.sh`. + + +Author +------ +Written by Linus Torvalds + +Documentation +-------------- +Documentation by Junio C Hamano and the git-list . + +GIT +--- +Part of the gitlink:git[7] suite + -- 2.11.0