kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

Add examples for git-log documentation and others. 

I don't think people really follow the links or think very abstractly at
all in the first place.

So I was thinking more of some explicit examples. I actually think every
command should have an example in the man-page, and hey, here's a patch to
start things off.

Of course, I'm not exactly "Mr Documentation", and I don't know that this
is the prettiest way to do this, but I checked that the resulting html and
man-page seems at least reasonable.

And hey, if the examples look like each other, that's just because I'm
also not "Mr Imagination".

Signed-off-by: Linus Torvalds <torvalds@osdl.org>
Signed-off-by: Junio C Hamano <junkio@cox.net>
maint
Linus Torvalds 2005-10-30 20:05:32 -08:00 committed by Junio C Hamano
parent 80e0c0ab91
commit bd66361195
3 changed files with 45 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Documentation/git-log.txt
View File

@ -30,6 +30,24 @@ OPTIONS
Show only commits between the named two commits. Show only commits between the named two commits.




Examples
--------
git log --no-merges::

Show the whole commit history, but skip any merges

git log v2.6.12.. include/scsi drivers/scsi::

Show all commits since version 'v2.6.12' that changed any file
in the include/scsi or drivers/scsi subdirectories

git log --since="2 weeks ago" -- gitk::

Show the changes during the last two weeks to the file 'gitk'.
The "--" is necessary to avoid confusion with the *branch* named
'gitk'


Author Author
------ ------
Written by Linus Torvalds <torvalds@osdl.org> Written by Linus Torvalds <torvalds@osdl.org>

14
Documentation/git-whatchanged.txt
View File

@ -51,6 +51,20 @@ OPTIONS
However, it is not very useful in general, although it However, it is not very useful in general, although it
*is* useful on a file-by-file basis. *is* useful on a file-by-file basis.


Examples
--------
git-whatchanged -p v2.6.12.. include/scsi drivers/scsi::

Show as patches the commits since version 'v2.6.12' that changed
any file in the include/scsi or drivers/scsi subdirectories

git-whatchanged --since="2 weeks ago" -- gitk::

Show the changes during the last two weeks to the file 'gitk'.
The "--" is necessary to avoid confusion with the *branch* named
'gitk'


Author Author
------ ------
Written by Linus Torvalds <torvalds@osdl.org> and Written by Linus Torvalds <torvalds@osdl.org> and

13
Documentation/gitk.txt
View File

@ -24,6 +24,19 @@ OPTIONS
Some argument not yet documented. Some argument not yet documented.




Examples
--------
gitk v2.6.12.. include/scsi drivers/scsi::

Show as the changes since version 'v2.6.12' that changed any
file in the include/scsi or drivers/scsi subdirectories

gitk --since="2 weeks ago" -- gitk::

Show the changes during the last two weeks to the file 'gitk'.
The "--" is necessary to avoid confusion with the *branch* named
'gitk'

Author Author
------ ------
Written by Paul Mackerras <paulus@samba.org> Written by Paul Mackerras <paulus@samba.org>