development/git
development/git
1
0
Fork 0
mirror of https://github.com/git/git synced 2024-07-17 02:57:48 +00:00
Code Issues Actions 9 Packages Projects Releases Wiki Activity

Documentation updates.

Browse source 
Linus brought up that documentation for many commands have
incorrect attribution.  I started counting lines again, but
ended up adding a handful of missing manual pages.

Signed-off-by: Junio C Hamano <junkio@cox.net>
This commit is contained in:
Junio C Hamano 2005-08-14 17:24:36 -07:00
parent 068eac91ce
commit 3f971fc425
13 changed files with 231 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
Documentation/Makefile
View file

@ -53,3 +53,4 @@ clean:
%.xml : %.txt
asciidoc -b docbook -d manpage $<

4
Documentation/git-apply-patch-script.txt
View file

@ -1,6 +1,6 @@
git-apply-patch-script(1)
=========================
v0.1, May 2005
v0.99.4, May 2005
NAME
----
@ -20,7 +20,7 @@ family of commands report to the current work tree.
Author
------
Written by Linus Torvalds <torvalds@osdl.org>
Written by Junio C Hamano <junkio@cox.net>
Documentation
--------------

17
Documentation/git-commit-script.txt
View file

@ -8,7 +8,7 @@ git-commit-script - Record your changes
SYNOPSIS
--------
'git commit' [-a] [(-c | -C) <commit> | -F <file> | -m <msg>] <file>...
'git commit' [-a] [-s] [-v] [(-c | -C) <commit> | -F <file> | -m <msg>] <file>...
DESCRIPTION
-----------
@ -36,13 +36,26 @@ OPTIONS
-m <msg>::
Use the given <msg> as the commit message.
-s::
Add Signed-off-by line at the end of the commit message.
-v::
Look for suspicious lines the commit introduces, and
abort committing if there is one. The definition of
'suspicious lines' is currently the lines that has
trailing whitespaces, and the lines whose indentation
has a SP character immediately followed by a TAB
character.
<file>...::
Update specified paths in the index file.
Author
------
Written by Linus Torvalds <torvalds@osdl.org>
Written by Linus Torvalds <torvalds@osdl.org> and
Junio C Hamano <junkio@cox.net>
GIT
---

5
Documentation/git-fetch-script.txt
View file

@ -1,6 +1,6 @@
git-fetch-script(1)
===================
v0.1, July 2005
v0.99.4, Aug 2005
NAME
----
@ -36,7 +36,8 @@ include::pull-fetch-param.txt[]
Author
------
Written by Linus Torvalds <torvalds@osdl.org> and Junio C Hamano <junkio@cox.net>
Written by Linus Torvalds <torvalds@osdl.org> and
Junio C Hamano <junkio@cox.net>
Documentation
--------------

45
Documentation/git-log-script.txt Normal file
View file

@ -0,0 +1,45 @@
git-log-script(1)
=================
v0.99.4, Aug 2005
NAME
----
git-log-script - Show commit logs
SYNOPSIS
--------
'git log' <option>...
DESCRIPTION
-----------
Shows the commit logs. This command internally invokes
'git-rev-list', and the command line options are passed to that
command.
This manual page describes only the most frequently used options.
OPTIONS
-------
--pretty=<format>:
Controls the way the commit log is formatted.
--max-count=<n>::
Limits the number of commits to show.
<since>..<until>::
Show only commits between the named two commits.
Author
------
Written by Linus Torvalds <torvalds@osdl.org>
Documentation
--------------
Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
GIT
---
Part of the link:git.html[git] suite

5
Documentation/git-merge-one-file-script.txt
View file

@ -1,6 +1,6 @@
git-merge-one-file-script(1)
============================
v0.1, May 2005
v0.99.4, Aug 2005
NAME
----
@ -18,7 +18,8 @@ to resolve a merge after the trivial merge done with "git-read-tree -m".
Author
------
Written by Linus Torvalds <torvalds@osdl.org>
Written by Linus Torvalds <torvalds@osdl.org>,
Junio C Hamano <junkio@cox.net> and Petr Baudis <pasky@suse.cz>.
Documentation
--------------

5
Documentation/git-pull-script.txt
View file

@ -1,6 +1,6 @@
git-pull-script(1)
==================
v0.1, May 2005
v0.99.4, Aug 2005
NAME
----
@ -25,7 +25,8 @@ include::pull-fetch-param.txt[]
Author
------
Written by Linus Torvalds <torvalds@osdl.org> and Junio C Hamano <junkio@cox.net>
Written by Linus Torvalds <torvalds@osdl.org>
and Junio C Hamano <junkio@cox.net>
Documentation
--------------

5
Documentation/git-resolve-script.txt
View file

@ -1,6 +1,6 @@
git-resolve-script(1)
=====================
v0.1, May 2005
v0.99.4, Aug 2005
NAME
----
@ -18,7 +18,8 @@ This script is used by Linus to merge two trees.
Author
------
Written by Linus Torvalds <torvalds@osdl.org>
Written by Linus Torvalds <torvalds@osdl.org> and
Dan Holmsand <holmsand@gmail.com>.
Documentation
--------------

31
Documentation/git-shortlog.txt Normal file
View file

@ -0,0 +1,31 @@
git-shortlog(1)
===============
v0.99.4, Aug 2005
NAME
----
git-shortlog - Summarize 'git log' output.
SYNOPSIS
--------
'git log --pretty=short | git shortlog'
DESCRIPTION
-----------
Summarizes 'git log' output in a format suitable for inclusion
in release announcements.
Author
------
Written by Jeff Garzik <jgarzik@pobox.com>
Documentation
--------------
Documentation by Junio C Hamano.
GIT
---
Part of the link:git.html[git] suite

46
Documentation/git-status-script.txt Normal file
View file

@ -0,0 +1,46 @@
git-status-script(1)
====================
v0.99.4, Aug 2005
NAME
----
git-status-script - Show working tree status.
SYNOPSIS
--------
'git status'
DESCRIPTION
-----------
Examines paths in the working tree that has changes unrecorded
to the index file, and changes between the index file and the
current HEAD commit. The former paths are what you _could_
commit by running 'git-update-cache' before running 'git
commit', and the latter paths are what you _would_ commit by
running 'git commit'.
If there is no path that is different between the index file and
the current HEAD commit, the command exits with non-zero
status.
OUTPUT
------
The output from this command is designed to be used as a commit
template comments, and all the output lines are prefixed with '#'.
Author
------
Written by Linus Torvalds <torvalds@osdl.org> and
Junio C Hamano <junkio@cox.net>.
Documentation
--------------
Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
GIT
---
Part of the link:git.html[git] suite

5
Documentation/git-tag-script.txt
View file

@ -1,6 +1,6 @@
git-tag-script(1)
=================
v0.1, May 2005
v0.99.4, Aug 2005
NAME
----
@ -27,7 +27,8 @@ A GnuPG signed tag object will be created when "-s" is used.
Author
------
Written by Linus Torvalds <torvalds@osdl.org>
Written by Linus Torvalds <torvalds@osdl.org>,
Junio C Hamano <junkio@cox.net> and Chris Wright <chrisw@osdl.org>.
Documentation
--------------

61
Documentation/git-whatchanged.txt Normal file
View file

@ -0,0 +1,61 @@
git-whatchanged(1)
==================
v0.99.4, Aug 2005
NAME
----
git-whatchanged - Show logs with difference each commit introduces.
SYNOPSIS
--------
'git whatchanged' <option>...
DESCRIPTION
-----------
Shows commit logs and diff output each commit introduces. The
command internally invokes 'git-rev-list' piped to
'git-diff-tree', and takes command line options for both of
these commands.
This manual page describes only the most frequently used options.
OPTIONS
-------
-p::
Show textual diffs, instead of the git internal diff
output format that is useful only to tell the changed
paths and their nature of changes.
--max-count=<n>::
Limit output to <n> commits.
<since>..<until>::
Limit output to between the two named commits (bottom
exclusive, top inclusive).
-r::
Show git internal diff output, but for the whole tree,
not just the top level.
--pretty=<format>::
Controls the output format for the commit logs.
<format> can be one of 'raw', 'medium', 'short', 'full',
and 'oneline'.
Author
------
Written by Linus Torvalds <torvalds@osdl.org> and
Junio C Hamano <junkio@cox.net>
Documentation
--------------
Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
GIT
---
Part of the link:git.html[git] suite

18
Documentation/git.txt
View file

@ -1,6 +1,6 @@
git(7)
======
May 2005
v0.99.4, Aug 2005
NAME
----
@ -165,8 +165,20 @@ link:git-update-server-info.html[git-update-server-info]::
clients discover references and packs on it.
Porcelainish Commands
---------------------
Porcelain-ish Commands
----------------------
link:git-whatchanged.html[git-whatchanged]::
Shows commit logs and differences they introduce.
link:git-log-script.html[git-log-script]::
Shows commit logs.
link:git-shortlog.html[git-shortlog]::
Summarizes 'git log' output.
link:git-status-script.html[git-status-script]::
Shows the working tree status.
link:git-fetch-script.html[git-fetch-script]::
Download from a remote repository via various protocols.