mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation: suggest corresponding Porcelain-level in plumbing docs.

Browse Source 
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>
This commit is contained in:
Junio C Hamano
2007-01-17 13:03:29 -08:00
parent 475abf1b63
commit 5cb545fa22
5 changed files with 13 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
Documentation/git-applypatch.txt
View File

@ -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 Takes three files <msg>, <patch>, and <info> prepared from an
e-mail message by 'git-mailinfo', and creates a commit. It is e-mail message by 'git-mailinfo', and creates a commit. It is
usually not necessary to use this command directly. usually not necessary to use this command directly.

3
Documentation/git-commit-tree.txt
View File

@ -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 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 emits the new commit object id on stdout. If no parent is given then
it is considered to be an initial tree. it is considered to be an initial tree.

3
Documentation/git-fetch-pack.txt
View File

@ -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, Invokes 'git-upload-pack' on a potentially remote repository,
and asks it to send objects missing from this repository, to and asks it to send objects missing from this repository, to
update the named heads. The list of commits available locally update the named heads. The list of commits available locally

2
Documentation/git-mailinfo.txt
View File

@ -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 <patch> file. The author name, e-mail and e-mail subject are
written out to the standard output to be used by git-applypatch written out to the standard output to be used by git-applypatch
to create a commit. It is usually not necessary to use this to create a commit. It is usually not necessary to use this
command directly. command directly. See gitlink:git-am[1] instead.
OPTIONS OPTIONS

3
Documentation/git-send-pack.txt
View File

@ -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 Invokes 'git-receive-pack' on a possibly remote repository, and
updates it from the current repository, sending named refs. updates it from the current repository, sending named refs.