diff options
| author | Junio C Hamano <junkio@cox.net> | 2007-01-18 00:03:29 +0300 |
|---|---|---|
| committer | Junio C Hamano <junkio@cox.net> | 2007-01-18 00:03:29 +0300 |
| commit | 5cb545fa22fa590617c872e47568279218788d4b (patch) | |
| tree | 70366cf8de4dc6504bac23b5800c0fb3758df52c | |
| parent | 475abf1b6386c7583d0c852767c8b1e439c1de37 (diff) | |
Documentation: suggest corresponding Porcelain-level in plumbing docs.
Instead of keeping the confused end user reading low-level
documentation, suggest the higher level commands that implement
what the user may want to do using them upfront.
Signed-off-by: Junio C Hamano <junkio@cox.net>
| -rw-r--r-- | Documentation/git-applypatch.txt | 3 | ||||
| -rw-r--r-- | Documentation/git-commit-tree.txt | 3 | ||||
| -rw-r--r-- | Documentation/git-fetch-pack.txt | 3 | ||||
| -rw-r--r-- | Documentation/git-mailinfo.txt | 2 | ||||
| -rw-r--r-- | Documentation/git-send-pack.txt | 3 |
5 files changed, 13 insertions, 1 deletions
diff --git a/Documentation/git-applypatch.txt b/Documentation/git-applypatch.txt index 2b1ff1454b..451434a757 100644 --- a/Documentation/git-applypatch.txt +++ b/Documentation/git-applypatch.txt @@ -12,6 +12,9 @@ SYNOPSIS DESCRIPTION ----------- +This is usually not what an end user wants to run directly. See +gitlink:git-am[1] instead. + Takes three files <msg>, <patch>, and <info> prepared from an e-mail message by 'git-mailinfo', and creates a commit. It is usually not necessary to use this command directly. diff --git a/Documentation/git-commit-tree.txt b/Documentation/git-commit-tree.txt index 77ba96ed8a..f5d8050c9e 100644 --- a/Documentation/git-commit-tree.txt +++ b/Documentation/git-commit-tree.txt @@ -12,6 +12,9 @@ SYNOPSIS DESCRIPTION ----------- +This is usually not what an end user wants to run directly. See +gitlink:git-commit[1] instead. + Creates a new commit object based on the provided tree object and emits the new commit object id on stdout. If no parent is given then it is considered to be an initial tree. diff --git a/Documentation/git-fetch-pack.txt b/Documentation/git-fetch-pack.txt index 3e6cd880b0..90ef127d12 100644 --- a/Documentation/git-fetch-pack.txt +++ b/Documentation/git-fetch-pack.txt @@ -12,6 +12,9 @@ SYNOPSIS DESCRIPTION ----------- +Usually you would want to use gitlink:git-fetch[1] which is a +higher level wrapper of this command instead. + Invokes 'git-upload-pack' on a potentially remote repository, and asks it to send objects missing from this repository, to update the named heads. The list of commits available locally diff --git a/Documentation/git-mailinfo.txt b/Documentation/git-mailinfo.txt index 5088bbea84..1ff6e7d6c2 100644 --- a/Documentation/git-mailinfo.txt +++ b/Documentation/git-mailinfo.txt @@ -18,7 +18,7 @@ writes the commit log message in <msg> file, and the patches in <patch> file. The author name, e-mail and e-mail subject are written out to the standard output to be used by git-applypatch to create a commit. It is usually not necessary to use this -command directly. +command directly. See gitlink:git-am[1] instead. OPTIONS diff --git a/Documentation/git-send-pack.txt b/Documentation/git-send-pack.txt index 5376f68548..88f4e394ef 100644 --- a/Documentation/git-send-pack.txt +++ b/Documentation/git-send-pack.txt @@ -12,6 +12,9 @@ SYNOPSIS DESCRIPTION ----------- +Usually you would want to use gitlink:git-push[1] which is a +higher level wrapper of this command instead. + Invokes 'git-receive-pack' on a possibly remote repository, and updates it from the current repository, sending named refs. |