From 8c5802d61d9a556dee3e457a8bde52a54cc636e7 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Thu, 15 Nov 2007 00:13:36 +0000 Subject: [PATCH] Autogenerated HTML docs for v1.5.3.5-721-g039b --- config.txt | 6 ++++++ git-config.html | 13 ++++++++++++- git-cvsexportcommit.html | 32 ++++++++++++++++++++++++++------ git-cvsexportcommit.txt | 22 +++++++++++++++++----- git-format-patch.html | 22 ++++++++++++++++------ git-format-patch.txt | 13 +++++++++---- git-rev-list.html | 15 ++++++++++++++- git-rev-list.txt | 9 +++++++++ user-manual.html | 4 ++-- user-manual.txt | 4 ++-- 10 files changed, 113 insertions(+), 27 deletions(-) diff --git a/config.txt b/config.txt index 8d5d20058..6dc9f3ed0 100644 --- a/config.txt +++ b/config.txt @@ -432,6 +432,12 @@ fetch.unpackLimit:: pack from a push can make the push operation complete faster, especially on slow filesystems. +format.numbered:: + A boolean which can enable sequence numbers in patch subjects. + Seting this option to "auto" will enable it only if there is + more than one patch. See --numbered option in + gitlink:git-format-patch[1]. + format.headers:: Additional email headers to include in a patch to be submitted by mail. See gitlink:git-format-patch[1]. diff --git a/git-config.html b/git-config.html index 6e6129aa1..722c06a47 100644 --- a/git-config.html +++ b/git-config.html @@ -1280,6 +1280,17 @@ fetch.unpackLimit

+format.numbered +
+
+

+ A boolean which can enable sequence numbers in patch subjects. + Seting this option to "auto" will enable it only if there is + more than one patch. See --numbered option in + git-format-patch(1). +

+
+
format.headers
@@ -1956,7 +1967,7 @@ transfer.unpackLimit diff --git a/git-cvsexportcommit.html b/git-cvsexportcommit.html index fba91a80e..3a53da000 100644 --- a/git-cvsexportcommit.html +++ b/git-cvsexportcommit.html @@ -272,14 +272,15 @@ git-cvsexportcommit(1) Manual Page

SYNOPSIS

-

git-cvsexportcommit [-h] [-u] [-v] [-c] [-P] [-p] [-a] [-d cvsroot] [-f] [-m msgprefix] [PARENTCOMMIT] COMMITID

+

git-cvsexportcommit [-h] [-u] [-v] [-c] [-P] [-p] [-a] [-d cvsroot] [-w cvsworkdir] [-f] [-m msgprefix] [PARENTCOMMIT] COMMITID

DESCRIPTION

Exports a commit from GIT to a CVS checkout, making it easier to merge patches from a git repository into a CVS repository.

-

Execute it from the root of the CVS working copy. GIT_DIR must be defined. -See examples below.

+

Specify the name of a CVS checkout using the -w switch or execute it +from the root of the CVS working copy. In the latter case GIT_DIR must +be defined. See examples below.

It does its best to do the safe thing, it will check that the files are unchanged and up to date in the CVS checkout, and it will not autocommit by default.

@@ -361,6 +362,16 @@ should the changeset be done against.

+-w +
+
+

+ Specify the location of the CVS checkout to use for the export. This + option does not require GIT_DIR to be set before execution if the + current directory is within a git repository. +

+
+
-v
@@ -386,6 +397,15 @@ $ cvs commit -F .msg <files>
+Merge one patch into CVS (-c and -w options). The working directory is within the Git Repo +
+
+
+
+
        $ git-cvsexportcommit -v -c -w ~/project_cvs_checkout <commit-sha1>
+
+
+
Merge pending patches into CVS automatically — only if you really know what you are doing
@@ -400,11 +420,11 @@ $ git-cherry cvshead myhead | sed -n 's/^+ //p' | xargs -l1 git-cvsexportcommit

Author

-

Written by Martin Langhoff <martin@catalyst.net.nz>

+

Written by Martin Langhoff <martin@catalyst.net.nz> and others.

Documentation

-

Documentation by Martin Langhoff <martin@catalyst.net.nz>

+

Documentation by Martin Langhoff <martin@catalyst.net.nz> and others.

GIT

@@ -412,7 +432,7 @@ $ git-cherry cvshead myhead | sed -n 's/^+ //p' | xargs -l1 git-cvsexportcommit
diff --git a/git-cvsexportcommit.txt b/git-cvsexportcommit.txt index c3922f923..3f9d2295d 100644 --- a/git-cvsexportcommit.txt +++ b/git-cvsexportcommit.txt @@ -8,7 +8,7 @@ git-cvsexportcommit - Export a single commit to a CVS checkout SYNOPSIS -------- -'git-cvsexportcommit' [-h] [-u] [-v] [-c] [-P] [-p] [-a] [-d cvsroot] [-f] [-m msgprefix] [PARENTCOMMIT] COMMITID +'git-cvsexportcommit' [-h] [-u] [-v] [-c] [-P] [-p] [-a] [-d cvsroot] [-w cvsworkdir] [-f] [-m msgprefix] [PARENTCOMMIT] COMMITID DESCRIPTION @@ -16,8 +16,9 @@ DESCRIPTION Exports a commit from GIT to a CVS checkout, making it easier to merge patches from a git repository into a CVS repository. -Execute it from the root of the CVS working copy. GIT_DIR must be defined. -See examples below. +Specify the name of a CVS checkout using the -w switch or execute it +from the root of the CVS working copy. In the latter case GIT_DIR must +be defined. See examples below. It does its best to do the safe thing, it will check that the files are unchanged and up to date in the CVS checkout, and it will not autocommit @@ -61,6 +62,11 @@ OPTIONS -u:: Update affected files from CVS repository before attempting export. +-w:: + Specify the location of the CVS checkout to use for the export. This + option does not require GIT_DIR to be set before execution if the + current directory is within a git repository. + -v:: Verbose. @@ -76,6 +82,12 @@ $ git-cvsexportcommit -v $ cvs commit -F .msg ------------ +Merge one patch into CVS (-c and -w options). The working directory is within the Git Repo:: ++ +------------ + $ git-cvsexportcommit -v -c -w ~/project_cvs_checkout +------------ + Merge pending patches into CVS automatically -- only if you really know what you are doing:: + ------------ @@ -86,11 +98,11 @@ $ git-cherry cvshead myhead | sed -n 's/^+ //p' | xargs -l1 git-cvsexportcommit Author ------ -Written by Martin Langhoff +Written by Martin Langhoff and others. Documentation -------------- -Documentation by Martin Langhoff +Documentation by Martin Langhoff and others. GIT --- diff --git a/git-format-patch.html b/git-format-patch.html index cbe28df3a..2126e9212 100644 --- a/git-format-patch.html +++ b/git-format-patch.html @@ -273,9 +273,10 @@ git-format-patch(1) Manual Page

SYNOPSIS

-
git-format-patch [-n | -k] [-o <dir> | --stdout] [--thread] +
git-format-patch [-k] [-o <dir> | --stdout] [--thread] [--attach[=<boundary>] | --inline[=<boundary>]] [-s | --signoff] [<common diff options>] + [-n | --numbered | -N | --no-numbered] [--start-number <n>] [--numbered-files] [--in-reply-to=Message-Id] [--suffix=.<sfx>] [--ignore-if-in-upstream] @@ -768,6 +769,14 @@ reference.

+-N|--no-numbered +
+
+

+ Name output in [PATCH] format. +

+
+
--start-number <n>
@@ -893,15 +902,16 @@ not add any suffix.

CONFIGURATION

-

You can specify extra mail header lines to be added to each -message in the repository configuration. You can also specify -new defaults for the subject prefix and file suffix.

+

You can specify extra mail header lines to be added to each message +in the repository configuration, new defaults for the subject prefix +and file suffix, and number patches when outputting more than one.

[format]
         headers = "Organization: git-foo\n"
         subjectprefix = CHANGE
-        suffix = .txt
+ suffix = .txt + numbered = auto

EXAMPLES

@@ -979,7 +989,7 @@ git-format-patch -3 diff --git a/git-format-patch.txt b/git-format-patch.txt index f0617efa0..9d4bae2f6 100644 --- a/git-format-patch.txt +++ b/git-format-patch.txt @@ -9,9 +9,10 @@ git-format-patch - Prepare patches for e-mail submission SYNOPSIS -------- [verse] -'git-format-patch' [-n | -k] [-o | --stdout] [--thread] +'git-format-patch' [-k] [-o | --stdout] [--thread] [--attach[=] | --inline[=]] [-s | --signoff] [] + [-n | --numbered | -N | --no-numbered] [--start-number ] [--numbered-files] [--in-reply-to=Message-Id] [--suffix=.] [--ignore-if-in-upstream] @@ -77,6 +78,9 @@ include::diff-options.txt[] -n|--numbered:: Name output in '[PATCH n/m]' format. +-N|--no-numbered:: + Name output in '[PATCH]' format. + --start-number :: Start numbering the patches at instead of 1. @@ -142,15 +146,16 @@ not add any suffix. CONFIGURATION ------------- -You can specify extra mail header lines to be added to each -message in the repository configuration. You can also specify -new defaults for the subject prefix and file suffix. +You can specify extra mail header lines to be added to each message +in the repository configuration, new defaults for the subject prefix +and file suffix, and number patches when outputting more than one. ------------ [format] headers = "Organization: git-foo\n" subjectprefix = CHANGE suffix = .txt + numbered = auto ------------ diff --git a/git-rev-list.html b/git-rev-list.html index e1664baeb..5c837a7fb 100644 --- a/git-rev-list.html +++ b/git-rev-list.html @@ -284,6 +284,7 @@ git-rev-list(1) Manual Page [ --not ] [ --all ] [ --stdin ] + [ --quiet ] [ --topo-order ] [ --parents ] [ --timestamp ] @@ -649,6 +650,18 @@ limiting may be applied.

+--quiet +
+
+

+ Don't print anything to standard output. This form of + git-rev-list is primarly meant to allow the caller to + test the exit status to see if a range of objects is fully + connected (or not). It is faster than redirecting stdout + to /dev/null as the output does not have to be formatted. +

+
+
--cherry-pick
@@ -1162,7 +1175,7 @@ and the git-list <git@vger.kernel.org>.

diff --git a/git-rev-list.txt b/git-rev-list.txt index 485280423..989fbf356 100644 --- a/git-rev-list.txt +++ b/git-rev-list.txt @@ -20,6 +20,7 @@ SYNOPSIS [ \--not ] [ \--all ] [ \--stdin ] + [ \--quiet ] [ \--topo-order ] [ \--parents ] [ \--timestamp ] @@ -270,6 +271,14 @@ limiting may be applied. In addition to the '' listed on the command line, read them from the standard input. +--quiet:: + + Don't print anything to standard output. This form of + git-rev-list is primarly meant to allow the caller to + test the exit status to see if a range of objects is fully + connected (or not). It is faster than redirecting stdout + to /dev/null as the output does not have to be formatted. + --cherry-pick:: Omit any commit that introduces the same change as diff --git a/user-manual.html b/user-manual.html index 6bd0eeb05..c1b7efdc6 100644 --- a/user-manual.html +++ b/user-manual.html @@ -553,7 +553,7 @@ mistake, you can return the entire working tree to the last committed state with

$ git reset --hard HEAD

If you make a commit that you later wish you hadn't, there are two fundamentally different ways to fix the problem:

  1. You can create a new commit that undoes whatever was done - by the previous commit. This is the correct thing if your + by the old commit. This is the correct thing if your mistake has already been made public.
  2. You can go back and modify the old commit. You should @@ -616,7 +616,7 @@ other git operations are in progress in the same repository.

Fortunately, git also keeps a log, called a "reflog", of all the previous values of each branch. So in this case you can still find the -old history using, for example,

$ git log master@{1}

This lists the commits reachable from the previous version of the branch. +old history using, for example,

$ git log master@{1}

This lists the commits reachable from the previous version of the head. This syntax can be used with any git command that accepts a commit, not just with git log. Some other examples:

$ git show master@{2}           # See where the branch pointed 2,
$ git show master@{3}           # 3, ... changes ago.
diff --git a/user-manual.txt b/user-manual.txt index 60e13853d..c7cfbbccf 100644 --- a/user-manual.txt +++ b/user-manual.txt @@ -1367,7 +1367,7 @@ If you make a commit that you later wish you hadn't, there are two fundamentally different ways to fix the problem: 1. You can create a new commit that undoes whatever was done - by the previous commit. This is the correct thing if your + by the old commit. This is the correct thing if your mistake has already been made public. 2. You can go back and modify the old commit. You should @@ -1567,7 +1567,7 @@ old history using, for example, $ git log master@{1} ------------------------------------------------- -This lists the commits reachable from the previous version of the branch. +This lists the commits reachable from the previous version of the head. This syntax can be used with any git command that accepts a commit, not just with git log. Some other examples: -- 2.26.2