Skip to content

Commit 775a0f4

Browse files
author
Junio C Hamano
committed
Autogenerated HTML docs for v1.5.0-rc0-g53af9
1 parent 51f92e2 commit 775a0f4

13 files changed

Lines changed: 459 additions & 16 deletions

‎git-commit-tree.html‎

Lines changed: 76 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -385,6 +385,81 @@ <h2>Diagnostics</h2>
385385
</dd>
386386
</dl>
387387
</div>
388+
<h2>Discussion</h2>
389+
<div class="sectionbody">
390+
<p>At the core level, git is character encoding agnostic.</p>
391+
<ul>
392+
<li>
393+
<p>
394+
The pathnames recorded in the index and in the tree objects
395+
are treated as uninterpreted sequences of non-NUL bytes.
396+
What readdir(2) returns are what are recorded and compared
397+
with the data git keeps track of, which in turn are expected
398+
to be what lstat(2) and creat(2) accepts. There is no such
399+
thing as pathname encoding translation.
400+
</p>
401+
</li>
402+
<li>
403+
<p>
404+
The contents of the blob objects are uninterpreted sequence
405+
of bytes. There is no encoding translation at the core
406+
level.
407+
</p>
408+
</li>
409+
<li>
410+
<p>
411+
The commit log messages are uninterpreted sequence of non-NUL
412+
bytes.
413+
</p>
414+
</li>
415+
</ul>
416+
<p>Although we encourage that the commit log messages are encoded
417+
in UTF-8, both the core and git Porcelain are designed not to
418+
force UTF-8 on projects. If all participants of a particular
419+
project find it more convenient to use legacy encodings, git
420+
does not forbid it. However, there are a few things to keep in
421+
mind.</p>
422+
<ol>
423+
<li>
424+
<p>
425+
<tt>git-commit-tree</tt> (hence, <tt>git-commit</tt> which uses it) issues
426+
an warning if the commit log message given to it does not look
427+
like a valid UTF-8 string, unless you explicitly say your
428+
project uses a legacy encoding. The way to say this is to
429+
have core.commitencoding in <tt>.git/config</tt> file, like this:
430+
</p>
431+
<div class="listingblock">
432+
<div class="content">
433+
<pre><tt>[core]
434+
commitencoding = ISO-8859-1</tt></pre>
435+
</div></div>
436+
<p>Commit objects created with the above setting record the value
437+
of <tt>core.commitencoding</tt> in its <tt>encoding</tt> header. This is to
438+
help other people who look at them later. Lack of this header
439+
implies that the commit log message is encoded in UTF-8.</p>
440+
</li>
441+
<li>
442+
<p>
443+
<tt>git-log</tt>, <tt>git-show</tt> and friends looks at the <tt>encoding</tt>
444+
header of a commit object, and tries to re-code the log
445+
message into UTF-8 unless otherwise specified. You can
446+
specify the desired output encoding with
447+
<tt>core.logoutputencoding</tt> in <tt>.git/config</tt> file, like this:
448+
</p>
449+
<div class="listingblock">
450+
<div class="content">
451+
<pre><tt>[core]
452+
logoutputencoding = ISO-8859-1</tt></pre>
453+
</div></div>
454+
<p>If you do not have this configuration variable, the value of
455+
<tt>core.commitencoding</tt> is used instead.</p>
456+
</li>
457+
</ol>
458+
<p>Note that we deliberately chose not to re-code the commit log
459+
message when a commit is made to force UTF-8 at the commit
460+
object level, because re-coding to UTF-8 is not necessarily a
461+
reversible operation.</p>
462+
</div>
388463
<h2>See Also</h2>
389464
<div class="sectionbody">
390465
<p><a href="git-write-tree.html">git-write-tree(1)</a></p>
@@ -403,7 +478,7 @@ <h2>GIT</h2>
403478
</div>
404479
<div id="footer">
405480
<div id="footer-text">
406-
Last updated 03-Oct-2006 08:40:57 UTC
481+
Last updated 31-Dec-2006 01:19:01 UTC
407482
</div>
408483
</div>
409484
</body>

‎git-commit-tree.txt‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,11 @@ Your parents must have hated you!::
8181
Your sysadmin must hate you!::
8282
The password(5) name field is longer than a giant static buffer.
8383

84+
Discussion
85+
----------
86+
87+
include::i18n.txt[]
88+
8489
See Also
8590
--------
8691
gitlink:git-write-tree[1]

‎git-commit.html‎

Lines changed: 76 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -549,6 +549,81 @@ <h2>EXAMPLES</h2>
549549
should be recorded as a single commit. In fact, the command
550550
refuses to run when given pathnames (but see <tt>-i</tt> option).</p>
551551
</div>
552+
<h2>DISCUSSION</h2>
553+
<div class="sectionbody">
554+
<p>At the core level, git is character encoding agnostic.</p>
555+
<ul>
556+
<li>
557+
<p>
558+
The pathnames recorded in the index and in the tree objects
559+
are treated as uninterpreted sequences of non-NUL bytes.
560+
What readdir(2) returns are what are recorded and compared
561+
with the data git keeps track of, which in turn are expected
562+
to be what lstat(2) and creat(2) accepts. There is no such
563+
thing as pathname encoding translation.
564+
</p>
565+
</li>
566+
<li>
567+
<p>
568+
The contents of the blob objects are uninterpreted sequence
569+
of bytes. There is no encoding translation at the core
570+
level.
571+
</p>
572+
</li>
573+
<li>
574+
<p>
575+
The commit log messages are uninterpreted sequence of non-NUL
576+
bytes.
577+
</p>
578+
</li>
579+
</ul>
580+
<p>Although we encourage that the commit log messages are encoded
581+
in UTF-8, both the core and git Porcelain are designed not to
582+
force UTF-8 on projects. If all participants of a particular
583+
project find it more convenient to use legacy encodings, git
584+
does not forbid it. However, there are a few things to keep in
585+
mind.</p>
586+
<ol>
587+
<li>
588+
<p>
589+
<tt>git-commit-tree</tt> (hence, <tt>git-commit</tt> which uses it) issues
590+
an warning if the commit log message given to it does not look
591+
like a valid UTF-8 string, unless you explicitly say your
592+
project uses a legacy encoding. The way to say this is to
593+
have core.commitencoding in <tt>.git/config</tt> file, like this:
594+
</p>
595+
<div class="listingblock">
596+
<div class="content">
597+
<pre><tt>[core]
598+
commitencoding = ISO-8859-1</tt></pre>
599+
</div></div>
600+
<p>Commit objects created with the above setting record the value
601+
of <tt>core.commitencoding</tt> in its <tt>encoding</tt> header. This is to
602+
help other people who look at them later. Lack of this header
603+
implies that the commit log message is encoded in UTF-8.</p>
604+
</li>
605+
<li>
606+
<p>
607+
<tt>git-log</tt>, <tt>git-show</tt> and friends looks at the <tt>encoding</tt>
608+
header of a commit object, and tries to re-code the log
609+
message into UTF-8 unless otherwise specified. You can
610+
specify the desired output encoding with
611+
<tt>core.logoutputencoding</tt> in <tt>.git/config</tt> file, like this:
612+
</p>
613+
<div class="listingblock">
614+
<div class="content">
615+
<pre><tt>[core]
616+
logoutputencoding = ISO-8859-1</tt></pre>
617+
</div></div>
618+
<p>If you do not have this configuration variable, the value of
619+
<tt>core.commitencoding</tt> is used instead.</p>
620+
</li>
621+
</ol>
622+
<p>Note that we deliberately chose not to re-code the commit log
623+
message when a commit is made to force UTF-8 at the commit
624+
object level, because re-coding to UTF-8 is not necessarily a
625+
reversible operation.</p>
626+
</div>
552627
<h2>ENVIRONMENT VARIABLES</h2>
553628
<div class="sectionbody">
554629
<p>The command specified by either the VISUAL or EDITOR environment
@@ -579,7 +654,7 @@ <h2>GIT</h2>
579654
</div>
580655
<div id="footer">
581656
<div id="footer-text">
582-
Last updated 16-Dec-2006 07:43:46 UTC
657+
Last updated 31-Dec-2006 01:19:02 UTC
583658
</div>
584659
</div>
585660
</body>

‎git-commit.txt‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,11 @@ should be recorded as a single commit. In fact, the command
223223
refuses to run when given pathnames (but see `-i` option).
224224

225225

226+
DISCUSSION
227+
----------
228+
229+
include::i18n.txt[]
230+
226231
ENVIRONMENT VARIABLES
227232
---------------------
228233
The command specified by either the VISUAL or EDITOR environment

‎git-diff-tree.html‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -847,6 +847,18 @@ <h2>OPTIONS</h2>
847847
</ul>
848848
</dd>
849849
<dt>
850+
--encoding[=&lt;encoding&gt;]
851+
</dt>
852+
<dd>
853+
<p>
854+
The commit objects record the encoding used for the log message
855+
in their encoding header; this option can be used to tell the
856+
command to re-code the commit log message in the encoding
857+
preferred by the user. For non plumbing commands this
858+
defaults to UTF-8.
859+
</p>
860+
</dd>
861+
<dt>
850862
--no-commit-id
851863
</dt>
852864
<dd>
@@ -1268,7 +1280,7 @@ <h2>GIT</h2>
12681280
</div>
12691281
<div id="footer">
12701282
<div id="footer-text">
1271-
Last updated 26-Dec-2006 09:11:33 UTC
1283+
Last updated 31-Dec-2006 01:19:02 UTC
12721284
</div>
12731285
</div>
12741286
</body>

‎git-log.html‎

Lines changed: 91 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -417,6 +417,18 @@ <h2>OPTIONS</h2>
417417
</ul>
418418
</dd>
419419
<dt>
420+
--encoding[=&lt;encoding&gt;]
421+
</dt>
422+
<dd>
423+
<p>
424+
The commit objects record the encoding used for the log message
425+
in their encoding header; this option can be used to tell the
426+
command to re-code the commit log message in the encoding
427+
preferred by the user. For non plumbing commands this
428+
defaults to UTF-8.
429+
</p>
430+
</dd>
431+
<dt>
420432
--max-count=&lt;n&gt;
421433
</dt>
422434
<dd>
@@ -429,7 +441,9 @@ <h2>OPTIONS</h2>
429441
</dt>
430442
<dd>
431443
<p>
432-
Show only commits between the named two commits.
444+
Show only commits between the named two commits. When
445+
either &lt;since&gt; or &lt;until&gt; is omitted, it defaults to
446+
<tt>HEAD</tt>, i.e. the tip of the current branch.
433447
</p>
434448
</dd>
435449
<dt>
@@ -492,6 +506,81 @@ <h2>Examples</h2>
492506
</dd>
493507
</dl>
494508
</div>
509+
<h2>Discussion</h2>
510+
<div class="sectionbody">
511+
<p>At the core level, git is character encoding agnostic.</p>
512+
<ul>
513+
<li>
514+
<p>
515+
The pathnames recorded in the index and in the tree objects
516+
are treated as uninterpreted sequences of non-NUL bytes.
517+
What readdir(2) returns are what are recorded and compared
518+
with the data git keeps track of, which in turn are expected
519+
to be what lstat(2) and creat(2) accepts. There is no such
520+
thing as pathname encoding translation.
521+
</p>
522+
</li>
523+
<li>
524+
<p>
525+
The contents of the blob objects are uninterpreted sequence
526+
of bytes. There is no encoding translation at the core
527+
level.
528+
</p>
529+
</li>
530+
<li>
531+
<p>
532+
The commit log messages are uninterpreted sequence of non-NUL
533+
bytes.
534+
</p>
535+
</li>
536+
</ul>
537+
<p>Although we encourage that the commit log messages are encoded
538+
in UTF-8, both the core and git Porcelain are designed not to
539+
force UTF-8 on projects. If all participants of a particular
540+
project find it more convenient to use legacy encodings, git
541+
does not forbid it. However, there are a few things to keep in
542+
mind.</p>
543+
<ol>
544+
<li>
545+
<p>
546+
<tt>git-commit-tree</tt> (hence, <tt>git-commit</tt> which uses it) issues
547+
an warning if the commit log message given to it does not look
548+
like a valid UTF-8 string, unless you explicitly say your
549+
project uses a legacy encoding. The way to say this is to
550+
have core.commitencoding in <tt>.git/config</tt> file, like this:
551+
</p>
552+
<div class="listingblock">
553+
<div class="content">
554+
<pre><tt>[core]
555+
commitencoding = ISO-8859-1</tt></pre>
556+
</div></div>
557+
<p>Commit objects created with the above setting record the value
558+
of <tt>core.commitencoding</tt> in its <tt>encoding</tt> header. This is to
559+
help other people who look at them later. Lack of this header
560+
implies that the commit log message is encoded in UTF-8.</p>
561+
</li>
562+
<li>
563+
<p>
564+
<tt>git-log</tt>, <tt>git-show</tt> and friends looks at the <tt>encoding</tt>
565+
header of a commit object, and tries to re-code the log
566+
message into UTF-8 unless otherwise specified. You can
567+
specify the desired output encoding with
568+
<tt>core.logoutputencoding</tt> in <tt>.git/config</tt> file, like this:
569+
</p>
570+
<div class="listingblock">
571+
<div class="content">
572+
<pre><tt>[core]
573+
logoutputencoding = ISO-8859-1</tt></pre>
574+
</div></div>
575+
<p>If you do not have this configuration variable, the value of
576+
<tt>core.commitencoding</tt> is used instead.</p>
577+
</li>
578+
</ol>
579+
<p>Note that we deliberately chose not to re-code the commit log
580+
message when a commit is made to force UTF-8 at the commit
581+
object level, because re-coding to UTF-8 is not necessarily a
582+
reversible operation.</p>
583+
</div>
495584
<h2>Author</h2>
496585
<div class="sectionbody">
497586
<p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p>
@@ -506,7 +595,7 @@ <h2>GIT</h2>
506595
</div>
507596
<div id="footer">
508597
<div id="footer-text">
509-
Last updated 23-Nov-2006 02:47:21 UTC
598+
Last updated 31-Dec-2006 01:19:04 UTC
510599
</div>
511600
</div>
512601
</body>

‎git-log.txt‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,9 @@ include::pretty-formats.txt[]
3131
Limits the number of commits to show.
3232

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

3638
-p::
3739
Show the change the commit introduces in a patch form.
@@ -63,6 +65,12 @@ git log -r --name-status release..test::
6365
in the "release" branch, along with the list of paths
6466
each commit modifies.
6567

68+
Discussion
69+
----------
70+
71+
include::i18n.txt[]
72+
73+
6674
Author
6775
------
6876
Written by Linus Torvalds <torvalds@osdl.org>

0 commit comments

Comments
 (0)