Update documentation of fetch-pack, push and send-pack

add all supported options to Documentation/git-....txt and the usage strings.

Signed-off-by: Uwe Kleine-König <zeisberg@informatik.uni-freiburg.de>
Signed-off-by: Junio C Hamano <junkio@cox.net>
This commit is contained in:
Uwe Kleine-König 2007-01-19 13:43:00 +01:00 committed by Junio C Hamano
parent 89bf207758
commit 18bd8821ca
6 changed files with 33 additions and 13 deletions

View File

@ -8,7 +8,7 @@ git-fetch-pack - Receive missing objects from another repository
SYNOPSIS SYNOPSIS
-------- --------
'git-fetch-pack' [-q] [-k] [--exec=<git-upload-pack>] [<host>:]<directory> [<refs>...] 'git-fetch-pack' [--all] [--quiet|-q] [--keep|-k] [--thin] [--exec=<git-upload-pack>] [--depth=<n>] [-v] [<host>:]<directory> [<refs>...]
DESCRIPTION DESCRIPTION
----------- -----------
@ -28,17 +28,24 @@ have a common ancestor commit.
OPTIONS OPTIONS
------- -------
-q:: \--all::
Fetch all remote refs.
\--quiet, \-q::
Pass '-q' flag to 'git-unpack-objects'; this makes the Pass '-q' flag to 'git-unpack-objects'; this makes the
cloning process less verbose. cloning process less verbose.
-k:: \--keep, \-k::
Do not invoke 'git-unpack-objects' on received data, but Do not invoke 'git-unpack-objects' on received data, but
create a single packfile out of it instead, and store it create a single packfile out of it instead, and store it
in the object database. If provided twice then the pack is in the object database. If provided twice then the pack is
locked against repacking. locked against repacking.
--exec=<git-upload-pack>:: \--thin::
Spend extra cycles to minimize the number of objects to be sent.
Use it on slower connection.
\--exec=<git-upload-pack>::
Use this to specify the path to 'git-upload-pack' on the Use this to specify the path to 'git-upload-pack' on the
remote side, if is not found on your $PATH. remote side, if is not found on your $PATH.
Installations of sshd ignores the user's environment Installations of sshd ignores the user's environment
@ -50,6 +57,12 @@ OPTIONS
shells by having a lean .bashrc file (they set most of shells by having a lean .bashrc file (they set most of
the things up in .bash_profile). the things up in .bash_profile).
\--depth=<n>::
Limit fetching to ancestor-chains not longer than n.
\-v::
Run verbosely.
<host>:: <host>::
A remote host that houses the repository. When this A remote host that houses the repository. When this
part is specified, 'git-upload-pack' is invoked via part is specified, 'git-upload-pack' is invoked via

View File

@ -8,7 +8,7 @@ git-push - Update remote refs along with associated objects
SYNOPSIS SYNOPSIS
-------- --------
'git-push' [--all] [--tags] [--exec=<receive-pack>] [--repo=all] [-f | --force] [-v] [<repository> <refspec>...] 'git-push' [--all] [--tags] [--exec=<git-receive-pack>] [--repo=all] [-f | --force] [-v] [<repository> <refspec>...]
DESCRIPTION DESCRIPTION
----------- -----------

View File

@ -8,7 +8,7 @@ git-send-pack - Push objects over git protocol to another reposiotory
SYNOPSIS SYNOPSIS
-------- --------
'git-send-pack' [--all] [--force] [--exec=<git-receive-pack>] [<host>:]<directory> [<ref>...] 'git-send-pack' [--all] [--force] [--exec=<git-receive-pack>] [--verbose] [--thin] [<host>:]<directory> [<ref>...]
DESCRIPTION DESCRIPTION
----------- -----------
@ -21,23 +21,30 @@ updates it from the current repository, sending named refs.
OPTIONS OPTIONS
------- -------
--exec=<git-receive-pack>:: \--exec=<git-receive-pack>::
Path to the 'git-receive-pack' program on the remote Path to the 'git-receive-pack' program on the remote
end. Sometimes useful when pushing to a remote end. Sometimes useful when pushing to a remote
repository over ssh, and you do not have the program in repository over ssh, and you do not have the program in
a directory on the default $PATH. a directory on the default $PATH.
--all:: \--all::
Instead of explicitly specifying which refs to update, Instead of explicitly specifying which refs to update,
update all refs that locally exist. update all refs that locally exist.
--force:: \--force::
Usually, the command refuses to update a remote ref that Usually, the command refuses to update a remote ref that
is not an ancestor of the local ref used to overwrite it. is not an ancestor of the local ref used to overwrite it.
This flag disables the check. What this means is that This flag disables the check. What this means is that
the remote repository can lose commits; use it with the remote repository can lose commits; use it with
care. care.
\--verbose::
Run verbosely.
\--thin::
Spend extra cycles to minimize the number of objects to be sent.
Use it on slower connection.
<host>:: <host>::
A remote host to house the repository. When this A remote host to house the repository. When this
part is specified, 'git-receive-pack' is invoked via part is specified, 'git-receive-pack' is invoked via

View File

@ -8,7 +8,7 @@
#define MAX_URI (16) #define MAX_URI (16)
static const char push_usage[] = "git-push [--all] [--tags] [-f | --force] <repository> [<refspec>...]"; static const char push_usage[] = "git-push [--all] [--tags] [--exec=<git-receive-pack>] [--repo=all] [-f | --force] [-v] [<repository> <refspec>...]";
static int all, tags, force, thin = 1, verbose; static int all, tags, force, thin = 1, verbose;
static const char *execute; static const char *execute;

View File

@ -12,7 +12,7 @@ static int verbose;
static int fetch_all; static int fetch_all;
static int depth; static int depth;
static const char fetch_pack_usage[] = static const char fetch_pack_usage[] =
"git-fetch-pack [--all] [-q] [-v] [-k] [--thin] [--exec=upload-pack] [--depth=<n>] [host:]directory <refs>..."; "git-fetch-pack [--all] [--quiet|-q] [--keep|-k] [--thin] [--exec=<git-upload-pack>] [--depth=<n>] [-v] [<host>:]<directory> [<refs>...]";
static const char *exec = "git-upload-pack"; static const char *exec = "git-upload-pack";
#define COMPLETE (1U << 0) #define COMPLETE (1U << 0)

View File

@ -6,8 +6,8 @@
#include "exec_cmd.h" #include "exec_cmd.h"
static const char send_pack_usage[] = static const char send_pack_usage[] =
"git-send-pack [--all] [--exec=git-receive-pack] <remote> [<head>...]\n" "git-send-pack [--all] [--force] [--exec=<git-receive-pack>] [--verbose] [--thin] [<host>:]<directory> [<ref>...]\n"
" --all and explicit <head> specification are mutually exclusive."; " --all and explicit <ref> specification are mutually exclusive.";
static const char *exec = "git-receive-pack"; static const char *exec = "git-receive-pack";
static int verbose; static int verbose;
static int send_all; static int send_all;