From: Johannes Schindelin <Johannes.Schindelin@gmx.de>
To: Frank Lichtenheld <frank@lichtenheld.de>
Cc: git@vger.kernel.org, gitster@pobox.com
Subject: [PATCH] filter-branch: a few more touch ups to the man page
Date: Wed, 4 Jul 2007 15:50:45 +0100 (BST) [thread overview]
Message-ID: <Pine.LNX.4.64.0707041546510.4071@racer.site> (raw)
In-Reply-To: <20070704112900.GO12721@planck.djpig.de>
All based on comments from Frank Lichtenheld.
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
---
On Wed, 4 Jul 2007, Frank Lichtenheld wrote:
> On Wed, Jul 04, 2007 at 12:17:05AM +0100, Johannes Schindelin wrote:
> >
> > On Wed, 4 Jul 2007, Frank Lichtenheld wrote:
> >
> > > General note: All the stuff in all uppercase should probably
> > > also have some asciidoc emphasis.
>
> [...] it is used at least in the case of WARNING as a means of
> emphasis and this should be reflected in the end result as
> markup. So I still suggest changing it to *WARNING* or even
> *Warning* if you don't want to double the emphasis.
>
> > Also, GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, GIT_AUTHOR_DATE,
> > GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL, and
> > GIT_COMMITTER_DATE is set according to the current commit.
>
> "are" set. And yeah, it doesn't look pretty. I still prefer
> having the list somewhere in the text, though.
>
> > > > + Only regard the history, as seen by the given [...]
> > > ^^^
> > > Does this comma belong there?
> >
> > This is my bad English. What I meant was this:
> >
> > Only ever look at the history, which touches the given
> > subdirectory. The result will contain that directory as its
> > project root.
>
> I'm still not sure there should be a comma in this sentence, but
> my English grammar is a bit rusty.
Better?
Documentation/git-filter-branch.txt | 11 ++++++-----
1 files changed, 6 insertions(+), 5 deletions(-)
diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt
index 2074f31..363287d 100644
--- a/Documentation/git-filter-branch.txt
+++ b/Documentation/git-filter-branch.txt
@@ -31,7 +31,7 @@ branch as your current branch. Nevertheless, this may be useful in
the future for compensating for some git bugs or such, therefore
such a usage is permitted.
-WARNING! The rewritten history will have different object names for all
+*WARNING*! The rewritten history will have different object names for all
the objects and will not converge with the original branch. You will not
be able to easily push and distribute the rewritten branch on top of the
original branch. Please do not use this command if you do not know the
@@ -54,7 +54,7 @@ argument is always evaluated in shell using the 'eval' command.
Prior to that, the $GIT_COMMIT environment variable will be set to contain
the id of the commit being rewritten. Also, GIT_AUTHOR_NAME,
GIT_AUTHOR_EMAIL, GIT_AUTHOR_DATE, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL,
-and GIT_COMMITTER_DATE is set according to the current commit.
+and GIT_COMMITTER_DATE are set according to the current commit.
A 'map' function is available that takes an "original sha1 id" argument
and outputs a "rewritten sha1 id" if the commit has been already
@@ -78,7 +78,7 @@ OPTIONS
directory set to the root of the checked out tree. The new tree
is then used as-is (new files are auto-added, disappeared files
are auto-removed - neither .gitignore files nor any other ignore
- rules HAVE ANY EFFECT!).
+ rules *HAVE ANY EFFECT*!).
--index-filter <command>::
This is the filter for rewriting the index. It is similar to the
@@ -128,8 +128,9 @@ attached, the rewritten tag won't have it. Sorry. (It is by
definition impossible to preserve signatures at any rate.)
--subdirectory-filter <directory>::
- Only ever look at the history, which touches the given subdirectory.
- The result will contain that directory as its project root.
+ Only look at the history which touches the given subdirectory.
+ The result will contain that directory (and only that) as its
+ project root.
-d <directory>::
Use this option to set the path to the temporary directory used for
--
1.5.3.rc0.2663.gfbb70
next prev parent reply other threads:[~2007-07-04 14:50 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2007-07-03 16:47 [PATCH] Document git-filter-branch Johannes Schindelin
2007-07-03 22:05 ` Frank Lichtenheld
2007-07-03 23:17 ` Johannes Schindelin
2007-07-04 11:29 ` Frank Lichtenheld
2007-07-04 14:50 ` Johannes Schindelin [this message]
2007-07-04 15:06 ` [PATCH] filter-branch: a few more touch ups to the man page Frank Lichtenheld
2007-07-11 16:53 ` [PATCH] Document git-filter-branch Jakub Narebski
2007-07-11 17:03 ` Johannes Schindelin
2007-07-03 23:41 ` Johannes Schindelin
2007-07-04 7:32 ` [PATCH] filter-branch documentation: some more touch-ups Johannes Sixt
2007-07-04 10:58 ` Johannes Schindelin
2007-07-04 16:56 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=Pine.LNX.4.64.0707041546510.4071@racer.site \
--to=johannes.schindelin@gmx.de \
--cc=frank@lichtenheld.de \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).