Documentation: git-archive: mark --format as optional in summary
[gitweb.git] / Documentation / pretty-options.txt
index 7d515be0fd3b89d602ac2919fd2ea3dd4bc84131..6d66c74cc11e6622892061f8328d04dfe38f87bf 100644 (file)
@@ -1,9 +1,21 @@
 --pretty[='<format>']::
 
-       Pretty print the contents of the commit logs in a given 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'.
+       When omitted, the format defaults to 'medium'.
++
+Note: you can specify the default pretty format in the repository
+configuration (see linkgit:git-config[1]).
+
+--abbrev-commit::
+       Instead of showing the full 40-byte hexadecimal commit object
+       name, show only handful hexdigits prefix.  Non default number of
+       digits can be specified with "--abbrev=<n>" (which also modifies
+       diff output, if it is displayed).
++
+This should make "--pretty=oneline" a whole lot more readable for
+people using 80-column terminals.
 
 --encoding[=<encoding>]::
        The commit objects record the encoding used for the log message
@@ -11,4 +23,3 @@
        command to re-code the commit log message in the encoding
        preferred by the user.  For non plumbing commands this
        defaults to UTF-8.
-