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>

diff --git a/Documentation/git-applypatch.txt b/Documentation/git-applypatch.txt
index 2b1ff1454b48a6f45897a330ce4273b29f800b21..451434a757eab84d502a9529c571bc647e8b76d7 100644 (file)
--- a/Documentation/git-applypatch.txt
+++ b/Documentation/git-applypatch.txt
@@ -12,6 +12,9 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
 
 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.
 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 77ba96ed8a4820354ef6d2ff4265660385289f3d..f5d8050c9e20b66455454b35a5431fe91562a2de 100644 (file)
--- a/Documentation/git-commit-tree.txt
+++ b/Documentation/git-commit-tree.txt
@@ -12,6 +12,9 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
 
 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.
 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 3e6cd880b0e6aeda3056da1361ffcae52b89b531..90ef127d12471e2e77f0a1d2674dfd6f0b562134 100644 (file)
--- a/Documentation/git-fetch-pack.txt
+++ b/Documentation/git-fetch-pack.txt
@@ -12,6 +12,9 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
 
 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
 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 5088bbea84c0e6b681641b78b816755fa12f6b6d..1ff6e7d6c239cffa8386307b645b4934fb8b2c2a 100644 (file)
--- 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
 <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
 
 
 OPTIONS

diff --git a/Documentation/git-send-pack.txt b/Documentation/git-send-pack.txt
index 5376f685486c6f19cbe6ea3b8391cac5b50c593b..88f4e394ef244030274c37d75a3bb76f376c6470 100644 (file)
--- a/Documentation/git-send-pack.txt
+++ b/Documentation/git-send-pack.txt
@@ -12,6 +12,9 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
 
 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.
 
 Invokes 'git-receive-pack' on a possibly remote repository, and
 updates it from the current repository, sending named refs.