Skip to content

Commit 18bd882

Browse files
Uwe Kleine-KönigJunio C Hamano
Uwe Kleine-König
authored and
Junio C Hamano
committed
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>
1 parent 89bf207 commit 18bd882

File tree

6 files changed

+33
-13
lines changed

6 files changed

+33
-13
lines changed

‎Documentation/git-fetch-pack.txt‎

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ git-fetch-pack - Receive missing objects from another repository
88

99
SYNOPSIS
1010
--------
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>...]
1212

1313
DESCRIPTION
1414
-----------
@@ -28,17 +28,24 @@ have a common ancestor commit.
2828

2929
OPTIONS
3030
-------
31-
-q::
31+
\--all::
32+
Fetch all remote refs.
33+
34+
\--quiet, \-q::
3235
Pass '-q' flag to 'git-unpack-objects'; this makes the
3336
cloning process less verbose.
3437

35-
-k::
38+
\--keep, \-k::
3639
Do not invoke 'git-unpack-objects' on received data, but
3740
create a single packfile out of it instead, and store it
3841
in the object database. If provided twice then the pack is
3942
locked against repacking.
4043

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>::
4249
Use this to specify the path to 'git-upload-pack' on the
4350
remote side, if is not found on your $PATH.
4451
Installations of sshd ignores the user's environment
@@ -50,6 +57,12 @@ OPTIONS
5057
shells by having a lean .bashrc file (they set most of
5158
the things up in .bash_profile).
5259

60+
\--depth=<n>::
61+
Limit fetching to ancestor-chains not longer than n.
62+
63+
\-v::
64+
Run verbosely.
65+
5366
<host>::
5467
A remote host that houses the repository. When this
5568
part is specified, 'git-upload-pack' is invoked via

‎Documentation/git-push.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ git-push - Update remote refs along with associated objects
88

99
SYNOPSIS
1010
--------
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>...]
1212

1313
DESCRIPTION
1414
-----------

‎Documentation/git-send-pack.txt‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ git-send-pack - Push objects over git protocol to another reposiotory
88

99
SYNOPSIS
1010
--------
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>...]
1212

1313
DESCRIPTION
1414
-----------
@@ -21,23 +21,30 @@ updates it from the current repository, sending named refs.
2121

2222
OPTIONS
2323
-------
24-
--exec=<git-receive-pack>::
24+
\--exec=<git-receive-pack>::
2525
Path to the 'git-receive-pack' program on the remote
2626
end. Sometimes useful when pushing to a remote
2727
repository over ssh, and you do not have the program in
2828
a directory on the default $PATH.
2929

30-
--all::
30+
\--all::
3131
Instead of explicitly specifying which refs to update,
3232
update all refs that locally exist.
3333

34-
--force::
34+
\--force::
3535
Usually, the command refuses to update a remote ref that
3636
is not an ancestor of the local ref used to overwrite it.
3737
This flag disables the check. What this means is that
3838
the remote repository can lose commits; use it with
3939
care.
4040

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+
4148
<host>::
4249
A remote host to house the repository. When this
4350
part is specified, 'git-receive-pack' is invoked via

‎builtin-push.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
#define MAX_URI (16)
1010

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>...]";
1212

1313
static int all, tags, force, thin = 1, verbose;
1414
static const char *execute;

‎fetch-pack.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ static int verbose;
1212
static int fetch_all;
1313
static int depth;
1414
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>...]";
1616
static const char *exec = "git-upload-pack";
1717

1818
#define COMPLETE (1U << 0)

‎send-pack.c‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
#include "exec_cmd.h"
77

88
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.";
1111
static const char *exec = "git-receive-pack";
1212
static int verbose;
1313
static int send_all;

0 commit comments

Comments
 (0)