From 7290cb5399d11a68a191ddf05b806932905927a1 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Sun, 31 Dec 2006 01:19:34 +0000 Subject: [PATCH] Autogenerated man pages for v1.5.0-rc0-g53af9 --- man1/git-commit-tree.1 | 59 +++++++++++++++++++++--------- man1/git-commit.1 | 35 +++++++++++++++++- man1/git-diff-tree.1 | 5 ++- man1/git-log.1 | 83 +++++++++++++++++++++++------------------- man1/git-rev-list.1 | 6 ++- man1/git-show.1 | 46 ++++++++++++++++++++--- 6 files changed, 171 insertions(+), 63 deletions(-) diff --git a/man1/git-commit-tree.1 b/man1/git-commit-tree.1 index 11e21c509..66923caa4 100644 --- a/man1/git-commit-tree.1 +++ b/man1/git-commit-tree.1 @@ -2,7 +2,7 @@ .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). .\" Instead of manually editing it, you probably should edit the DocBook XML .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. -.TH "GIT\-COMMIT\-TREE" "1" "10/03/2006" "" "" +.TH "GIT\-COMMIT\-TREE" "1" "12/31/2006" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -11,28 +11,23 @@ git\-commit\-tree \- Creates a new commit object .SH "SYNOPSIS" \fIgit\-commit\-tree\fR [\-p ]* < changelog -.sp .SH "DESCRIPTION" Creates a new commit object based on the provided tree object and emits the new commit object id on stdout. If no parent is given then it is considered to be an initial tree. -.sp + A commit object usually has 1 parent (a commit after a change) or up to 16 parents. More than one parent represents a merge of branches that led to them. -.sp + While a tree represents a particular directory state of a working directory, a commit represents that state in "time", and explains how to get there. -.sp + Normally a commit would identify a new "HEAD" state, and while git doesn't care where you save the note about that state, in practice we tend to just write the result to the file that is pointed at by .git/HEAD, so that we can always see what the last committed state was. -.sp .SH "OPTIONS" .TP An existing tree object .TP \-p -Each -\fI\-p\fR -indicates the id of a parent commit object. +Each \fI\-p\fR indicates the id of a parent commit object. .SH "COMMIT INFORMATION" A commit encapsulates: -.sp .TP 3 \(bu all parent object ids @@ -42,9 +37,9 @@ author name, email and date .TP \(bu committer name and email and the commit time. + If not provided, "git\-commit\-tree" uses your name, hostname and domain to provide author and committer info. This can be overridden by either .git/config file, or using the following environment variables. .sp -.sp .nf GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL @@ -53,17 +48,15 @@ GIT_COMMITTER_NAME GIT_COMMITTER_EMAIL .fi (nb "<", ">" and "\\n"s are stripped) -.sp + In .git/config file, the following items are used for GIT_AUTHOR_NAME and GIT_AUTHOR_EMAIL: .sp -.sp .nf [user] name = "Your Name" email = "your@email.address.xz" .fi A commit comment is read from stdin (max 999 chars). If a changelog entry is not provided via "<" redirection, "git\-commit\-tree" will just wait for one to be entered and terminated with ^D. -.sp .SH "DIAGNOSTICS" .TP You don't exist. Go away! @@ -74,15 +67,45 @@ The password(5) gecos field is longer than a giant static buffer. .TP Your sysadmin must hate you! The password(5) name field is longer than a giant static buffer. +.SH "DISCUSSION" +At the core level, git is character encoding agnostic. +.TP 3 +\(bu +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. +.TP +\(bu +The contents of the blob objects are uninterpreted sequence of bytes. There is no encoding translation at the core level. +.TP +\(bu +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. +.TP 3 +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: +.sp +.nf +[core] + commitencoding = ISO\-8859\-1 +.fi +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. +.TP +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: +.sp +.nf +[core] + logoutputencoding = ISO\-8859\-1 +.fi +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. .SH "SEE ALSO" \fBgit\-write\-tree\fR(1) -.sp .SH "AUTHOR" Written by Linus Torvalds -.sp .SH "DOCUMENTATION" Documentation by David Greaves, Junio C Hamano and the git\-list . -.sp .SH "GIT" Part of the \fBgit\fR(7) suite -.sp + diff --git a/man1/git-commit.1 b/man1/git-commit.1 index 734bc3ec8..a702016b2 100644 --- a/man1/git-commit.1 +++ b/man1/git-commit.1 @@ -2,7 +2,7 @@ .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). .\" Instead of manually editing it, you probably should edit the DocBook XML .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. -.TH "GIT\-COMMIT" "1" "12/16/2006" "" "" +.TH "GIT\-COMMIT" "1" "12/31/2006" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -130,6 +130,39 @@ After resolving conflicts and staging the result, git ls\-files \-u would stop m $ git commit .fi As with the case to record your own changes, you can use \-a option to save typing. One difference is that during a merge resolution, you cannot use git commit with pathnames to 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). +.SH "DISCUSSION" +At the core level, git is character encoding agnostic. +.TP 3 +\(bu +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. +.TP +\(bu +The contents of the blob objects are uninterpreted sequence of bytes. There is no encoding translation at the core level. +.TP +\(bu +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. +.TP 3 +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: +.sp +.nf +[core] + commitencoding = ISO\-8859\-1 +.fi +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. +.TP +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: +.sp +.nf +[core] + logoutputencoding = ISO\-8859\-1 +.fi +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. .SH "ENVIRONMENT VARIABLES" The command specified by either the VISUAL or EDITOR environment variables is used to edit the commit log message. .SH "HOOKS" diff --git a/man1/git-diff-tree.1 b/man1/git-diff-tree.1 index 9850f648d..5599d7be5 100644 --- a/man1/git-diff-tree.1 +++ b/man1/git-diff-tree.1 @@ -2,7 +2,7 @@ .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). .\" Instead of manually editing it, you probably should edit the DocBook XML .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. -.TH "GIT\-DIFF\-TREE" "1" "12/26/2006" "" "" +.TH "GIT\-DIFF\-TREE" "1" "12/31/2006" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -260,6 +260,9 @@ full commit message> The \fIraw\fR format shows the entire commit exactly as stored in the commit object. Notably, the SHA1s are displayed in full, regardless of whether \-\-abbrev or \-\-no\-abbrev are used, and \fIparents\fR information show the true parent commits, without taking grafts nor history simplification into account. .RE .TP +\-\-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. +.TP \-\-no\-commit\-id git\-diff\-tree outputs a line with the commit ID when applicable. This flag suppressed the commit ID output. .TP diff --git a/man1/git-log.1 b/man1/git-log.1 index 1b8cfedfa..e164d4e61 100644 --- a/man1/git-log.1 +++ b/man1/git-log.1 @@ -2,7 +2,7 @@ .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). .\" Instead of manually editing it, you probably should edit the DocBook XML .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. -.TH "GIT\-LOG" "1" "11/23/2006" "" "" +.TH "GIT\-LOG" "1" "12/31/2006" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -11,31 +11,16 @@ git\-log \- Show commit logs .SH "SYNOPSIS" \fIgit\-log\fR