@matheusbsbs / matheus-bagliano / commits / 5cb545fa22
Fork 0

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>

Junio C Hamano committed Jan 17, 2007 at 13:03 UTC 5cb545fa22fa590617c872e47568279218788d4b
5 files changed +13 -1
Documentation/git-applypatch.txt
+3
@@ -12,6 +12,9 @@ SYNOPSIS
12
13 DESCRIPTION
14 -----------
15 +This is usually not what an end user wants to run directly. See
16 +gitlink:git-am[1] instead.
17 +
18 Takes three files <msg>, <patch>, and <info> prepared from an
19 e-mail message by 'git-mailinfo', and creates a commit. It is
20 usually not necessary to use this command directly.
Documentation/git-commit-tree.txt
+3
@@ -12,6 +12,9 @@ SYNOPSIS
12
13 DESCRIPTION
14 -----------
15 +This is usually not what an end user wants to run directly. See
16 +gitlink:git-commit[1] instead.
17 +
18 Creates a new commit object based on the provided tree object and
19 emits the new commit object id on stdout. If no parent is given then
20 it is considered to be an initial tree.
Documentation/git-fetch-pack.txt
+3
@@ -12,6 +12,9 @@ SYNOPSIS
12
13 DESCRIPTION
14 -----------
15 +Usually you would want to use gitlink:git-fetch[1] which is a
16 +higher level wrapper of this command instead.
17 +
18 Invokes 'git-upload-pack' on a potentially remote repository,
19 and asks it to send objects missing from this repository, to
20 update the named heads. The list of commits available locally
Documentation/git-mailinfo.txt
+1 -1
@@ -18,7 +18,7 @@ writes the commit log message in <msg> file, and the patches in
18 <patch> file. The author name, e-mail and e-mail subject are
19 written out to the standard output to be used by git-applypatch
20 to create a commit. It is usually not necessary to use this
21 -command directly.
21 +command directly. See gitlink:git-am[1] instead.
22
23
24 OPTIONS
Documentation/git-send-pack.txt
+3
@@ -12,6 +12,9 @@ SYNOPSIS
12
13 DESCRIPTION
14 -----------
15 +Usually you would want to use gitlink:git-push[1] which is a
16 +higher level wrapper of this command instead.
17 +
18 Invokes 'git-receive-pack' on a possibly remote repository, and
19 updates it from the current repository, sending named refs.
20