summaryrefslogtreecommitdiff
path: root/Documentation/pretty-options.txt
diff options
context:
space:
mode:
authorJakub Narebski <jnareb@gmail.com>2007-05-13 23:25:45 (GMT)
committerJunio C Hamano <junkio@cox.net>2007-05-14 01:44:50 (GMT)
commit331b51d24050c221221049421a924c1a150887db (patch)
treed52edd2cc07ccef68cdab841a4043a4bf844911a /Documentation/pretty-options.txt
parent785cdea9befecc63b2b576c8042c5482fbf7bceb (diff)
downloadgit-331b51d24050c221221049421a924c1a150887db.zip
git-331b51d24050c221221049421a924c1a150887db.tar.gz
git-331b51d24050c221221049421a924c1a150887db.tar.bz2
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>
Diffstat (limited to 'Documentation/pretty-options.txt')
-rw-r--r--Documentation/pretty-options.txt14
1 files changed, 14 insertions, 0 deletions
diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt
new file mode 100644
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.
+