Documentation: Split description of pretty formats of commit log

Split description of pretty formats into list of pretty options
(--pretty and --encoding) in new file Documentation/pretty-options.txt
and description of formats itself as a separate "PRETTY FORMATS"
section in pretty-formats.txt

While at it correct formatting a bit, to be better laid out in the
resulting manpages: git-rev-list(1), git-show(1), git-log(1) and
git-diff-tree(1).  Those manpages now include pretty options in the
same place as it was before, and description of formats just after
all options.

Inspired by the split into two filesdocumentation for merge strategies:
Documentation/merge-options.txt and Documentation/merge-strategies.txt

Signed-off-by: Jakub Narebski <jnareb@gmail.com>
Signed-off-by: Junio C Hamano <junkio@cox.net>

diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt
index 5d6e9dc751aef6e30582b399ae09f81c043e6de1..6e660e2d08c2d9d795b5ccfb91f755160cf58930 100644 (file)
--- a/Documentation/git-diff-tree.txt
+++ b/Documentation/git-diff-tree.txt
@@ -73,7 +73,7 @@ separated with a single space are given.
        This flag causes "git-diff-tree --stdin" to also show
        the commit message before the differences.
 
        This flag causes "git-diff-tree --stdin" to also show
        the commit message before the differences.
 

-include::pretty-formats.txt[]
+include::pretty-options.txt[]

 
 --no-commit-id::
        git-diff-tree outputs a line with the commit ID when
 
 --no-commit-id::
        git-diff-tree outputs a line with the commit ID when


@@ -104,6 +104,9 @@ include::pretty-formats.txt[]
        if the diff itself is empty.
 
 
        if the diff itself is empty.
 
 

+include::pretty-formats.txt[]
+
+

 Limiting Output
 ---------------
 If you're only interested in differences in a subset of files, for
 Limiting Output
 ---------------
 If you're only interested in differences in a subset of files, for

diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index dd06527a1e1b421ca867fa8bca0c36ccb75aeea6..0f353f6558e5843b1534f4cb9acd75746c313510 100644 (file)
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -25,7 +25,7 @@ This manual page describes only the most frequently used options.
 OPTIONS
 -------
 
 OPTIONS
 -------
 

-include::pretty-formats.txt[]
+include::pretty-options.txt[]

 
 -<n>::
        Limits the number of commits to show.
 
 -<n>::
        Limits the number of commits to show.


@@ -58,6 +58,9 @@ include::pretty-formats.txt[]
        Show only commits that affect the specified paths.
 
 
        Show only commits that affect the specified paths.
 
 

+include::pretty-formats.txt[]
+
+

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

diff --git a/Documentation/git-rev-list.txt b/Documentation/git-rev-list.txt
index 1b12b4f2a45e5650be067a3b05ce56c17a5422fc..ab90a22f11bbc92b4397135dac062cbfd7474bae 100644 (file)
--- a/Documentation/git-rev-list.txt
+++ b/Documentation/git-rev-list.txt
@@ -87,7 +87,7 @@ Using these options, gitlink:git-rev-list[1] will act similar to the
 more specialized family of commit log tools: gitlink:git-log[1],
 gitlink:git-show[1], and gitlink:git-whatchanged[1]
 
 more specialized family of commit log tools: gitlink:git-log[1],
 gitlink:git-show[1], and gitlink:git-whatchanged[1]
 

-include::pretty-formats.txt[]
+include::pretty-options.txt[]

 
 --relative-date::
 
 
 --relative-date::
 


@@ -367,6 +367,10 @@ These options are mostly targeted for packing of git repositories.
        Only useful with '--objects'; print the object IDs that are not
        in packs.
 
        Only useful with '--objects'; print the object IDs that are not
        in packs.
 

+
+include::pretty-formats.txt[]
+
+

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

diff --git a/Documentation/git-show.txt b/Documentation/git-show.txt
index 5a219ab5776c719190095ab4e9af95514a888ea3..34c5caf2d08324cc1595013cbdcd40d89d7a1968 100644 (file)
--- a/Documentation/git-show.txt
+++ b/Documentation/git-show.txt
@@ -38,6 +38,9 @@ OPTIONS
        For a more complete list of ways to spell object names, see
        "SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1].
 
        For a more complete list of ways to spell object names, see
        "SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1].
 

+include::pretty-options.txt[]
+
+

 include::pretty-formats.txt[]
 
 
 include::pretty-formats.txt[]
 
 

diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt
index d7ffc21ddf1e1241d8c485920e6ce56fe38c3f35..d922e8e86c173491fc492d3060bf92f4ee7b6c2d 100644 (file)
--- a/Documentation/pretty-formats.txt
+++ b/Documentation/pretty-formats.txt
@@ -1,31 +1,32 @@
---pretty[='<format>']::
-
-        Pretty-prints the details of a commit.  `--pretty`
-       without an explicit `=<format>` defaults to 'medium'.
-       If the commit is a merge, and if the pretty-format
-        is not 'oneline', 'email' or 'raw', an additional line is
-        inserted before the 'Author:' line.  This line begins with
-        "Merge: " and the sha1s of ancestral commits are printed,
-        separated by spaces.  Note that the listed commits may not
-        necessarily be the list of the *direct* parent commits if you
-        have limited your view of history: for example, if you are
-        only interested in changes related to a certain directory or
-        file.  Here are some additional details for each format:
-
-        * 'oneline'
+PRETTY FORMATS
+--------------
+
+If the commit is a merge, and if the pretty-format
+is not 'oneline', 'email' or 'raw', an additional line is
+inserted before the 'Author:' line.  This line begins with
+"Merge: " and the sha1s of ancestral commits are printed,
+separated by spaces.  Note that the listed commits may not
+necessarily be the list of the *direct* parent commits if you
+have limited your view of history: for example, if you are
+only interested in changes related to a certain directory or
+file.
+
+Here are some additional details for each format:
+
+* 'oneline'

 
          <sha1> <title line>
 +
 This is designed to be as compact as possible.
 
 
          <sha1> <title line>
 +
 This is designed to be as compact as possible.
 

-        * 'short'
+* 'short'

 
          commit <sha1>
          Author: <author>
 
              <title line>
 
 
          commit <sha1>
          Author: <author>
 
              <title line>
 

-        * 'medium'
+* 'medium'

 
          commit <sha1>
          Author: <author>
 
          commit <sha1>
          Author: <author>


@@ -35,7 +36,7 @@ This is designed to be as compact as possible.
 
              <full commit message>
 
 
              <full commit message>
 

-        * 'full'
+* 'full'

 
          commit <sha1>
          Author: <author>
 
          commit <sha1>
          Author: <author>


@@ -45,7 +46,7 @@ This is designed to be as compact as possible.
 
              <full commit message>
 
 
              <full commit message>
 

-        * 'fuller'
+* 'fuller'

 
          commit <sha1>
          Author: <author>
 
          commit <sha1>
          Author: <author>


@@ -57,18 +58,16 @@ This is designed to be as compact as possible.
 
               <full commit message>
 
 
               <full commit message>
 

-
-        * 'email'
+* 'email'

 
          From <sha1> <date>
          From: <author>
          Date: <date & time>
          Subject: [PATCH] <title line>
 
 
          From <sha1> <date>
          From: <author>
          Date: <date & time>
          Subject: [PATCH] <title line>
 

-         full commit message>
-
+         <full commit message>

 
 

-       * 'raw'
+* 'raw'

 +
 The 'raw' format shows the entire commit exactly as
 stored in the commit object.  Notably, the SHA1s are
 +
 The 'raw' format shows the entire commit exactly as
 stored in the commit object.  Notably, the SHA1s are


@@ -77,19 +76,22 @@ displayed in full, regardless of whether --abbrev or
 true parent commits, without taking grafts nor history
 simplification into account.
 
 true parent commits, without taking grafts nor history
 simplification into account.
 

-       * 'format:'
+* 'format:'

 +
 The 'format:' format allows you to specify which information
 you want to show. It works a little bit like printf format,
 with the notable exception that you get a newline with '%n'
 instead of '\n'.
 +
 The 'format:' format allows you to specify which information
 you want to show. It works a little bit like printf format,
 with the notable exception that you get a newline with '%n'
 instead of '\n'.

-
-E.g, 'format:"The author of %h was %an, %ar%nThe title was >>%s<<"'
++
+E.g, 'format:"The author of %h was %an, %ar%nThe title was >>%s<<%n"'

 would show something like this:
 would show something like this:

-
++
+-------

 The author of fe6e0ee was Junio C Hamano, 23 hours ago
 The title was >>t4119: test autocomputing -p<n> for traditional diff input.<<
 
 The author of fe6e0ee was Junio C Hamano, 23 hours ago
 The title was >>t4119: test autocomputing -p<n> for traditional diff input.<<
 

+--------
++

 The placeholders are:
 
 - '%H': commit hash
 The placeholders are:
 
 - '%H': commit hash


@@ -120,11 +122,3 @@ The placeholders are:
 - '%m': left, right or boundary mark
 - '%n': newline
 
 - '%m': left, right or boundary mark
 - '%n': newline
 

-
---encoding[=<encoding>]::
-       The commit objects record the encoding used for the log message
-       in their encoding header; this option can be used to tell the
-       command to re-code the commit log message in the encoding
-       preferred by the user.  For non plumbing commands this
-       defaults to UTF-8.
-

diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt
new file mode 100644 (file)
index 0000000..7d515be
--- /dev/null
+++ b/Documentation/pretty-options.txt
@@ -0,0 +1,14 @@
+--pretty[='<format>']::
+
+       Pretty print the contents of the commit logs in a given format,
+       where '<format>' can be one of 'oneline', 'short', 'medium',
+       'full', 'fuller', 'email', 'raw' and 'format:<string>'.
+       When left out the format default to 'medium'.
+
+--encoding[=<encoding>]::
+       The commit objects record the encoding used for the log message
+       in their encoding header; this option can be used to tell the
+       command to re-code the commit log message in the encoding
+       preferred by the user.  For non plumbing commands this
+       defaults to UTF-8.
+