Documentation: begin discussion of git-remote in user manual
[git/jrn.git] / Documentation / pretty-formats.txt
blobfb0b0b95829e0fc1aa98019554ce12e9b45d1f63
1 --pretty[='<format>']::
3         Pretty-prints the details of a commit.  `--pretty`
4         without an explicit `=<format>` defaults to 'medium'.
5         If the commit is a merge, and if the pretty-format
6         is not 'oneline', 'email' or 'raw', an additional line is
7         inserted before the 'Author:' line.  This line begins with
8         "Merge: " and the sha1s of ancestral commits are printed,
9         separated by spaces.  Note that the listed commits may not
10         necessarily be the list of the *direct* parent commits if you
11         have limited your view of history: for example, if you are
12         only interested in changes related to a certain directory or
13         file.  Here are some additional details for each format:
15         * 'oneline'
17           <sha1> <title line>
19 This is designed to be as compact as possible.
21         * 'short'
23           commit <sha1>
24           Author: <author>
26               <title line>
28         * 'medium'
30           commit <sha1>
31           Author: <author>
32           Date: <date>
34               <title line>
36               <full commit message>
38         * 'full'
40           commit <sha1>
41           Author: <author>
42           Commit: <committer>
44               <title line>
46               <full commit message>
48         * 'fuller'
50           commit <sha1>
51           Author: <author>
52           AuthorDate: <date & time>
53           Commit: <committer>
54           CommitDate: <date & time>
56                <title line>
58                <full commit message>
61         * 'email'
63           From <sha1> <date>
64           From: <author>
65           Date: <date & time>
66           Subject: [PATCH] <title line>
68           full commit message>
71         * 'raw'
73 The 'raw' format shows the entire commit exactly as
74 stored in the commit object.  Notably, the SHA1s are
75 displayed in full, regardless of whether --abbrev or
76 --no-abbrev are used, and 'parents' information show the
77 true parent commits, without taking grafts nor history
78 simplification into account.
80 --encoding[=<encoding>]::
81         The commit objects record the encoding used for the log message
82         in their encoding header; this option can be used to tell the
83         command to re-code the commit log message in the encoding
84         preferred by the user.  For non plumbing commands this
85         defaults to UTF-8.