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>

diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index 13a3998302a2817bb36d7555f171311ce19a3d0c..9cac0886cf3b03fd5c4454b1a0ea1920dd0edaf8 100644 (file)
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -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
 ------
 Written by Linus Torvalds <torvalds@osdl.org>
 Author
 ------
 Written by Linus Torvalds <torvalds@osdl.org>

diff --git a/Documentation/git-whatchanged.txt b/Documentation/git-whatchanged.txt
index e6f57d9bc1a318ed332c3b46a10d6de824a37a07..6c150b0264ac5caf326ad5b0d2da225a241b77f2 100644 (file)
--- a/Documentation/git-whatchanged.txt
+++ b/Documentation/git-whatchanged.txt
@@ -51,6 +51,20 @@ OPTIONS
        However, it is not very useful in general, although it
        *is* useful on a file-by-file basis.
 
        However, it is not very useful in general, although it
        *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
 ------
 Written by Linus Torvalds <torvalds@osdl.org> and
 Author
 ------
 Written by Linus Torvalds <torvalds@osdl.org> and

diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt
index e5ef6d6f47681b86b9cbae3c5b9443cf873d2767..eb126d7a4b02c979709dff716eb9c9a64c169952 100644 (file)
--- a/Documentation/gitk.txt
+++ b/Documentation/gitk.txt
@@ -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
 ------
 Written by Paul Mackerras <paulus@samba.org>
 Author
 ------
 Written by Paul Mackerras <paulus@samba.org>