undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'ks/doc-fixes' into maint

Browse Source 
Doc clean-up.

* ks/doc-fixes:
  doc: reformat the paragraph containing the 'cut-line'
  doc: camelCase the i18n config variables to improve readability
This commit is contained in:
Junio C Hamano 2017-07-31 13:51:06 -07:00
commit 0baf0b839b
2 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Documentation/git-commit.txt
View File

@ -196,11 +196,12 @@ whitespace::
verbatim:: verbatim::
Do not change the message at all. Do not change the message at all.
scissors:: scissors::
Same as `whitespace`, except that everything from (and Same as `whitespace` except that everything from (and including)
including) the line the line found below is truncated, if the message is to be edited.
"`# ------------------------ >8 ------------------------`" "`#`" can be customized with core.commentChar.
is truncated if the message is to be edited. "`#`" can be
customized with core.commentChar. # ------------------------ >8 ------------------------
default:: default::
Same as `strip` if the message is to be edited. Same as `strip` if the message is to be edited.
Otherwise `whitespace`. Otherwise `whitespace`.

10
Documentation/i18n.txt
View File

@ -42,11 +42,11 @@ mind.
+ +
------------ ------------
[i18n] [i18n]
commitencoding = ISO-8859-1 commitEncoding = ISO-8859-1
------------ ------------
+ +
Commit objects created with the above setting record the value Commit objects created with the above setting record the value
of `i18n.commitencoding` in its `encoding` header. This is to of `i18n.commitEncoding` in its `encoding` header. This is to
help other people who look at them later. Lack of this header help other people who look at them later. Lack of this header
implies that the commit log message is encoded in UTF-8. implies that the commit log message is encoded in UTF-8.
@ -54,15 +54,15 @@ implies that the commit log message is encoded in UTF-8.
`encoding` header of a commit object, and try to re-code the `encoding` header of a commit object, and try to re-code the
log message into UTF-8 unless otherwise specified. You can log message into UTF-8 unless otherwise specified. You can
specify the desired output encoding with specify the desired output encoding with
`i18n.logoutputencoding` in `.git/config` file, like this: `i18n.logOutputEncoding` in `.git/config` file, like this:
+ +
------------ ------------
[i18n] [i18n]
logoutputencoding = ISO-8859-1 logOutputEncoding = ISO-8859-1
------------ ------------
+ +
If you do not have this configuration variable, the value of If you do not have this configuration variable, the value of
`i18n.commitencoding` is used instead. `i18n.commitEncoding` is used instead.
Note that we deliberately chose not to re-code the commit log Note that we deliberately chose not to re-code the commit log
message when a commit is made to force UTF-8 at the commit message when a commit is made to force UTF-8 at the commit