From 775a0f4855989aa6804034eafaf38b828e63f151 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Sun, 31 Dec 2006 01:19:14 +0000 Subject: [PATCH] Autogenerated HTML docs for v1.5.0-rc0-g53af9 --- git-commit-tree.html | 77 +++++++++++++++++++++++++++++++++- git-commit-tree.txt | 5 +++ git-commit.html | 77 +++++++++++++++++++++++++++++++++- git-commit.txt | 5 +++ git-diff-tree.html | 14 ++++++- git-log.html | 93 ++++++++++++++++++++++++++++++++++++++++- git-log.txt | 10 ++++- git-rev-list.html | 15 ++++++- git-rev-list.txt | 1 + git-show.html | 99 +++++++++++++++++++++++++++++++++++++++++--- git-show.txt | 15 +++++-- i18n.txt | 57 +++++++++++++++++++++++++ pretty-formats.txt | 7 ++++ 13 files changed, 459 insertions(+), 16 deletions(-) create mode 100644 i18n.txt diff --git a/git-commit-tree.html b/git-commit-tree.html index cc4e1ee9d..a68db3628 100644 --- a/git-commit-tree.html +++ b/git-commit-tree.html @@ -385,6 +385,81 @@ Your sysadmin must hate you! +

Discussion

+
+

At the core level, git is character encoding agnostic.

+ +

Although we encourage that the commit log messages are encoded +in UTF-8, both the core and git Porcelain are designed not to +force UTF-8 on projects. If all participants of a particular +project find it more convenient to use legacy encodings, git +does not forbid it. However, there are a few things to keep in +mind.

+
    +
  1. +

    +git-commit-tree (hence, git-commit which uses it) issues + an warning if the commit log message given to it does not look + like a valid UTF-8 string, unless you explicitly say your + project uses a legacy encoding. The way to say this is to + have core.commitencoding in .git/config file, like this: +

    +
    +
    +
    [core]
+        commitencoding = ISO-8859-1
    +
    +

    Commit objects created with the above setting record the value +of core.commitencoding in its encoding header. This is to +help other people who look at them later. Lack of this header +implies that the commit log message is encoded in UTF-8.

    +
    2. +
  2. +

    +git-log, git-show and friends looks at the encoding + header of a commit object, and tries to re-code the log + message into UTF-8 unless otherwise specified. You can + specify the desired output encoding with + core.logoutputencoding in .git/config file, like this: +

    +
    +
    +
    [core]
+        logoutputencoding = ISO-8859-1
    +
    +

    If you do not have this configuration variable, the value of +core.commitencoding is used instead.

    +
    3. +
+

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 +object level, because re-coding to UTF-8 is not necessarily a +reversible operation.

+

See Also

git-write-tree(1)

@@ -403,7 +478,7 @@ Your sysadmin must hate you!
diff --git a/git-commit-tree.txt b/git-commit-tree.txt index 41d1a1c4b..77ba96ed8 100644 --- a/git-commit-tree.txt +++ b/git-commit-tree.txt @@ -81,6 +81,11 @@ Your parents must have hated you!:: Your sysadmin must hate you!:: The password(5) name field is longer than a giant static buffer. +Discussion +---------- + +include::i18n.txt[] + See Also -------- gitlink:git-write-tree[1] diff --git a/git-commit.html b/git-commit.html index 087aa3ef7..849254d2c 100644 --- a/git-commit.html +++ b/git-commit.html @@ -549,6 +549,81 @@ alter the order the changes are committed, because the merge should be recorded as a single commit. In fact, the command refuses to run when given pathnames (but see -i option).

+

DISCUSSION

+
+

At the core level, git is character encoding agnostic.

+ +

Although we encourage that the commit log messages are encoded +in UTF-8, both the core and git Porcelain are designed not to +force UTF-8 on projects. If all participants of a particular +project find it more convenient to use legacy encodings, git +does not forbid it. However, there are a few things to keep in +mind.

+
    +
  1. +

    +git-commit-tree (hence, git-commit which uses it) issues + an warning if the commit log message given to it does not look + like a valid UTF-8 string, unless you explicitly say your + project uses a legacy encoding. The way to say this is to + have core.commitencoding in .git/config file, like this: +

    +
    +
    +
    [core]
+        commitencoding = ISO-8859-1
    +
    +

    Commit objects created with the above setting record the value +of core.commitencoding in its encoding header. This is to +help other people who look at them later. Lack of this header +implies that the commit log message is encoded in UTF-8.

    +
    2. +
  2. +

    +git-log, git-show and friends looks at the encoding + header of a commit object, and tries to re-code the log + message into UTF-8 unless otherwise specified. You can + specify the desired output encoding with + core.logoutputencoding in .git/config file, like this: +

    +
    +
    +
    [core]
+        logoutputencoding = ISO-8859-1
    +
    +

    If you do not have this configuration variable, the value of +core.commitencoding is used instead.

    +
    3. +
+

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 +object level, because re-coding to UTF-8 is not necessarily a +reversible operation.

+

ENVIRONMENT VARIABLES

The command specified by either the VISUAL or EDITOR environment @@ -579,7 +654,7 @@ Junio C Hamano <junkio@cox.net>

diff --git a/git-commit.txt b/git-commit.txt index 0b74cd708..a7adf24fa 100644 --- a/git-commit.txt +++ b/git-commit.txt @@ -223,6 +223,11 @@ should be recorded as a single commit. In fact, the command refuses to run when given pathnames (but see `-i` option). +DISCUSSION +---------- + +include::i18n.txt[] + ENVIRONMENT VARIABLES --------------------- The command specified by either the VISUAL or EDITOR environment diff --git a/git-diff-tree.html b/git-diff-tree.html index a09faf5b8..61e5b019f 100644 --- a/git-diff-tree.html +++ b/git-diff-tree.html @@ -847,6 +847,18 @@ simplification into account.

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

+
+
--no-commit-id
@@ -1268,7 +1280,7 @@ two unresolved merge parents with the working tree file diff --git a/git-log.html b/git-log.html index 081201844..e963c38e5 100644 --- a/git-log.html +++ b/git-log.html @@ -417,6 +417,18 @@ simplification into account.

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

+
+
--max-count=<n>
@@ -429,7 +441,9 @@ simplification into account.

- Show only commits between the named two commits. + Show only commits between the named two commits. When + either <since> or <until> is omitted, it defaults to + HEAD, i.e. the tip of the current branch.

@@ -492,6 +506,81 @@ git log -r --name-status release..test +

Discussion

+
+

At the core level, git is character encoding agnostic.

+
    +
  • +

    +The pathnames recorded in the index and in the tree objects + are treated as uninterpreted sequences of non-NUL bytes. + What readdir(2) returns are what are recorded and compared + with the data git keeps track of, which in turn are expected + to be what lstat(2) and creat(2) accepts. There is no such + thing as pathname encoding translation. +

    +
    • +
  • +

    +The contents of the blob objects are uninterpreted sequence + of bytes. There is no encoding translation at the core + level. +

    +
    • +
  • +

    +The commit log messages are uninterpreted sequence of non-NUL + bytes. +

    +
    • +
+

Although we encourage that the commit log messages are encoded +in UTF-8, both the core and git Porcelain are designed not to +force UTF-8 on projects. If all participants of a particular +project find it more convenient to use legacy encodings, git +does not forbid it. However, there are a few things to keep in +mind.

+
    +
  1. +

    +git-commit-tree (hence, git-commit which uses it) issues + an warning if the commit log message given to it does not look + like a valid UTF-8 string, unless you explicitly say your + project uses a legacy encoding. The way to say this is to + have core.commitencoding in .git/config file, like this: +

    +
    +
    +
    [core]
+        commitencoding = ISO-8859-1
    +
    +

    Commit objects created with the above setting record the value +of core.commitencoding in its encoding header. This is to +help other people who look at them later. Lack of this header +implies that the commit log message is encoded in UTF-8.

    +
    2. +
  2. +

    +git-log, git-show and friends looks at the encoding + header of a commit object, and tries to re-code the log + message into UTF-8 unless otherwise specified. You can + specify the desired output encoding with + core.logoutputencoding in .git/config file, like this: +

    +
    +
    +
    [core]
+        logoutputencoding = ISO-8859-1
    +
    +

    If you do not have this configuration variable, the value of +core.commitencoding is used instead.

    +
    3. +
+

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 +object level, because re-coding to UTF-8 is not necessarily a +reversible operation.

+

Author

Written by Linus Torvalds <torvalds@osdl.org>

@@ -506,7 +595,7 @@ git log -r --name-status release..test
diff --git a/git-log.txt b/git-log.txt index 79643ac92..e9f746bbd 100644 --- a/git-log.txt +++ b/git-log.txt @@ -31,7 +31,9 @@ include::pretty-formats.txt[] Limits the number of commits to show. ..:: - Show only commits between the named two commits. + Show only commits between the named two commits. When + either or is omitted, it defaults to + `HEAD`, i.e. the tip of the current branch. -p:: Show the change the commit introduces in a patch form. @@ -63,6 +65,12 @@ git log -r --name-status release..test:: in the "release" branch, along with the list of paths each commit modifies. +Discussion +---------- + +include::i18n.txt[] + + Author ------ Written by Linus Torvalds diff --git a/git-rev-list.html b/git-rev-list.html index 41ccd2cde..ecf560fe5 100644 --- a/git-rev-list.html +++ b/git-rev-list.html @@ -285,6 +285,7 @@ git-rev-list(1) Manual Page [ --stdin ] [ --topo-order ] [ --parents ] + [ --encoding[=<encoding>] ] [ --(author|committer|grep)=<pattern> ] [ [--objects | --objects-edge] [ --unpacked ] ] [ --pretty | --header ] @@ -466,6 +467,18 @@ simplification into account.

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

+
+
--relative-date
@@ -774,7 +787,7 @@ and the git-list <git@vger.kernel.org>.

diff --git a/git-rev-list.txt b/git-rev-list.txt index 9e0dcf8d3..86c94e7df 100644 --- a/git-rev-list.txt +++ b/git-rev-list.txt @@ -21,6 +21,7 @@ SYNOPSIS [ \--stdin ] [ \--topo-order ] [ \--parents ] + [ \--encoding[=] ] [ \--(author|committer|grep)= ] [ [\--objects | \--objects-edge] [ \--unpacked ] ] [ \--pretty | \--header ] diff --git a/git-show.html b/git-show.html index d02b8a7b4..530bf5529 100644 --- a/git-show.html +++ b/git-show.html @@ -290,11 +290,11 @@ with --name-only).

-<commitid> +<object>

- ID of the commit to show. + The name of the object to show.

@@ -427,6 +427,18 @@ simplification into account.

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

+

EXAMPLES

@@ -437,7 +449,8 @@ git show v1.0.0

- Shows the tag v1.0.0. + Shows the tag v1.0.0, along with the object the tags + points at.

@@ -457,10 +470,86 @@ git show v1.0.0 Concatenates the contents of said Makefiles in the head of the branch master.

+

Discussion

+
+

At the core level, git is character encoding agnostic.

+
    +
  • +

    +The pathnames recorded in the index and in the tree objects + are treated as uninterpreted sequences of non-NUL bytes. + What readdir(2) returns are what are recorded and compared + with the data git keeps track of, which in turn are expected + to be what lstat(2) and creat(2) accepts. There is no such + thing as pathname encoding translation. +

    +
    • +
  • +

    +The contents of the blob objects are uninterpreted sequence + of bytes. There is no encoding translation at the core + level. +

    +
    • +
  • +

    +The commit log messages are uninterpreted sequence of non-NUL + bytes. +

    +
    • +
+

Although we encourage that the commit log messages are encoded +in UTF-8, both the core and git Porcelain are designed not to +force UTF-8 on projects. If all participants of a particular +project find it more convenient to use legacy encodings, git +does not forbid it. However, there are a few things to keep in +mind.

+
    +
  1. +

    +git-commit-tree (hence, git-commit which uses it) issues + an warning if the commit log message given to it does not look + like a valid UTF-8 string, unless you explicitly say your + project uses a legacy encoding. The way to say this is to + have core.commitencoding in .git/config file, like this: +

    +
    +
    +
    [core]
+        commitencoding = ISO-8859-1
    +
    +

    Commit objects created with the above setting record the value +of core.commitencoding in its encoding header. This is to +help other people who look at them later. Lack of this header +implies that the commit log message is encoded in UTF-8.

    +
    2. +
  2. +

    +git-log, git-show and friends looks at the encoding + header of a commit object, and tries to re-code the log + message into UTF-8 unless otherwise specified. You can + specify the desired output encoding with + core.logoutputencoding in .git/config file, like this: +

    +
    +
    +
    [core]
+        logoutputencoding = ISO-8859-1
    +
    +

    If you do not have this configuration variable, the value of +core.commitencoding is used instead.

    +
    3. +
+

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 +object level, because re-coding to UTF-8 is not necessarily a +reversible operation.

+

Author

Written by Linus Torvalds <torvalds@osdl.org> and -Junio C Hamano <junkio@cox.net>

+Junio C Hamano <junkio@cox.net>. Significantly enhanced by +Johannes Schindelin <Johannes.Schindelin@gmx.de>.

Documentation

@@ -473,7 +562,7 @@ Junio C Hamano <junkio@cox.net>

diff --git a/git-show.txt b/git-show.txt index 98dea6125..c210b9af6 100644 --- a/git-show.txt +++ b/git-show.txt @@ -30,8 +30,8 @@ This manual page describes only the most frequently used options. OPTIONS ------- -:: - ID of the commit to show. +:: + The name of the object to show. include::pretty-formats.txt[] @@ -40,7 +40,8 @@ EXAMPLES -------- git show v1.0.0:: - Shows the tag `v1.0.0`. + Shows the tag `v1.0.0`, along with the object the tags + points at. git show v1.0.0^{tree}:: Shows the tree pointed to by the tag `v1.0.0`. @@ -54,10 +55,16 @@ git show master:Makefile master:t/Makefile Concatenates the contents of said Makefiles in the head of the branch `master`. +Discussion +---------- + +include::i18n.txt[] + Author ------ Written by Linus Torvalds and -Junio C Hamano +Junio C Hamano . Significantly enhanced by +Johannes Schindelin . Documentation diff --git a/i18n.txt b/i18n.txt new file mode 100644 index 000000000..b4cbb3830 --- /dev/null +++ b/i18n.txt @@ -0,0 +1,57 @@ +At the core level, git is character encoding agnostic. + + - The pathnames recorded in the index and in the tree objects + are treated as uninterpreted sequences of non-NUL bytes. + What readdir(2) returns are what are recorded and compared + with the data git keeps track of, which in turn are expected + to be what lstat(2) and creat(2) accepts. There is no such + thing as pathname encoding translation. + + - The contents of the blob objects are uninterpreted sequence + of bytes. There is no encoding translation at the core + level. + + - The commit log messages are uninterpreted sequence of non-NUL + bytes. + +Although we encourage that the commit log messages are encoded +in UTF-8, both the core and git Porcelain are designed not to +force UTF-8 on projects. If all participants of a particular +project find it more convenient to use legacy encodings, git +does not forbid it. However, there are a few things to keep in +mind. + +. `git-commit-tree` (hence, `git-commit` which uses it) issues + an warning if the commit log message given to it does not look + like a valid UTF-8 string, unless you explicitly say your + project uses a legacy encoding. The way to say this is to + have core.commitencoding in `.git/config` file, like this: ++ +------------ +[core] + commitencoding = ISO-8859-1 +------------ ++ +Commit objects created with the above setting record the value +of `core.commitencoding` in its `encoding` header. This is to +help other people who look at them later. Lack of this header +implies that the commit log message is encoded in UTF-8. + +. `git-log`, `git-show` and friends looks at the `encoding` + header of a commit object, and tries to re-code the log + message into UTF-8 unless otherwise specified. You can + specify the desired output encoding with + `core.logoutputencoding` in `.git/config` file, like this: ++ +------------ +[core] + logoutputencoding = ISO-8859-1 +------------ ++ +If you do not have this configuration variable, the value of +`core.commitencoding` is used instead. + +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 +object level, because re-coding to UTF-8 is not necessarily a +reversible operation. diff --git a/pretty-formats.txt b/pretty-formats.txt index 996f62890..fb0b0b958 100644 --- a/pretty-formats.txt +++ b/pretty-formats.txt @@ -76,3 +76,10 @@ displayed in full, regardless of whether --abbrev or --no-abbrev are used, and 'parents' information show the true parent commits, without taking grafts nor history simplification into account. + +--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. -- 2.26.2