1
0
mirror of https://github.com/git/git.git synced 2024-09-29 07:22:56 +02:00

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>
This commit is contained in:
Jakub Narebski 2007-05-14 01:25:45 +02:00 committed by Junio C Hamano
parent 785cdea9be
commit 331b51d240
6 changed files with 58 additions and 37 deletions

@ -73,7 +73,7 @@ separated with a single space are given.
This flag causes "git-diff-tree --stdin" to also show This flag causes "git-diff-tree --stdin" to also show
the commit message before the differences. the commit message before the differences.
include::pretty-formats.txt[] include::pretty-options.txt[]
--no-commit-id:: --no-commit-id::
git-diff-tree outputs a line with the commit ID when 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 Limiting Output
--------------- ---------------
If you're only interested in differences in a subset of files, for If you're only interested in differences in a subset of files, for

@ -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>:: -<n>::
Limits the number of commits to show. 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 Examples
-------- --------
git log --no-merges:: git log --no-merges::

@ -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], more specialized family of commit log tools: gitlink:git-log[1],
gitlink:git-show[1], and gitlink:git-whatchanged[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 Only useful with '--objects'; print the object IDs that are not
in packs. in packs.
include::pretty-formats.txt[]
Author Author
------ ------
Written by Linus Torvalds <torvalds@osdl.org> Written by Linus Torvalds <torvalds@osdl.org>

@ -38,6 +38,9 @@ OPTIONS
For a more complete list of ways to spell object names, see For a more complete list of ways to spell object names, see
"SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1]. "SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1].
include::pretty-options.txt[]
include::pretty-formats.txt[] include::pretty-formats.txt[]

@ -1,31 +1,32 @@
--pretty[='<format>']:: PRETTY FORMATS
--------------
Pretty-prints the details of a commit. `--pretty` If the commit is a merge, and if the pretty-format
without an explicit `=<format>` defaults to 'medium'. is not 'oneline', 'email' or 'raw', an additional line is
If the commit is a merge, and if the pretty-format inserted before the 'Author:' line. This line begins with
is not 'oneline', 'email' or 'raw', an additional line is "Merge: " and the sha1s of ancestral commits are printed,
inserted before the 'Author:' line. This line begins with separated by spaces. Note that the listed commits may not
"Merge: " and the sha1s of ancestral commits are printed, necessarily be the list of the *direct* parent commits if you
separated by spaces. Note that the listed commits may not have limited your view of history: for example, if you are
necessarily be the list of the *direct* parent commits if you only interested in changes related to a certain directory or
have limited your view of history: for example, if you are file.
only interested in changes related to a certain directory or
file. Here are some additional details for each format:
* 'oneline' Here are some additional details for each format:
* 'oneline'
<sha1> <title line> <sha1> <title line>
+ +
This is designed to be as compact as possible. This is designed to be as compact as possible.
* 'short' * 'short'
commit <sha1> commit <sha1>
Author: <author> Author: <author>
<title line> <title line>
* 'medium' * 'medium'
commit <sha1> commit <sha1>
Author: <author> 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> commit <sha1>
Author: <author> 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> commit <sha1>
Author: <author> 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 <sha1> <date>
From: <author> From: <author>
Date: <date & time> Date: <date & time>
Subject: [PATCH] <title line> Subject: [PATCH] <title line>
full commit message> <full commit message>
* 'raw'
* 'raw'
+ +
The 'raw' format shows the entire commit exactly as The 'raw' format shows the entire commit exactly as
stored in the commit object. Notably, the SHA1s are 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 true parent commits, without taking grafts nor history
simplification into account. simplification into account.
* 'format:' * 'format:'
+ +
The 'format:' format allows you to specify which information The 'format:' format allows you to specify which information
you want to show. It works a little bit like printf format, you want to show. It works a little bit like printf format,
with the notable exception that you get a newline with '%n' with the notable exception that you get a newline with '%n'
instead of '\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 author of fe6e0ee was Junio C Hamano, 23 hours ago
The title was >>t4119: test autocomputing -p<n> for traditional diff input.<< The title was >>t4119: test autocomputing -p<n> for traditional diff input.<<
--------
+
The placeholders are: The placeholders are:
- '%H': commit hash - '%H': commit hash
@ -120,11 +122,3 @@ The placeholders are:
- '%m': left, right or boundary mark - '%m': left, right or boundary mark
- '%n': newline - '%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.

@ -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.