Documentation/git-log.txt: mark-up fix and minor rephasing

- typeset options, commands, and paths in monospace;
- typeset references to sections with emphasis;
- replace some double quotes with proper AsciiDoc quotes (e.g. ``foo'');
- use title case when referring to section headings.

Signed-off-by: Jason St. John <jstjohn@purdue.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index da1c2c6fd71deabb5b9147a79020e407d73b7368..1c2948d18dc023dbe581be2e9b22141b0e10e7d4 100644 (file)
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -15,9 +15,9 @@ DESCRIPTION
 -----------
 Shows the commit logs.
 
 -----------
 Shows the commit logs.
 

-The command takes options applicable to the 'git rev-list'
+The command takes options applicable to the `git rev-list`

 command to control what is shown and how, and options applicable to
 command to control what is shown and how, and options applicable to

-the 'git diff-*' commands to control how the changes
+the `git diff-*` commands to control how the changes

 each commit introduces are shown.
 
 
 each commit introduces are shown.
 
 


@@ -42,28 +42,27 @@ OPTIONS
 
 --use-mailmap::
        Use mailmap file to map author and committer names and email
 
 --use-mailmap::
        Use mailmap file to map author and committer names and email

-       to canonical real names and email addresses. See
+       addresses to canonical real names and email addresses. See

        linkgit:git-shortlog[1].
 
 --full-diff::
        linkgit:git-shortlog[1].
 
 --full-diff::

-       Without this flag, "git log -p <path>..." shows commits that
+       Without this flag, `git log -p <path>...` shows commits that

        touch the specified paths, and diffs about the same specified
        paths.  With this, the full diff is shown for commits that touch
        the specified paths; this means that "<path>..." limits only
        commits, and doesn't limit diff for those commits.
 +
 Note that this affects all diff-based output types, e.g. those
        touch the specified paths, and diffs about the same specified
        paths.  With this, the full diff is shown for commits that touch
        the specified paths; this means that "<path>..." limits only
        commits, and doesn't limit diff for those commits.
 +
 Note that this affects all diff-based output types, e.g. those

-produced by --stat etc.
+produced by `--stat`, etc.

 
 --log-size::
 
 --log-size::

-

        Include a line ``log size <number>'' in the output for each commit,
        where <number> is the length of that commit's message in bytes.
        Intended to speed up tools that read log messages from `git log`
        output by allowing them to allocate space in advance.
 
        Include a line ``log size <number>'' in the output for each commit,
        where <number> is the length of that commit's message in bytes.
        Intended to speed up tools that read log messages from `git log`
        output by allowing them to allocate space in advance.
 

--L <start>,<end>:<file>, -L :<regex>:<file>::
-
+-L <start>,<end>:<file>::
+-L :<regex>:<file>::

        Trace the evolution of the line range given by "<start>,<end>"
        (or the funcname regex <regex>) within the <file>.  You may
        not give any pathspec limiters.  This is currently limited to
        Trace the evolution of the line range given by "<start>,<end>"
        (or the funcname regex <regex>) within the <file>.  You may
        not give any pathspec limiters.  This is currently limited to


@@ -81,16 +80,16 @@ include::line-range-format.txt[]
        whole history leading to the current commit).  `origin..HEAD`
        specifies all the commits reachable from the current commit
        (i.e. `HEAD`), but not from `origin`. For a complete list of
        whole history leading to the current commit).  `origin..HEAD`
        specifies all the commits reachable from the current commit
        (i.e. `HEAD`), but not from `origin`. For a complete list of

-       ways to spell <revision range>, see the "Specifying Ranges"
+       ways to spell <revision range>, see the 'Specifying Ranges'

        section of linkgit:gitrevisions[7].
 
 [\--] <path>...::
        Show only commits that are enough to explain how the files
        section of linkgit:gitrevisions[7].
 
 [\--] <path>...::
        Show only commits that are enough to explain how the files

-       that match the specified paths came to be.  See "History
-       Simplification" below for details and other simplification
+       that match the specified paths came to be.  See 'History
+       Simplification' below for details and other simplification

        modes.
 +
        modes.
 +

-Paths may need to be prefixed with "\-- " to separate them from
+Paths may need to be prefixed with ``\-- '' to separate them from

 options or the revision range, when confusion arises.
 
 include::rev-list-options.txt[]
 options or the revision range, when confusion arises.
 
 include::rev-list-options.txt[]


@@ -114,12 +113,12 @@ EXAMPLES
 `git log v2.6.12.. include/scsi drivers/scsi`::
 
        Show all commits since version 'v2.6.12' that changed any file
 `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
+       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'.
 
 `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
+       The ``--'' is necessary to avoid confusion with the *branch* named

        'gitk'
 
 `git log --name-status release..test`::
        'gitk'
 
 `git log --name-status release..test`::


@@ -130,7 +129,7 @@ EXAMPLES
 
 `git log --follow builtin/rev-list.c`::
 
 
 `git log --follow builtin/rev-list.c`::
 

-       Shows the commits that changed builtin/rev-list.c, including
+       Shows the commits that changed `builtin/rev-list.c`, including

        those commits that occurred before the file was given its
        present name.
 
        those commits that occurred before the file was given its
        present name.
 


@@ -148,17 +147,18 @@ EXAMPLES
 `git log -p -m --first-parent`::
 
        Shows the history including change diffs, but only from the
 `git log -p -m --first-parent`::
 
        Shows the history including change diffs, but only from the

-       "main branch" perspective, skipping commits that come from merged
+       ``main branch'' perspective, skipping commits that come from merged

        branches, and showing full diffs of changes introduced by the merges.
        This makes sense only when following a strict policy of merging all
        topic branches when staying on a single integration branch.
 
 `git log -L '/int main/',/^}/:main.c`::
 
        branches, and showing full diffs of changes introduced by the merges.
        This makes sense only when following a strict policy of merging all
        topic branches when staying on a single integration branch.
 
 `git log -L '/int main/',/^}/:main.c`::
 

-       Shows how the function `main()` in the file 'main.c' evolved
+       Shows how the function `main()` in the file `main.c` evolved

        over time.
 
 `git log -3`::
        over time.
 
 `git log -3`::

+

        Limits the number of commits to show to 3.
 
 DISCUSSION
        Limits the number of commits to show to 3.
 
 DISCUSSION


@@ -173,12 +173,12 @@ See linkgit:git-config[1] for core variables and linkgit:git-diff[1]
 for settings related to diff generation.
 
 format.pretty::
 for settings related to diff generation.
 
 format.pretty::

-       Default for the `--format` option.  (See "PRETTY FORMATS" above.)
-       Defaults to "medium".
+       Default for the `--format` option.  (See 'Pretty Formats' above.)
+       Defaults to `medium`.

 
 i18n.logOutputEncoding::
 
 i18n.logOutputEncoding::

-       Encoding to use when displaying logs.  (See "Discussion", above.)
-       Defaults to the value of `i18n.commitEncoding` if set, UTF-8
+       Encoding to use when displaying logs.  (See 'Discussion' above.)
+       Defaults to the value of `i18n.commitEncoding` if set, and UTF-8

        otherwise.
 
 log.date::
        otherwise.
 
 log.date::


@@ -187,7 +187,7 @@ log.date::
        dates like `Sat May 8 19:35:34 2010 -0500`.
 
 log.showroot::
        dates like `Sat May 8 19:35:34 2010 -0500`.
 
 log.showroot::

-       If `false`, 'git log' and related commands will not treat the
+       If `false`, `git log` and related commands will not treat the

        initial commit as a big creation event.  Any root commits in
        `git log -p` output would be shown without a diff attached.
        The default is `true`.
        initial commit as a big creation event.  Any root commits in
        `git log -p` output would be shown without a diff attached.
        The default is `true`.


@@ -198,7 +198,7 @@ mailmap.*::
 notes.displayRef::
        Which refs, in addition to the default set by `core.notesRef`
        or 'GIT_NOTES_REF', to read notes from when showing commit
 notes.displayRef::
        Which refs, in addition to the default set by `core.notesRef`
        or 'GIT_NOTES_REF', to read notes from when showing commit

-       messages with the 'log' family of commands.  See
+       messages with the `log` family of commands.  See

        linkgit:git-notes[1].
 +
 May be an unabbreviated ref name or a glob and may be specified
        linkgit:git-notes[1].
 +
 May be an unabbreviated ref name or a glob and may be specified