Skip to content

Commit 5cb545f

Browse files
author
Junio C Hamano
committed
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>
1 parent 475abf1 commit 5cb545f

File tree

5 files changed

+13
-1
lines changed

5 files changed

+13
-1
lines changed

Documentation/git-applypatch.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ SYNOPSIS
1212

1313
DESCRIPTION
1414
-----------
15+
This is usually not what an end user wants to run directly. See
16+
gitlink:git-am[1] instead.
17+
1518
Takes three files <msg>, <patch>, and <info> prepared from an
1619
e-mail message by 'git-mailinfo', and creates a commit. It is
1720
usually not necessary to use this command directly.

Documentation/git-commit-tree.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ SYNOPSIS
1212

1313
DESCRIPTION
1414
-----------
15+
This is usually not what an end user wants to run directly. See
16+
gitlink:git-commit[1] instead.
17+
1518
Creates a new commit object based on the provided tree object and
1619
emits the new commit object id on stdout. If no parent is given then
1720
it is considered to be an initial tree.

Documentation/git-fetch-pack.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ SYNOPSIS
1212

1313
DESCRIPTION
1414
-----------
15+
Usually you would want to use gitlink:git-fetch[1] which is a
16+
higher level wrapper of this command instead.
17+
1518
Invokes 'git-upload-pack' on a potentially remote repository,
1619
and asks it to send objects missing from this repository, to
1720
update the named heads. The list of commits available locally

Documentation/git-mailinfo.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ writes the commit log message in <msg> file, and the patches in
1818
<patch> file. The author name, e-mail and e-mail subject are
1919
written out to the standard output to be used by git-applypatch
2020
to create a commit. It is usually not necessary to use this
21-
command directly.
21+
command directly. See gitlink:git-am[1] instead.
2222

2323

2424
OPTIONS

Documentation/git-send-pack.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ SYNOPSIS
1212

1313
DESCRIPTION
1414
-----------
15+
Usually you would want to use gitlink:git-push[1] which is a
16+
higher level wrapper of this command instead.
17+
1518
Invokes 'git-receive-pack' on a possibly remote repository, and
1619
updates it from the current repository, sending named refs.
1720

0 commit comments

Comments
 (0)