From 5cf43cab94d19dce9d3c883f374e254c7b2572e1 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Wed, 20 Aug 2008 09:14:14 +0000 Subject: [PATCH] Autogenerated HTML docs for v1.6.0-36-g3814c --- cmds-foreignscminterface.txt | 2 +- config.txt | 4 ++ diff-options.txt | 6 +- git-checkout.html | 10 ++- git-checkout.txt | 10 ++- git-config.html | 11 +++- git-diff-files.html | 8 +-- git-diff-index.html | 8 +-- git-diff-tree.html | 8 +-- git-diff.html | 8 +-- git-format-patch.html | 8 +-- git-hash-object.html | 32 +++++++++- git-hash-object.txt | 20 +++++- git-imap-send.html | 118 ++++++++++++++++++++++++++++++----- git-imap-send.txt | 78 +++++++++++++++++++---- git-log.html | 8 +-- git.html | 4 +- 17 files changed, 277 insertions(+), 66 deletions(-) diff --git a/cmds-foreignscminterface.txt b/cmds-foreignscminterface.txt index 48d7772d4..441aa994c 100644 --- a/cmds-foreignscminterface.txt +++ b/cmds-foreignscminterface.txt @@ -11,7 +11,7 @@ linkgit:git-cvsserver[1]:: A CVS server emulator for git. linkgit:git-imap-send[1]:: - Dump a mailbox from stdin into an imap folder. + Send a collection of patches from stdin to an IMAP folder. linkgit:git-quiltimport[1]:: Applies a quilt patchset onto the current branch. diff --git a/config.txt b/config.txt index 676c39bb8..902067586 100644 --- a/config.txt +++ b/config.txt @@ -567,6 +567,10 @@ diff.autorefreshindex:: affects only 'git-diff' Porcelain, and not lower level 'diff' commands, such as 'git-diff-files'. +diff.suppress-blank-empty:: + A boolean to inhibit the standard behavior of printing a space + before each empty output line. Defaults to false. + diff.external:: If this config variable is set, diff generation is not performed using the internal diff machinery, but using the diff --git a/diff-options.txt b/diff-options.txt index cba90fd27..175938640 100644 --- a/diff-options.txt +++ b/diff-options.txt @@ -107,9 +107,9 @@ endif::git-format-patch[] --exit-code. --full-index:: - Instead of the first handful characters, show full - object name of pre- and post-image blob on the "index" - line when generating a patch format output. + Instead of the first handful of characters, show the full + pre- and post-image blob object names on the "index" + line when generating patch format output. --binary:: In addition to --full-index, output "binary diff" that diff --git a/git-checkout.html b/git-checkout.html index f997d75f6..afa2b48a9 100644 --- a/git-checkout.html +++ b/git-checkout.html @@ -321,7 +321,7 @@ git-checkout(1) Manual Page

SYNOPSIS

-
git checkout [-q] [-f] [[--track | --no-track] -b <new_branch> [-l]] [-m] [<branch>] +
git checkout [-q] [-f] [--track | --no-track] [-b <new_branch> [-l]] [-m] [<branch>] git checkout [<tree-ish>] [--] <paths>…

DESCRIPTION

@@ -332,6 +332,9 @@ branch, <branch>, and updating HEAD to be <branch> or, if specified, <new_branch>. Using -b will cause <new_branch> to be created; in this case you can use the --track or --no-track options, which will be passed to git branch.

+

As a convenience, --track will default to create a branch whose +name is constructed from the specified branch name by stripping +the first namespace level.

When <paths> are given, this command does not switch branches. It updates the named paths in the working tree from the index file (i.e. it runs git checkout-index -f -u), or @@ -392,6 +395,9 @@ working tree.

given. Set it to always if you want this behavior when the start-point is either a local or remote branch.

+

If no -b option was given, a name will be made up for you, by stripping +the part up to the first slash of the tracked branch. For example, if you +called git checkout --track origin/next, the branch name will be next.

--no-track @@ -590,7 +596,7 @@ $ git add frotz diff --git a/git-checkout.txt b/git-checkout.txt index 5aa69c0e1..43d450254 100644 --- a/git-checkout.txt +++ b/git-checkout.txt @@ -8,7 +8,7 @@ git-checkout - Checkout a branch or paths to the working tree SYNOPSIS -------- [verse] -'git checkout' [-q] [-f] [[--track | --no-track] -b [-l]] [-m] [] +'git checkout' [-q] [-f] [--track | --no-track] [-b [-l]] [-m] [] 'git checkout' [] [--] ... DESCRIPTION @@ -21,6 +21,10 @@ specified, . Using -b will cause to be created; in this case you can use the --track or --no-track options, which will be passed to `git branch`. +As a convenience, --track will default to create a branch whose +name is constructed from the specified branch name by stripping +the first namespace level. + When are given, this command does *not* switch branches. It updates the named paths in the working tree from the index file (i.e. it runs `git checkout-index -f -u`), or @@ -59,6 +63,10 @@ OPTIONS 'git-checkout' and 'git-branch' to always behave as if '--no-track' were given. Set it to `always` if you want this behavior when the start-point is either a local or remote branch. ++ +If no '-b' option was given, a name will be made up for you, by stripping +the part up to the first slash of the tracked branch. For example, if you +called 'git checkout --track origin/next', the branch name will be 'next'. --no-track:: Ignore the branch.autosetupmerge configuration variable. diff --git a/git-config.html b/git-config.html index 519d35a29..76fe6f171 100644 --- a/git-config.html +++ b/git-config.html @@ -1548,6 +1548,15 @@ diff.autorefreshindex

+diff.suppress-blank-empty +
+
+

+ A boolean to inhibit the standard behavior of printing a space + before each empty output line. Defaults to false. +

+
+
diff.external
@@ -2710,7 +2719,7 @@ web.browser diff --git a/git-diff-files.html b/git-diff-files.html index 5265df0dd..1257abea7 100644 --- a/git-diff-files.html +++ b/git-diff-files.html @@ -524,9 +524,9 @@ same as for git-diff-index and git-diff-tree.

- Instead of the first handful characters, show full - object name of pre- and post-image blob on the "index" - line when generating a patch format output. + Instead of the first handful of characters, show the full + pre- and post-image blob object names on the "index" + line when generating patch format output.

@@ -1339,7 +1339,7 @@ the pathname, but if that is NUL, the record will show two paths.

diff --git a/git-diff-index.html b/git-diff-index.html index 76a3efc91..d004fc8fb 100644 --- a/git-diff-index.html +++ b/git-diff-index.html @@ -525,9 +525,9 @@ entries in the index are compared.

- Instead of the first handful characters, show full - object name of pre- and post-image blob on the "index" - line when generating a patch format output. + Instead of the first handful of characters, show the full + pre- and post-image blob object names on the "index" + line when generating patch format output.

@@ -1426,7 +1426,7 @@ always have the special all-zero sha1. diff --git a/git-diff-tree.html b/git-diff-tree.html index ebdcbd6af..d1d79ed69 100644 --- a/git-diff-tree.html +++ b/git-diff-tree.html @@ -527,9 +527,9 @@ git-diff-tree(1) Manual Page

- Instead of the first handful characters, show full - object name of pre- and post-image blob on the "index" - line when generating a patch format output. + Instead of the first handful of characters, show the full + pre- and post-image blob object names on the "index" + line when generating patch format output.

@@ -1855,7 +1855,7 @@ the pathname, but if that is NUL, the record will show two paths.

diff --git a/git-diff.html b/git-diff.html index 2ec015d0c..7d6e69318 100644 --- a/git-diff.html +++ b/git-diff.html @@ -603,9 +603,9 @@ and the range notations ("<commit>..<commit>" and

- Instead of the first handful characters, show full - object name of pre- and post-image blob on the "index" - line when generating a patch format output. + Instead of the first handful of characters, show the full + pre- and post-image blob object names on the "index" + line when generating patch format output.

@@ -1541,7 +1541,7 @@ Output diff in reverse. diff --git a/git-format-patch.html b/git-format-patch.html index dd01892b1..9fabc3d30 100644 --- a/git-format-patch.html +++ b/git-format-patch.html @@ -573,9 +573,9 @@ reference.

- Instead of the first handful characters, show full - object name of pre- and post-image blob on the "index" - line when generating a patch format output. + Instead of the first handful of characters, show the full + pre- and post-image blob object names on the "index" + line when generating patch format output.

@@ -1151,7 +1151,7 @@ as e-mailable patches: diff --git a/git-hash-object.html b/git-hash-object.html index 0f760f0d2..8b2c32a4b 100644 --- a/git-hash-object.html +++ b/git-hash-object.html @@ -320,7 +320,9 @@ git-hash-object(1) Manual Page

SYNOPSIS

-

git hash-object [-t <type>] [-w] [--stdin | --stdin-paths] [--] <file>…

+
+
git hash-object [-t <type>] [-w] [--path=<file>|--no-filters] [--stdin] [--] <file>… +git hash-object [-t <type>] [-w] --stdin-paths < <list-of-paths>

DESCRIPTION

@@ -367,6 +369,32 @@ specified, it defaults to "blob".

Read file names from stdin instead of from the command-line.

+
+--path +
+
+

+ Hash object as it were located at the given path. The location of + file does not directly influence on the hash value, but path is + used to determine what git filters should be applied to the object + before it can be placed to the object database, and, as result of + applying filters, the actual blob put into the object database may + differ from the given file. This option is mainly useful for hashing + temporary files located outside of the working directory or files + read from stdin. +

+
+
+--no-filters +
+
+

+ Hash the contents as is, ignoring any input filter that would + have been chosen by the attributes mechanism, including crlf + conversion. If the file is read from standard input then this + is always implied, unless the --path option is given. +

+

Author

@@ -383,7 +411,7 @@ specified, it defaults to "blob".

diff --git a/git-hash-object.txt b/git-hash-object.txt index ac928e198..0af40cfb8 100644 --- a/git-hash-object.txt +++ b/git-hash-object.txt @@ -8,7 +8,9 @@ git-hash-object - Compute object ID and optionally creates a blob from a file SYNOPSIS -------- -'git hash-object' [-t ] [-w] [--stdin | --stdin-paths] [--] ... +[verse] +'git hash-object' [-t ] [-w] [--path=|--no-filters] [--stdin] [--] ... +'git hash-object' [-t ] [-w] --stdin-paths < DESCRIPTION ----------- @@ -35,6 +37,22 @@ OPTIONS --stdin-paths:: Read file names from stdin instead of from the command-line. +--path:: + Hash object as it were located at the given path. The location of + file does not directly influence on the hash value, but path is + used to determine what git filters should be applied to the object + before it can be placed to the object database, and, as result of + applying filters, the actual blob put into the object database may + differ from the given file. This option is mainly useful for hashing + temporary files located outside of the working directory or files + read from stdin. + +--no-filters:: + Hash the contents as is, ignoring any input filter that would + have been chosen by the attributes mechanism, including crlf + conversion. If the file is read from standard input then this + is always implied, unless the --path option is given. + Author ------ Written by Junio C Hamano diff --git a/git-imap-send.html b/git-imap-send.html index 742816742..4dcff7707 100644 --- a/git-imap-send.html +++ b/git-imap-send.html @@ -314,7 +314,7 @@ git-imap-send(1) Manual Page

NAME

git-imap-send - - Dump a mailbox from stdin into an imap folder + Send a collection of patches from stdin to an IMAP folder

@@ -324,30 +324,114 @@ git-imap-send(1) Manual Page

DESCRIPTION

-

This command uploads a mailbox generated with git-format-patch -into an imap drafts folder. This allows patches to be sent as -other email is sent with mail clients that cannot read mailbox +

This command uploads a mailbox generated with git-format-patch +into an IMAP drafts folder. This allows patches to be sent as +other email is when using mail clients that cannot read mailbox files directly.

Typical usage is something like:

git format-patch --signoff --stdout --attach origin | git imap-send

CONFIGURATION

-

git-imap-send requires the following values in the repository -configuration file (shown with examples):

+

To use the tool, imap.folder and either imap.tunnel or imap.host must be set +to appropriate values.

+

Variables

+
+
+imap.folder +
+
+

+ The folder to drop the mails into, which is typically the Drafts + folder. For example: "INBOX.Drafts", "INBOX/Drafts" or + "[Gmail]/Drafts". Required to use imap-send. +

+
+
+imap.tunnel +
+
+

+ Command used to setup a tunnel to the IMAP server through which + commands will be piped instead of using a direct network connection + to the server. Required when imap.host is not set to use imap-send. +

+
+
+imap.host +
+
+

+ A URL identifying the server. Use a imap:// prefix for non-secure + connections and a imaps:// prefix for secure connections. + Ignored when imap.tunnel is set, but required to use imap-send + otherwise. +

+
+
+imap.user +
+
+

+ The username to use when logging in to the server. +

+
+
+imap.password +
+
+

+ The password to use when logging in to the server. +

+
+
+imap.port +
+
+

+ An integer port number to connect to on the server. + Defaults to 143 for imap:// hosts and 993 for imaps:// hosts. + Ignored when imap.tunnel is set. +

+
+
+imap.sslverify +
+
+

+ A boolean to enable/disable verification of the server certificate + used by the SSL/TLS connection. Default is true. Ignored when + imap.tunnel is set. +

+
+
+

Examples

+

Using tunnel mode:

[imap]
-    Folder = "INBOX.Drafts"
-
-[imap]
-    Tunnel = "ssh -q user@server.com /usr/bin/imapd ./Maildir 2> /dev/null"
-
-[imap]
-    Host = imap.server.com
-    User = bob
-    Pass = pwd
-    Port = 143
+ folder = "INBOX.Drafts" + tunnel = "ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2> /dev/null" +
+

Using direct mode:

+
+
+
[imap]
+    folder = "INBOX.Drafts"
+    host = imap://imap.example.com
+    user = bob
+    pass = p4ssw0rd
+
+

Using direct mode with SSL:

+
+
+
[imap]
+    folder = "INBOX.Drafts"
+    host = imaps://imap.example.com
+    user = bob
+    pass = p4ssw0rd
+    port = 123
+    sslverify = false

BUGS

@@ -368,7 +452,7 @@ configuration file (shown with examples):

diff --git a/git-imap-send.txt b/git-imap-send.txt index b3d8da33e..bd49a0aee 100644 --- a/git-imap-send.txt +++ b/git-imap-send.txt @@ -3,7 +3,7 @@ git-imap-send(1) NAME ---- -git-imap-send - Dump a mailbox from stdin into an imap folder +git-imap-send - Send a collection of patches from stdin to an IMAP folder SYNOPSIS @@ -13,9 +13,9 @@ SYNOPSIS DESCRIPTION ----------- -This command uploads a mailbox generated with git-format-patch -into an imap drafts folder. This allows patches to be sent as -other email is sent with mail clients that cannot read mailbox +This command uploads a mailbox generated with 'git-format-patch' +into an IMAP drafts folder. This allows patches to be sent as +other email is when using mail clients that cannot read mailbox files directly. Typical usage is something like: @@ -26,21 +26,75 @@ git format-patch --signoff --stdout --attach origin | git imap-send CONFIGURATION ------------- -'git-imap-send' requires the following values in the repository -configuration file (shown with examples): +To use the tool, imap.folder and either imap.tunnel or imap.host must be set +to appropriate values. + +Variables +~~~~~~~~~ + +imap.folder:: + The folder to drop the mails into, which is typically the Drafts + folder. For example: "INBOX.Drafts", "INBOX/Drafts" or + "[Gmail]/Drafts". Required to use imap-send. + +imap.tunnel:: + Command used to setup a tunnel to the IMAP server through which + commands will be piped instead of using a direct network connection + to the server. Required when imap.host is not set to use imap-send. + +imap.host:: + A URL identifying the server. Use a `imap://` prefix for non-secure + connections and a `imaps://` prefix for secure connections. + Ignored when imap.tunnel is set, but required to use imap-send + otherwise. + +imap.user:: + The username to use when logging in to the server. + +imap.password:: + The password to use when logging in to the server. + +imap.port:: + An integer port number to connect to on the server. + Defaults to 143 for imap:// hosts and 993 for imaps:// hosts. + Ignored when imap.tunnel is set. + +imap.sslverify:: + A boolean to enable/disable verification of the server certificate + used by the SSL/TLS connection. Default is `true`. Ignored when + imap.tunnel is set. + +Examples +~~~~~~~~ + +Using tunnel mode: .......................... [imap] - Folder = "INBOX.Drafts" + folder = "INBOX.Drafts" + tunnel = "ssh -q -C user@example.com /usr/bin/imapd ./Maildir 2> /dev/null" +.......................... +Using direct mode: + +......................... [imap] - Tunnel = "ssh -q user@server.com /usr/bin/imapd ./Maildir 2> /dev/null" + folder = "INBOX.Drafts" + host = imap://imap.example.com + user = bob + pass = p4ssw0rd +.......................... + +Using direct mode with SSL: +......................... [imap] - Host = imap.server.com - User = bob - Pass = pwd - Port = 143 + folder = "INBOX.Drafts" + host = imaps://imap.example.com + user = bob + pass = p4ssw0rd + port = 123 + sslverify = false .......................... diff --git a/git-log.html b/git-log.html index 3cadd9006..6d7ecdf32 100644 --- a/git-log.html +++ b/git-log.html @@ -525,9 +525,9 @@ each commit introduces are shown.

- Instead of the first handful characters, show full - object name of pre- and post-image blob on the "index" - line when generating a patch format output. + Instead of the first handful of characters, show the full + pre- and post-image blob object names on the "index" + line when generating patch format output.

@@ -2166,7 +2166,7 @@ reversible operation.

diff --git a/git.html b/git.html index 7d625afd2..b327e15b8 100644 --- a/git.html +++ b/git.html @@ -1015,7 +1015,7 @@ people via patch over e-mail.

- Dump a mailbox from stdin into an imap folder. + Send a collection of patches from stdin to an IMAP folder.

@@ -2024,7 +2024,7 @@ contributors on the git-list <git@vger.kernel.org>.

-- 2.26.2