From 469d60ee1890ec743da9181606eb995b0aac21ee Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Sun, 29 Apr 2007 18:30:34 +0000 Subject: [PATCH] Autogenerated HTML docs for v1.5.2-rc0-95-ga0715 --- config.txt | 4 +-- git-blame.html | 12 ++++++-- git-blame.txt | 5 +++- git-commit-tree.html | 6 ++-- git-commit-tree.txt | 2 ++ git-config.html | 6 ++-- git-shortlog.html | 10 +++---- git-shortlog.txt | 8 ++--- git-svn.html | 12 +++++++- git-svn.txt | 5 ++++ git.html | 8 ++++- git.txt | 2 ++ gitattributes.html | 48 ++++++++++++++++++++++++++++-- gitattributes.txt | 70 ++++++++++++++++++++++++++++++++++++++++++-- 14 files changed, 172 insertions(+), 26 deletions(-) diff --git a/config.txt b/config.txt index e0aff5369..c257cdf52 100644 --- a/config.txt +++ b/config.txt @@ -610,8 +610,8 @@ tar.umask:: user.email:: Your email address to be recorded in any newly created commits. - Can be overridden by the 'GIT_AUTHOR_EMAIL' and 'GIT_COMMITTER_EMAIL' - environment variables. See gitlink:git-commit-tree[1]. + Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and + 'EMAIL' environment variables. See gitlink:git-commit-tree[1]. user.name:: Your full name to be recorded in any newly created commits. diff --git a/git-blame.html b/git-blame.html index 03111d160..122f18420 100644 --- a/git-blame.html +++ b/git-blame.html @@ -273,7 +273,7 @@ git-blame(1) Manual Page

SYNOPSIS

-
git-blame [-c] [-l] [-t] [-f] [-n] [-p] [--incremental] [-L n,m] +
git-blame [-c] [-b] [--root] [-s] [-l] [-t] [-f] [-n] [-p] [--incremental] [-L n,m] [-S <revs-file>] [-M] [-C] [-C] [--since=<date>] [<rev> | --contents <file>] [--] <file>
@@ -502,6 +502,14 @@ commit. Show line number in the original commit (Default: off).

+
+-s +
+
+

+ Suppress author name and timestamp from the output. +

+

THE PORCELAIN FORMAT

@@ -675,7 +683,7 @@ commit commentary), a blame viewer won't ever care. diff --git a/git-blame.txt b/git-blame.txt index 8f9439a6d..44678b0c3 100644 --- a/git-blame.txt +++ b/git-blame.txt @@ -8,7 +8,7 @@ git-blame - Show what revision and author last modified each line of a file SYNOPSIS -------- [verse] -'git-blame' [-c] [-l] [-t] [-f] [-n] [-p] [--incremental] [-L n,m] +'git-blame' [-c] [-b] [--root] [-s] [-l] [-t] [-f] [-n] [-p] [--incremental] [-L n,m] [-S ] [-M] [-C] [-C] [--since=] [ | --contents ] [--] @@ -60,6 +60,9 @@ include::blame-options.txt[] -n, --show-number:: Show line number in the original commit (Default: off). +-s:: + Suppress author name and timestamp from the output. + THE PORCELAIN FORMAT -------------------- diff --git a/git-commit-tree.html b/git-commit-tree.html index 97fa00e77..398b2e156 100644 --- a/git-commit-tree.html +++ b/git-commit-tree.html @@ -343,7 +343,9 @@ either .git/config file, or using the following environment variables.< GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE GIT_COMMITTER_NAME -GIT_COMMITTER_EMAIL +GIT_COMMITTER_EMAIL +GIT_COMMITTER_DATE +EMAIL

(nb "<", ">" and "\n"s are stripped)

In .git/config file, the following items are used for GIT_AUTHOR_NAME and @@ -480,7 +482,7 @@ reversible operation.

diff --git a/git-commit-tree.txt b/git-commit-tree.txt index cf25507f8..504a3aa1b 100644 --- a/git-commit-tree.txt +++ b/git-commit-tree.txt @@ -60,6 +60,8 @@ either `.git/config` file, or using the following environment variables. GIT_AUTHOR_DATE GIT_COMMITTER_NAME GIT_COMMITTER_EMAIL + GIT_COMMITTER_DATE + EMAIL (nb "<", ">" and "\n"s are stripped) diff --git a/git-config.html b/git-config.html index 6bf0d0329..9ec7136fc 100644 --- a/git-config.html +++ b/git-config.html @@ -1560,8 +1560,8 @@ user.email

Your email address to be recorded in any newly created commits. - Can be overridden by the GIT_AUTHOR_EMAIL and GIT_COMMITTER_EMAIL - environment variables. See git-commit-tree(1). + Can be overridden by the GIT_AUTHOR_EMAIL, GIT_COMMITTER_EMAIL, and + EMAIL environment variables. See git-commit-tree(1).

@@ -1654,7 +1654,7 @@ transfer.unpackLimit diff --git a/git-shortlog.html b/git-shortlog.html index 8c616e586..fed7bf59f 100644 --- a/git-shortlog.html +++ b/git-shortlog.html @@ -274,7 +274,7 @@ git-shortlog(1) Manual Page
git-log --pretty=short | git-shortlog [-h] [-n] [-s] -git-shortlog [-n|--number] [-s|--summary] [<committish>…]
+git-shortlog [-n|--numbered] [-s|--summary] [<committish>…]

DESCRIPTION

@@ -287,7 +287,7 @@ the first line of the commit message will be shown.

--h +-h, --help

@@ -295,7 +295,7 @@ the first line of the commit message will be shown.

--n +-n, --numbered

@@ -304,7 +304,7 @@ the first line of the commit message will be shown.

--s +-s, --summary

@@ -344,7 +344,7 @@ Eve Jones <eve@laptop.(none)>

diff --git a/git-shortlog.txt b/git-shortlog.txt index 1c8c55ef6..15cc6f77c 100644 --- a/git-shortlog.txt +++ b/git-shortlog.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] git-log --pretty=short | 'git-shortlog' [-h] [-n] [-s] -git-shortlog [-n|--number] [-s|--summary] [...] +git-shortlog [-n|--numbered] [-s|--summary] [...] DESCRIPTION ----------- @@ -22,14 +22,14 @@ Additionally, "[PATCH]" will be stripped from the commit description. OPTIONS ------- --h:: +-h, \--help:: Print a short usage message and exit. --n:: +-n, \--numbered:: Sort output according to the number of commits per author instead of author alphabetic order. --s:: +-s, \--summary:: Suppress commit description and provide a commit count summary only. FILES diff --git a/git-svn.html b/git-svn.html index 7f508baa4..7dc20e8c6 100644 --- a/git-svn.html +++ b/git-svn.html @@ -540,6 +540,16 @@ and have no uncommitted changes.

+find-rev +
+
+

+ When given an SVN revision number of the form rN, returns the + corresponding git commit hash. When given a tree-ish, returns the + corresponding SVN revision number. +

+
+
set-tree
@@ -984,7 +994,7 @@ should be manually entered with a text-editor or using
diff --git a/git-svn.txt b/git-svn.txt index a0d34e005..a35b9de3b 100644 --- a/git-svn.txt +++ b/git-svn.txt @@ -159,6 +159,11 @@ New features: Any other arguments are passed directly to `git log' -- +'find-rev':: + When given an SVN revision number of the form 'rN', returns the + corresponding git commit hash. When given a tree-ish, returns the + corresponding SVN revision number. + 'set-tree':: You should consider using 'dcommit' instead of this command. Commit specified commit or tree objects to SVN. This relies on diff --git a/git.html b/git.html index e831d8a98..38bb715b9 100644 --- a/git.html +++ b/git.html @@ -1668,6 +1668,12 @@ git so take care if using Cogito etc.

GIT_COMMITTER_EMAIL
+
+GIT_COMMITTER_DATE +
+
+EMAIL +

see git-commit-tree(1) @@ -2325,7 +2331,7 @@ contributors on the git-list <git@vger.kernel.org>.

diff --git a/git.txt b/git.txt index ca1f78f79..c5d02dacd 100644 --- a/git.txt +++ b/git.txt @@ -344,6 +344,8 @@ git Commits 'GIT_AUTHOR_DATE':: 'GIT_COMMITTER_NAME':: 'GIT_COMMITTER_EMAIL':: +'GIT_COMMITTER_DATE':: +'EMAIL':: see gitlink:git-commit-tree[1] git Diffs diff --git a/gitattributes.html b/gitattributes.html index 7019ee168..770fcdb3a 100644 --- a/gitattributes.html +++ b/gitattributes.html @@ -350,11 +350,13 @@ the name of the attribute prefixed with an exclamation point !.

particular attributes to a path. Currently, three operations are attributes-aware.

Checking-out and checking-in

-

The attribute crlf affects how the contents stored in the +

These attributes affect how the contents stored in the repository are copied to the working tree files when commands -such as git checkout and git merge run. It also affects how +such as git checkout and git merge run. They also affect how git stores the contents you prepare in the working tree in the repository upon git add and git commit.

+

crlf

+

This attribute controls the line-ending convention.

Set @@ -410,6 +412,46 @@ in to the repository.

When core.autocrlf is set to "input", line endings are converted to LF upon checkin, but there is no conversion done upon checkout.

+

ident

+

When the attribute ident is set to a path, git replaces +$ident$ in the blob object with $ident:, followed by +40-character hexadecimal blob object name, followed by a dollar +sign $ upon checkout. Any byte sequence that begins with +$ident: and ends with $ in the worktree file is replaced +with $ident$ upon check-in.

+

Interaction between checkin/checkout attributes

+

In the check-in codepath, the worktree file is first converted +with ident (if specified), and then with crlf (again, if +specified and applicable).

+

In the check-out codepath, the blob content is first converted +with crlf, and then ident.

+

filter

+

A filter attribute can be set to a string value. This names +filter driver specified in the configuration.

+

A filter driver consists of clean command and smudge +command, either of which can be left unspecified. Upon +checkout, when smudge command is specified, the command is fed +the blob object from its standard input, and its standard output +is used to update the worktree file. Similarly, clean command +is used to convert the contents of worktree file upon checkin.

+

Missing filter driver definition in the config is not an error +but makes the filter a no-op passthru.

+

The content filtering is done to massage the content into a +shape that is more convenient for the platform, filesystem, and +the user to use. The keyword here is "more convenient" and not +"turning something unusable into usable". In other words, it is +"hanging yourself because we gave you a long rope" if your +project uses filtering mechanism in such a way that it makes +your project unusable unless the checkout is done with a +specific filter in effect.

+

Interaction between checkin/checkout attributes

+

In the check-in codepath, the worktree file is first converted +with filter driver (if specified and corresponding driver +defined), then the result is processed with ident (if +specified), and then finally with crlf (again, if specified +and applicable).

+

In the check-out codepath, the blob content is first converted +with crlf, and then ident and fed to filter.

Generating diff text

The attribute diff affects if git diff generates textual patch for the path or just says Binary files differ.

@@ -616,7 +658,7 @@ frotz unspecified diff --git a/gitattributes.txt b/gitattributes.txt index 857d55a40..87723105d 100644 --- a/gitattributes.txt +++ b/gitattributes.txt @@ -78,12 +78,17 @@ are attributes-aware. Checking-out and checking-in ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The attribute `crlf` affects how the contents stored in the +These attributes affect how the contents stored in the repository are copied to the working tree files when commands -such as `git checkout` and `git merge` run. It also affects how +such as `git checkout` and `git merge` run. They also affect how git stores the contents you prepare in the working tree in the repository upon `git add` and `git commit`. +`crlf` +^^^^^^ + +This attribute controls the line-ending convention. + Set:: Setting the `crlf` attribute on a path is meant to mark @@ -129,6 +134,67 @@ converted to LF upon checkin, but there is no conversion done upon checkout. +`ident` +^^^^^^^ + +When the attribute `ident` is set to a path, git replaces +`$ident$` in the blob object with `$ident:`, followed by +40-character hexadecimal blob object name, followed by a dollar +sign `$` upon checkout. Any byte sequence that begins with +`$ident:` and ends with `$` in the worktree file is replaced +with `$ident$` upon check-in. + + +Interaction between checkin/checkout attributes +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +In the check-in codepath, the worktree file is first converted +with `ident` (if specified), and then with `crlf` (again, if +specified and applicable). + +In the check-out codepath, the blob content is first converted +with `crlf`, and then `ident`. + + +`filter` +^^^^^^^^ + +A `filter` attribute can be set to a string value. This names +filter driver specified in the configuration. + +A filter driver consists of `clean` command and `smudge` +command, either of which can be left unspecified. Upon +checkout, when `smudge` command is specified, the command is fed +the blob object from its standard input, and its standard output +is used to update the worktree file. Similarly, `clean` command +is used to convert the contents of worktree file upon checkin. + +Missing filter driver definition in the config is not an error +but makes the filter a no-op passthru. + +The content filtering is done to massage the content into a +shape that is more convenient for the platform, filesystem, and +the user to use. The keyword here is "more convenient" and not +"turning something unusable into usable". In other words, it is +"hanging yourself because we gave you a long rope" if your +project uses filtering mechanism in such a way that it makes +your project unusable unless the checkout is done with a +specific filter in effect. + + +Interaction between checkin/checkout attributes +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +In the check-in codepath, the worktree file is first converted +with `filter` driver (if specified and corresponding driver +defined), then the result is processed with `ident` (if +specified), and then finally with `crlf` (again, if specified +and applicable). + +In the check-out codepath, the blob content is first converted +with `crlf`, and then `ident` and fed to `filter`. + + Generating diff text ~~~~~~~~~~~~~~~~~~~~ -- 2.26.2