Update documentation of fetch-pack, push and send-pack
authorUwe Kleine-König <zeisberg@informatik.uni-freiburg.de>
Fri, 19 Jan 2007 12:43:00 +0000 (13:43 +0100)
committerJunio C Hamano <junkio@cox.net>
Sat, 20 Jan 2007 01:54:32 +0000 (17:54 -0800)
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>
Documentation/git-fetch-pack.txt
Documentation/git-push.txt
Documentation/git-send-pack.txt
builtin-push.c
fetch-pack.c
send-pack.c

index 90ef127d12471e2e77f0a1d2674dfd6f0b562134..bd8ebacd7d4bd63097c22c6dcd8620a98d332a4e 100644 (file)
@@ -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' [--all] [--quiet|-q] [--keep|-k] [--thin] [--exec=<git-upload-pack>] [--depth=<n>] [-v] [<host>:]<directory> [<refs>...]
 
 DESCRIPTION
 -----------
@@ -28,17 +28,24 @@ have a common ancestor commit.
 
 OPTIONS
 -------
--q::
+\--all::
+       Fetch all remote refs.
+
+\--quiet, \-q::
        Pass '-q' flag to 'git-unpack-objects'; this makes the
        cloning process less verbose.
 
--k::
+\--keep, \-k::
        Do not invoke 'git-unpack-objects' on received data, but
        create a single packfile out of it instead, and store it
        in the object database. If provided twice then the pack is
        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
        remote side, if is not found on your $PATH.
        Installations of sshd ignores the user's environment
@@ -50,6 +57,12 @@ OPTIONS
        shells by having a lean .bashrc file (they set most of
        the things up in .bash_profile).
 
+\--depth=<n>::
+       Limit fetching to ancestor-chains not longer than n.
+
+\-v::
+       Run verbosely.
+
 <host>::
        A remote host that houses the repository.  When this
        part is specified, 'git-upload-pack' is invoked via
index 3e8dbcf93a8d39dc397ba0468f9005fad60ecd44..7a2e503a4e6739568b684d64be380819fde4ed02 100644 (file)
@@ -8,7 +8,7 @@ git-push - Update remote refs along with associated objects
 
 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
 -----------
index eea8fe8af3bfd90b4e4c890c748268a8e58a6bbb..dee43a997c3fbb36890e67d80681248652476899 100644 (file)
@@ -8,7 +8,7 @@ git-send-pack - Push objects over git protocol to another reposiotory
 
 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
 -----------
@@ -21,23 +21,30 @@ updates it from the current repository, sending named refs.
 
 OPTIONS
 -------
---exec=<git-receive-pack>::
+\--exec=<git-receive-pack>::
        Path to the 'git-receive-pack' program on the remote
        end.  Sometimes useful when pushing to a remote
        repository over ssh, and you do not have the program in
        a directory on the default $PATH.
 
---all::
+\--all::
        Instead of explicitly specifying which refs to update,
        update all refs that locally exist.
 
---force::
+\--force::
        Usually, the command refuses to update a remote ref that
        is not an ancestor of the local ref used to overwrite it.
        This flag disables the check.  What this means is that
        the remote repository can lose commits; use it with
        care.
 
+\--verbose::
+       Run verbosely.
+
+\--thin::
+       Spend extra cycles to minimize the number of objects to be sent.
+       Use it on slower connection.
+
 <host>::
        A remote host to house the repository.  When this
        part is specified, 'git-receive-pack' is invoked via
index 7a3d2bb06416219a41cf6a0757cf3d03a56ef0da..ba7981f5bf5c165aefe5c90d5fcb9baa76baebdd 100644 (file)
@@ -8,7 +8,7 @@
 
 #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 const char *execute;
index 1530a947947b68d879e01bb9161654e135716a3d..726140a1a57a00cdd000dabad2a9a3ef37acd79a 100644 (file)
@@ -12,7 +12,7 @@ static int verbose;
 static int fetch_all;
 static int depth;
 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";
 
 #define COMPLETE       (1U << 0)
index 6756264b293e18467a59dc0222ee82e586cda76f..ec2c1089b289fc93159523d6f81c78c3c6f2be65 100644 (file)
@@ -6,8 +6,8 @@
 #include "exec_cmd.h"
 
 static const char send_pack_usage[] =
-"git-send-pack [--all] [--exec=git-receive-pack] <remote> [<head>...]\n"
-"  --all and explicit <head> specification are mutually exclusive.";
+"git-send-pack [--all] [--force] [--exec=<git-receive-pack>] [--verbose] [--thin] [<host>:]<directory> [<ref>...]\n"
+"  --all and explicit <ref> specification are mutually exclusive.";
 static const char *exec = "git-receive-pack";
 static int verbose;
 static int send_all;