From bd66361195c5503261a2d1eef6aa685deb058ffb Mon Sep 17 00:00:00 2001 From: Linus Torvalds Date: Sun, 30 Oct 2005 20:05:32 -0800 Subject: [PATCH] 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 Signed-off-by: Junio C Hamano --- Documentation/git-log.txt | 18 ++++++++++++++++++ Documentation/git-whatchanged.txt | 14 ++++++++++++++ Documentation/gitk.txt | 13 +++++++++++++ 3 files changed, 45 insertions(+) diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt index 13a3998302..9cac0886cf 100644 --- a/Documentation/git-log.txt +++ b/Documentation/git-log.txt @@ -30,6 +30,24 @@ OPTIONS 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 diff --git a/Documentation/git-whatchanged.txt b/Documentation/git-whatchanged.txt index e6f57d9bc1..6c150b0264 100644 --- 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. +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 and diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt index e5ef6d6f47..eb126d7a4b 100644 --- a/Documentation/gitk.txt +++ b/Documentation/gitk.txt @@ -24,6 +24,19 @@ OPTIONS 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