From: Junio C Hamano Date: Sat, 8 Mar 2008 09:33:55 +0000 (+0000) Subject: Autogenerated HTML docs for v1.5.4.3-484-g60e3 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=86bccccdbdcef5b72f60cca6ec3d9594b271dc63;p=git.git Autogenerated HTML docs for v1.5.4.3-484-g60e3 --- diff --git a/config.txt b/config.txt index 4027726f2..c5e094a9c 100644 --- a/config.txt +++ b/config.txt @@ -556,6 +556,11 @@ format.suffix:: `.patch`. Use this variable to change that suffix (make sure to include the dot if you want it). +format.pretty:: + The default pretty format for log/show/whatchanged command, + See linkgit:git-log[1], linkgit:git-show[1], + linkgit:git-whatchanged[1]. + gc.aggressiveWindow:: The window size parameter used in the delta compression algorithm used by 'git gc --aggressive'. This defaults @@ -749,8 +754,10 @@ merge.summary:: merge.tool:: Controls which merge resolution program is used by - linkgit:git-mergetool[1]. Valid values are: "kdiff3", "tkdiff", - "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and "opendiff". + linkgit:git-mergetool[1]. Valid built-in values are: "kdiff3", + "tkdiff", "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and + "opendiff". Any other value is treated is custom merge tool + and there must be a corresponing mergetool..cmd option. merge.verbosity:: Controls the amount of output shown by the recursive merge @@ -777,6 +784,31 @@ mergetool..path:: Override the path for the given tool. This is useful in case your tool is not in the PATH. +mergetool..cmd:: + Specify the command to invoke the specified merge tool. The + specified command is evaluated in shell with the following + variables available: 'BASE' is the name of a temporary file + containing the common base of the files to be merged, if available; + 'LOCAL' is the name of a temporary file containing the contents of + the file on the current branch; 'REMOTE' is the name of a temporary + file containing the contents of the file from the branch being + merged; 'MERGED' contains the name of the file to which the merge + tool should write the results of a successful merge. + +mergetool..trustExitCode:: + For a custom merge command, specify whether the exit code of + the merge command can be used to determine whether the merge was + successful. If this is not set to true then the merge target file + timestamp is checked and the merge assumed to have been successful + if the file has been updated, otherwise the user is prompted to + indicate the success of the merge. + +mergetool.keepBackup:: + After performing a merge, the original file with conflict markers + can be saved as a file with a `.orig` extension. If this variable + is set to `false` then this file is not preserved. Defaults to + `true` (i.e. keep the backup files). + pack.window:: The size of the window used by linkgit:git-pack-objects[1] when no window size is given on the command line. Defaults to 10. @@ -864,15 +896,15 @@ remote..skipDefaultUpdate:: remote..receivepack:: The default program to execute on the remote side when pushing. See - option \--exec of linkgit:git-push[1]. + option \--receive-pack of linkgit:git-push[1]. remote..uploadpack:: The default program to execute on the remote side when fetching. See - option \--exec of linkgit:git-fetch-pack[1]. + option \--upload-pack of linkgit:git-fetch-pack[1]. remote..tagopt:: - Setting this value to --no-tags disables automatic tag following when fetching - from remote + Setting this value to \--no-tags disables automatic tag following when + fetching from remote remotes.:: The list of remotes which are fetched by "git remote update diff --git a/git-config.html b/git-config.html index e39570eb7..9be8b83cd 100644 --- a/git-config.html +++ b/git-config.html @@ -1507,6 +1507,16 @@ format.suffix

+format.pretty +
+
+

+ The default pretty format for log/show/whatchanged command, + See git-log(1), git-show(1), + git-whatchanged(1). +

+
+
gc.aggressiveWindow
@@ -1879,8 +1889,10 @@ merge.tool

Controls which merge resolution program is used by - git-mergetool(1). Valid values are: "kdiff3", "tkdiff", - "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and "opendiff". + git-mergetool(1). Valid built-in values are: "kdiff3", + "tkdiff", "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and + "opendiff". Any other value is treated is custom merge tool + and there must be a corresponing mergetool.<tool>.cmd option.

@@ -1934,6 +1946,46 @@ mergetool.<tool>.path

+mergetool.<tool>.cmd +
+
+

+ Specify the command to invoke the specified merge tool. The + specified command is evaluated in shell with the following + variables available: BASE is the name of a temporary file + containing the common base of the files to be merged, if available; + LOCAL is the name of a temporary file containing the contents of + the file on the current branch; REMOTE is the name of a temporary + file containing the contents of the file from the branch being + merged; MERGED contains the name of the file to which the merge + tool should write the results of a successful merge. +

+
+
+mergetool.<tool>.trustExitCode +
+
+

+ For a custom merge command, specify whether the exit code of + the merge command can be used to determine whether the merge was + successful. If this is not set to true then the merge target file + timestamp is checked and the merge assumed to have been successful + if the file has been updated, otherwise the user is prompted to + indicate the success of the merge. +

+
+
+mergetool.keepBackup +
+
+

+ After performing a merge, the original file with conflict markers + can be saved as a file with a .orig extension. If this variable + is set to false then this file is not preserved. Defaults to + true (i.e. keep the backup files). +

+
+
pack.window
@@ -2100,7 +2152,7 @@ remote.<name>.receivepack

The default program to execute on the remote side when pushing. See - option --exec of git-push(1). + option --receive-pack of git-push(1).

@@ -2109,7 +2161,7 @@ remote.<name>.uploadpack

The default program to execute on the remote side when fetching. See - option --exec of git-fetch-pack(1). + option --upload-pack of git-fetch-pack(1).

@@ -2117,8 +2169,8 @@ remote.<name>.tagopt

- Setting this value to --no-tags disables automatic tag following when fetching - from remote <name> + Setting this value to --no-tags disables automatic tag following when + fetching from remote <name>

@@ -2308,7 +2360,7 @@ web.browser diff --git a/git-diff-tree.html b/git-diff-tree.html index 053b7dbf1..bff915567 100644 --- a/git-diff-tree.html +++ b/git-diff-tree.html @@ -841,6 +841,8 @@ separated with a single space are given.

full, fuller, email, raw and format:<string>. When omitted, the format defaults to medium.

+

Note: you can specify the default pretty format in the repository +configuration (see git-config(1)).

--abbrev-commit @@ -1744,7 +1746,7 @@ the pathname, but if that is NUL, the record will show two paths.

diff --git a/git-log.html b/git-log.html index eb1872eaf..949eb1599 100644 --- a/git-log.html +++ b/git-log.html @@ -820,6 +820,8 @@ each commit introduces are shown.

full, fuller, email, raw and format:<string>. When omitted, the format defaults to medium.

+

Note: you can specify the default pretty format in the repository +configuration (see git-config(1)).

--abbrev-commit @@ -1908,7 +1910,7 @@ reversible operation.

diff --git a/git-reflog.html b/git-reflog.html index 5564b5ba4..01a1ecb1b 100644 --- a/git-reflog.html +++ b/git-reflog.html @@ -281,6 +281,7 @@ depending on the subcommand:

git reflog expire [--dry-run] [--stale-fix] [--verbose] [--expire=<time>] [--expire-unreachable=<time>] [--all] <refs>…
+

git reflog delete ref@{specifier}…

git reflog [show] [log-options] [<ref>]

Reflog is a mechanism to record when the tip of branches are updated. This command is to manage the information recorded in it.

@@ -300,6 +301,8 @@ of a reference. For example, HEAD@{2} means "where HEAD used to be two moves ago", master@{one.week.ago} means "where master used to point to one week ago", and so on. See git-rev-parse(1) for more details.

+

To delete single entries from the reflog, use the subcommand "delete" +and specify the _exact_ entry (e.g. “git reflog delete master@{2}”).

OPTIONS

@@ -352,6 +355,25 @@ them.

+--updateref +
+
+

+ Update the ref with the sha1 of the top reflog entry (i.e. + <ref>@{0}) after expiring or deleting. +

+
+
+--rewrite +
+
+

+ While expiring or deleting, adjust each reflog entry to ensure + that the old sha1 field points to the new sha1 field of the + previous entry. +

+
+
--verbose
@@ -375,7 +397,7 @@ them.

diff --git a/git-reflog.txt b/git-reflog.txt index f9bba36c2..047e3ce14 100644 --- a/git-reflog.txt +++ b/git-reflog.txt @@ -19,6 +19,8 @@ depending on the subcommand: git reflog expire [--dry-run] [--stale-fix] [--verbose] [--expire=
--abbrev-commit @@ -1204,7 +1206,7 @@ and the git-list <git@vger.kernel.org>.

diff --git a/git-show.html b/git-show.html index f2a1a2fba..3673c0814 100644 --- a/git-show.html +++ b/git-show.html @@ -311,6 +311,8 @@ control how the changes the commit introduces are shown.

full, fuller, email, raw and format:<string>. When omitted, the format defaults to medium.

+

Note: you can specify the default pretty format in the repository +configuration (see git-config(1)).

--abbrev-commit @@ -762,7 +764,7 @@ Johannes Schindelin <Johannes.Schindelin@gmx.de>.

diff --git a/git-stash.html b/git-stash.html index 0300f0c60..bd6adae9f 100644 --- a/git-stash.html +++ b/git-stash.html @@ -273,7 +273,7 @@ git-stash(1) Manual Page

SYNOPSIS

-
git-stash (list | show [<stash>] | apply [<stash>] | clear) +
git-stash (list | show [<stash>] | apply [<stash>] | clear | drop [<stash>] | pop [<stash>]) git-stash [save [<message>]]

DESCRIPTION

@@ -365,6 +365,25 @@ clear be subject to pruning, and may be difficult or impossible to recover.

+
+drop [<stash>] +
+
+

+ Remove a single stashed state from the stash list. When no <stash> + is given, it removes the latest one. i.e. stash@{0} +

+
+
+pop [<stash>] +
+
+

+ Remove a single stashed state from the stash list and apply on top + of the current working tree state. When no <stash> is given, + stash@{0} is assumed. See also apply. +

+

DISCUSSION

@@ -463,7 +482,7 @@ $ git stash apply diff --git a/git-stash.txt b/git-stash.txt index 48e6f5a3f..8dc35d493 100644 --- a/git-stash.txt +++ b/git-stash.txt @@ -8,7 +8,7 @@ git-stash - Stash the changes in a dirty working directory away SYNOPSIS -------- [verse] -'git-stash' (list | show [] | apply [] | clear) +'git-stash' (list | show [] | apply [] | clear | drop [] | pop []) 'git-stash' [save []] DESCRIPTION @@ -85,6 +85,17 @@ clear:: Remove all the stashed states. Note that those states will then be subject to pruning, and may be difficult or impossible to recover. +drop []:: + + Remove a single stashed state from the stash list. When no `` + is given, it removes the latest one. i.e. `stash@\{0}` + +pop []:: + + Remove a single stashed state from the stash list and apply on top + of the current working tree state. When no `` is given, + `stash@\{0}` is assumed. See also `apply`. + DISCUSSION ---------- diff --git a/git-whatchanged.html b/git-whatchanged.html index 58e3ee6d0..81c368668 100644 --- a/git-whatchanged.html +++ b/git-whatchanged.html @@ -322,16 +322,6 @@ these commands.

---pretty=<format> -
-
-

- Controls the output format for the commit logs. - <format> can be one of raw, medium, short, full, - and oneline. -

-
-
-m
@@ -343,8 +333,336 @@ these commands.

However, it is not very useful in general, although it is useful on a file-by-file basis.

+
+--pretty[=<format>] +
+
+

+ Pretty-print the contents of the commit logs in a given format, + where <format> can be one of oneline, short, medium, + full, fuller, email, raw and format:<string>. + When omitted, the format defaults to medium. +

+

Note: you can specify the default pretty format in the repository +configuration (see git-config(1)).

+
+
+--abbrev-commit +
+
+

+ Instead of showing the full 40-byte hexadecimal commit object + name, show only handful hexdigits prefix. Non default number of + digits can be specified with "--abbrev=<n>" (which also modifies + diff output, if it is displayed). +

+

This should make "--pretty=oneline" a whole lot more readable for +people using 80-column terminals.

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

+
+

PRETTY FORMATS

+
+

If the commit is a merge, and if the pretty-format +is not oneline, email or raw, an additional line is +inserted before the Author: line. This line begins with +"Merge: " and the sha1s of ancestral commits are printed, +separated by spaces. Note that the listed commits may not +necessarily be the list of the direct parent commits if you +have limited your view of history: for example, if you are +only interested in changes related to a certain directory or +file.

+

Here are some additional details for each format:

+
    +
  • +

    +oneline +

    +
    +
    +
    <sha1> <title line>
    +
    +

    This is designed to be as compact as possible.

    +
    • +
  • +

    +short +

    +
    +
    +
    commit <sha1>
+Author: <author>
    +
    +
    +
    +
    <title line>
    +
    +
    • +
  • +

    +medium +

    +
    +
    +
    commit <sha1>
+Author: <author>
+Date: <date>
    +
    +
    +
    +
    <title line>
    +
    +
    +
    +
    <full commit message>
    +
    +
    • +
  • +

    +full +

    +
    +
    +
    commit <sha1>
+Author: <author>
+Commit: <committer>
    +
    +
    +
    +
    <title line>
    +
    +
    +
    +
    <full commit message>
    +
    +
    • +
  • +

    +fuller +

    +
    +
    +
    commit <sha1>
+Author: <author>
+AuthorDate: <date & time>
+Commit: <committer>
+CommitDate: <date & time>
    +
    +
    +
    +
    <title line>
    +
    +
    +
    +
    <full commit message>
    +
    +
    • +
  • +

    +email +

    +
    +
    +
    From <sha1> <date>
+From: <author>
+Date: <date & time>
+Subject: [PATCH] <title line>
    +
    +
    +
    +
    <full commit message>
    +
    +
    • +
  • +

    +raw +

    +

    The raw 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 parents information show the +true parent commits, without taking grafts nor history +simplification into account.

    +
    • +
  • +

    +format: +

    +

    The format: format allows you to specify which information +you want to show. It works a little bit like printf format, +with the notable exception that you get a newline with %n +instead of \n.

    +

    E.g, format:"The author of %h was %an, %ar%nThe title was >>%s<<%n" +would show something like this:

    +
    +
    +
    The author of fe6e0ee was Junio C Hamano, 23 hours ago
+The title was >>t4119: test autocomputing -p<n> for traditional diff input.<<
+
    +
    +

    The placeholders are:

    +
      +
    • +

      +%H: commit hash +

      +
      • +
    • +

      +%h: abbreviated commit hash +

      +
      • +
    • +

      +%T: tree hash +

      +
      • +
    • +

      +%t: abbreviated tree hash +

      +
      • +
    • +

      +%P: parent hashes +

      +
      • +
    • +

      +%p: abbreviated parent hashes +

      +
      • +
    • +

      +%an: author name +

      +
      • +
    • +

      +%ae: author email +

      +
      • +
    • +

      +%ad: author date +

      +
      • +
    • +

      +%aD: author date, RFC2822 style +

      +
      • +
    • +

      +%ar: author date, relative +

      +
      • +
    • +

      +%at: author date, UNIX timestamp +

      +
      • +
    • +

      +%ai: author date, ISO 8601 format +

      +
      • +
    • +

      +%cn: committer name +

      +
      • +
    • +

      +%ce: committer email +

      +
      • +
    • +

      +%cd: committer date +

      +
      • +
    • +

      +%cD: committer date, RFC2822 style +

      +
      • +
    • +

      +%cr: committer date, relative +

      +
      • +
    • +

      +%ct: committer date, UNIX timestamp +

      +
      • +
    • +

      +%ci: committer date, ISO 8601 format +

      +
      • +
    • +

      +%e: encoding +

      +
      • +
    • +

      +%s: subject +

      +
      • +
    • +

      +%b: body +

      +
      • +
    • +

      +%Cred: switch color to red +

      +
      • +
    • +

      +%Cgreen: switch color to green +

      +
      • +
    • +

      +%Cblue: switch color to blue +

      +
      • +
    • +

      +%Creset: reset color +

      +
      • +
    • +

      +%m: left, right or boundary mark +

      +
      • +
    • +

      +%n: newline +

      +
      • +
    +
    • +
+

Examples

@@ -384,7 +702,7 @@ Junio C Hamano <junkio@cox.net>

diff --git a/git-whatchanged.txt b/git-whatchanged.txt index 54947b676..a6e7bd4c8 100644 --- a/git-whatchanged.txt +++ b/git-whatchanged.txt @@ -38,11 +38,6 @@ OPTIONS Show git internal diff output, but for the whole tree, not just the top level. ---pretty=:: - Controls the output format for the commit logs. - can be one of 'raw', 'medium', 'short', 'full', - and 'oneline'. - -m:: By default, differences for merge commits are not shown. With this flag, show differences to that commit from all @@ -51,6 +46,10 @@ OPTIONS However, it is not very useful in general, although it *is* useful on a file-by-file basis. +include::pretty-options.txt[] + +include::pretty-formats.txt[] + Examples -------- git-whatchanged -p v2.6.12.. include/scsi drivers/scsi:: diff --git a/pretty-options.txt b/pretty-options.txt index 973d8dd73..6d66c74cc 100644 --- a/pretty-options.txt +++ b/pretty-options.txt @@ -4,6 +4,9 @@ where '' can be one of 'oneline', 'short', 'medium', 'full', 'fuller', 'email', 'raw' and 'format:'. When omitted, the format defaults to 'medium'. ++ +Note: you can specify the default pretty format in the repository +configuration (see linkgit:git-config[1]). --abbrev-commit:: Instead of showing the full 40-byte hexadecimal commit object diff --git a/technical/api-run-command.html b/technical/api-run-command.html index 67e1b63ec..2c0c21679 100644 --- a/technical/api-run-command.html +++ b/technical/api-run-command.html @@ -448,9 +448,10 @@ Special forms of redirection are available by setting these members
-
.stdout_to_stderr: stdout of the child is redirected to the
-        parent's stderr (i.e. *not* to what .err or
-        .no_stderr specify).
+
.stdout_to_stderr: stdout of the child is redirected to its
+        stderr. This happens after stderr is itself redirected.
+        So stdout will follow stderr to wherever it is
+        redirected.
@@ -563,7 +564,7 @@ It must not change the program's state that the caller of the diff --git a/technical/api-run-command.txt b/technical/api-run-command.txt index fde3b4532..c364a22c8 100644 --- a/technical/api-run-command.txt +++ b/technical/api-run-command.txt @@ -111,9 +111,10 @@ stderr as follows: .no_stdin, .no_stdout, .no_stderr: The respective channel is redirected to /dev/null. - .stdout_to_stderr: stdout of the child is redirected to the - parent's stderr (i.e. *not* to what .err or - .no_stderr specify). + .stdout_to_stderr: stdout of the child is redirected to its + stderr. This happens after stderr is itself redirected. + So stdout will follow stderr to wherever it is + redirected. To modify the environment of the sub-process, specify an array of string pointers (NULL terminated) in .env: