@matheusbsbs / matheus-bagliano / commits / 18bd8821ca
Fork 0

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>

Uwe Kleine-König committed Jan 19, 2007 at 13:43 UTC 18bd8821cace2f830e34574df6df30e072d0ed40
6 files changed +33 -13
Documentation/git-fetch-pack.txt
+17 -4
@@ -8,7 +8,7 @@ git-fetch-pack - Receive missing objects from another repository
8
9 SYNOPSIS
10 --------
11 -'git-fetch-pack' [-q] [-k] [--exec=<git-upload-pack>] [<host>:]<directory> [<refs>...]
11 +'git-fetch-pack' [--all] [--quiet|-q] [--keep|-k] [--thin] [--exec=<git-upload-pack>] [--depth=<n>] [-v] [<host>:]<directory> [<refs>...]
12
13 DESCRIPTION
14 -----------
@@ -28,17 +28,24 @@ have a common ancestor commit.
28
29 OPTIONS
30 -------
31 --q::
31 +\--all::
32 + Fetch all remote refs.
33 +
34 +\--quiet, \-q::
35 Pass '-q' flag to 'git-unpack-objects'; this makes the
36 cloning process less verbose.
37
35 --k::
38 +\--keep, \-k::
39 Do not invoke 'git-unpack-objects' on received data, but
40 create a single packfile out of it instead, and store it
41 in the object database. If provided twice then the pack is
42 locked against repacking.
43
41 ---exec=<git-upload-pack>::
44 +\--thin::
45 + Spend extra cycles to minimize the number of objects to be sent.
46 + Use it on slower connection.
47 +
48 +\--exec=<git-upload-pack>::
49 Use this to specify the path to 'git-upload-pack' on the
50 remote side, if is not found on your $PATH.
51 Installations of sshd ignores the user's environment
@@ -50,6 +57,12 @@ OPTIONS
57 shells by having a lean .bashrc file (they set most of
58 the things up in .bash_profile).
59
60 +\--depth=<n>::
61 + Limit fetching to ancestor-chains not longer than n.
62 +
63 +\-v::
64 + Run verbosely.
65 +
66 <host>::
67 A remote host that houses the repository. When this
68 part is specified, 'git-upload-pack' is invoked via
Documentation/git-push.txt
+1 -1
@@ -8,7 +8,7 @@ git-push - Update remote refs along with associated objects
8
9 SYNOPSIS
10 --------
11 -'git-push' [--all] [--tags] [--exec=<receive-pack>] [--repo=all] [-f | --force] [-v] [<repository> <refspec>...]
11 +'git-push' [--all] [--tags] [--exec=<git-receive-pack>] [--repo=all] [-f | --force] [-v] [<repository> <refspec>...]
12
13 DESCRIPTION
14 -----------
Documentation/git-send-pack.txt
+11 -4
@@ -8,7 +8,7 @@ git-send-pack - Push objects over git protocol to another reposiotory
8
9 SYNOPSIS
10 --------
11 -'git-send-pack' [--all] [--force] [--exec=<git-receive-pack>] [<host>:]<directory> [<ref>...]
11 +'git-send-pack' [--all] [--force] [--exec=<git-receive-pack>] [--verbose] [--thin] [<host>:]<directory> [<ref>...]
12
13 DESCRIPTION
14 -----------
@@ -21,23 +21,30 @@ updates it from the current repository, sending named refs.
21
22 OPTIONS
23 -------
24 ---exec=<git-receive-pack>::
24 +\--exec=<git-receive-pack>::
25 Path to the 'git-receive-pack' program on the remote
26 end. Sometimes useful when pushing to a remote
27 repository over ssh, and you do not have the program in
28 a directory on the default $PATH.
29
30 ---all::
30 +\--all::
31 Instead of explicitly specifying which refs to update,
32 update all refs that locally exist.
33
34 ---force::
34 +\--force::
35 Usually, the command refuses to update a remote ref that
36 is not an ancestor of the local ref used to overwrite it.
37 This flag disables the check. What this means is that
38 the remote repository can lose commits; use it with
39 care.
40
41 +\--verbose::
42 + Run verbosely.
43 +
44 +\--thin::
45 + Spend extra cycles to minimize the number of objects to be sent.
46 + Use it on slower connection.
47 +
48 <host>::
49 A remote host to house the repository. When this
50 part is specified, 'git-receive-pack' is invoked via
builtin-push.c
+1 -1
@@ -8,7 +8,7 @@
8
9 #define MAX_URI (16)
10
11 -static const char push_usage[] = "git-push [--all] [--tags] [-f | --force] <repository> [<refspec>...]";
11 +static const char push_usage[] = "git-push [--all] [--tags] [--exec=<git-receive-pack>] [--repo=all] [-f | --force] [-v] [<repository> <refspec>...]";
12
13 static int all, tags, force, thin = 1, verbose;
14 static const char *execute;
fetch-pack.c
+1 -1
@@ -12,7 +12,7 @@ static int verbose;
12 static int fetch_all;
13 static int depth;
14 static const char fetch_pack_usage[] =
15 -"git-fetch-pack [--all] [-q] [-v] [-k] [--thin] [--exec=upload-pack] [--depth=<n>] [host:]directory <refs>...";
15 +"git-fetch-pack [--all] [--quiet|-q] [--keep|-k] [--thin] [--exec=<git-upload-pack>] [--depth=<n>] [-v] [<host>:]<directory> [<refs>...]";
16 static const char *exec = "git-upload-pack";
17
18 #define COMPLETE (1U << 0)
send-pack.c
+2 -2
@@ -6,8 +6,8 @@
6 #include "exec_cmd.h"
7
8 static const char send_pack_usage[] =
9 -"git-send-pack [--all] [--exec=git-receive-pack] <remote> [<head>...]\n"
10 -" --all and explicit <head> specification are mutually exclusive.";
9 +"git-send-pack [--all] [--force] [--exec=<git-receive-pack>] [--verbose] [--thin] [<host>:]<directory> [<ref>...]\n"
10 +" --all and explicit <ref> specification are mutually exclusive.";
11 static const char *exec = "git-receive-pack";
12 static int verbose;
13 static int send_all;