From: Junio C Hamano Date: Sun, 13 Jun 2010 18:21:06 +0000 (-0700) Subject: Merge branch 'jn/notes-doc' X-Git-Tag: v1.7.2-rc0~84 X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/95e42a64a9e713bcc3c4590fb933c93d37342322?ds=inline;hp=-c Merge branch 'jn/notes-doc' * jn/notes-doc: Documentation/notes: nitpicks Documentation/notes: clean up description of rewriting configuration Documentation/notes: simplify treatment of default display refs Documentation/log: add a CONFIGURATION section Documentation/notes: simplify treatment of default notes ref Documentation/notes: add configuration section Documentation/notes: describe content of notes blobs Documentation/notes: document format of notes trees --- 95e42a64a9e713bcc3c4590fb933c93d37342322 diff --combined Documentation/config.txt index 7e2ae254b0,295928ea72..95cf73cd47 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@@ -481,8 -481,6 +481,8 @@@ core.whitespace: error (enabled by default). * `indent-with-non-tab` treats a line that is indented with 8 or more space characters as an error (not enabled by default). +* `tab-in-indent` treats a tab character in the initial indent part of + the line as an error (not enabled by default). * `blank-at-eof` treats blank lines added at the end of file as an error (enabled by default). * `trailing-space` is a short-hand to cover both `blank-at-eol` and @@@ -520,18 -518,12 +520,12 @@@ check that makes sure that existing obj core.notesRef:: When showing commit messages, also show notes which are stored in - the given ref. This ref is expected to contain files named - after the full SHA-1 of the commit they annotate. The ref - must be fully qualified. + the given ref. The ref must be fully qualified. If the given + ref does not exist, it is not an error but means that no + notes should be printed. + - If such a file exists in the given ref, the referenced blob is read, and - appended to the commit message, separated by a "Notes ():" - line (shortened to "Notes:" in the case of "refs/notes/commits"). If the - given ref itself does not exist, it is not an error, but means that no - notes should be printed. - + - This setting defaults to "refs/notes/commits", and can be overridden by - the `GIT_NOTES_REF` environment variable. + This setting defaults to "refs/notes/commits", and it can be overridden by + the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. core.sparseCheckout:: Enable "sparse checkout" feature. See section "Sparse checkout" in @@@ -946,19 -938,13 +940,19 @@@ gc.pruneexpire: unreachable objects immediately. gc.reflogexpire:: +gc..reflogexpire:: 'git reflog expire' removes reflog entries older than - this time; defaults to 90 days. + this time; defaults to 90 days. With "" (e.g. + "refs/stash") in the middle the setting applies only to + the refs that match the . gc.reflogexpireunreachable:: +gc..reflogexpireunreachable:: 'git reflog expire' removes reflog entries older than this time and are not reachable from the current tip; - defaults to 30 days. + defaults to 30 days. With "" (e.g. "refs/stash") + in the middle, the setting applies only to the refs that + match the . gc.rerereresolved:: Records of conflicted merge you resolved earlier are @@@ -1276,13 -1262,6 +1270,13 @@@ log.date: following alternatives: {relative,local,default,iso,rfc,short}. See linkgit:git-log[1]. +log.decorate:: + Print out the ref names of any commits that are shown by the log + command. If 'short' is specified, the ref name prefixes 'refs/heads/', + 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is + specified, the full ref name (including prefix) will be printed. + This is the same as the log commands '--decorate' option. + log.showroot:: If true, the initial commit will be shown as a big creation event. This is equivalent to a diff against an empty tree. @@@ -1374,6 -1353,10 +1368,6 @@@ notes.rewrite.: automatically copies your notes from the original to the rewritten commit. Defaults to `true`, but see "notes.rewriteRef" below. -+ -This setting can be overridden with the `GIT_NOTES_REWRITE_REF` -environment variable, which must be a colon separated list of refs or -globs. notes.rewriteMode:: When copying notes during a rewrite (see the @@@ -1393,10 -1376,6 +1387,10 @@@ notes.rewriteRef: + Does not have a default value; you must configure this variable to enable note rewriting. ++ +This setting can be overridden with the `GIT_NOTES_REWRITE_REF` +environment variable, which must be a colon separated list of refs or +globs. pack.window:: The size of the window used by linkgit:git-pack-objects[1] when no @@@ -1481,16 -1460,6 +1475,16 @@@ pager.: it takes precedence over this option. To disable pagination for all commands, set `core.pager` or `GIT_PAGER` to `cat`. +pretty.:: + Alias for a --pretty= format string, as specified in + linkgit:git-log[1]. Any aliases defined here can be used just + as the built-in pretty formats could. For example, + running `git config pretty.changelog "format:{asterisk} %H %s"` + would cause the invocation `git log --pretty=changelog` + to be equivalent to running `git log "--pretty=format:{asterisk} %H %s"`. + Note that an alias with the same name as a built-in format + will be silently ignored. + pull.octopus:: The default merge strategy to use when pulling multiple branches at once. @@@ -1541,7 -1510,7 +1535,7 @@@ receive.denyDeletes: the ref. Use this to prevent such a ref deletion via a push. receive.denyCurrentBranch:: - If set to true or "refuse", receive-pack will deny a ref update + If set to true or "refuse", git-receive-pack will deny a ref update to the currently checked out branch of a non-bare repository. Such a push is potentially dangerous because it brings the HEAD out of sync with the index and working tree. If set to "warn", @@@ -1603,9 -1572,7 +1597,9 @@@ remote..uploadpack: remote..tagopt:: Setting this value to \--no-tags disables automatic tag following when - fetching from remote + fetching from remote . Setting it to \--tags will fetch every + tag from remote , even if they are not reachable from remote + branch heads. remote..vcs:: Setting this to a value will cause git to interact with @@@ -1669,7 -1636,6 +1663,7 @@@ sendemail.smtppass: sendemail.suppresscc:: sendemail.suppressfrom:: sendemail.to:: +sendemail.smtpdomain:: sendemail.smtpserver:: sendemail.smtpserverport:: sendemail.smtpuser:: @@@ -1709,13 -1675,6 +1703,13 @@@ If this variable is not specified, it d This variable can be overridden with the -u|--untracked-files option of linkgit:git-status[1] and linkgit:git-commit[1]. +status.submodulesummary:: + Defaults to false. + If this is set to a non zero number or true (identical to -1 or an + unlimited number), the submodule summary will be enabled and a + summary of commits for modified submodules will be shown (see + --summary-limit option of linkgit:git-submodule[1]). + tar.umask:: This variable can be used to restrict the permission bits of tar archive entries. The default is 0002, which turns off the diff --combined Documentation/git-log.txt index a2d55f9745,d7f6a9cc3e..0e6ff31823 --- a/Documentation/git-log.txt +++ b/Documentation/git-log.txt @@@ -37,8 -37,7 +37,8 @@@ include::diff-options.txt[ and , see "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1]. ---decorate[=short|full]:: +--no-decorate:: +--decorate[=short|full|no]:: Print out the ref names of any commits that are shown. If 'short' is specified, the ref name prefixes 'refs/heads/', 'refs/tags/' and 'refs/remotes/' will not be printed. If 'full' is specified, the @@@ -57,7 -56,7 +57,7 @@@ commits, and doesn't limit diff for those commits. --follow:: - Continue listing the history of a file beyond renames. + Continue listing the history of a file beyond renames/copies. --log-size:: Before the log message print out its size in bytes. Intended @@@ -133,6 -132,48 +133,48 @@@ Discussio include::i18n.txt[] + Configuration + ------------- + + See linkgit:git-config[1] for core variables and linkgit:git-diff[1] + for settings related to diff generation. + + format.pretty:: + Default for the `--format` option. (See "PRETTY FORMATS" above.) + Defaults to "medium". + + i18n.logOutputEncoding:: + Encoding to use when displaying logs. (See "Discussion", above.) + Defaults to the value of `i18n.commitEncoding` if set, UTF-8 + otherwise. + + log.date:: + Default format for human-readable dates. (Compare the + `--date` option.) Defaults to "default", which means to write + dates like `Sat May 8 19:35:34 2010 -0500`. + + log.showroot:: + If `false`, 'git log' and related commands will not treat the + initial commit as a big creation event. Any root commits in + `git log -p` output would be shown without a diff attached. + The default is `true`. + + mailmap.file:: + See linkgit:git-shortlog[1]. + + notes.displayRef:: + Which refs, in addition to the default set by `core.notesRef` + or 'GIT_NOTES_REF', to read notes from when showing commit + messages with the 'log' family of commands. See + linkgit:git-notes[1]. + + + May be an unabbreviated ref name or a glob and may be specified + multiple times. A warning will be issued for refs that do not exist, + but a glob that does not match any refs is silently ignored. + + + This setting can be disabled by the `--no-standard-notes` option, + overridden by the 'GIT_NOTES_DISPLAY_REF' environment variable, + and supplemented by the `--show-notes` option. Author ------