Re: [PATCH v2 3/4] git-svn: Expand documentation for --follow-parent
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Dec 3, 2012, 19:30 UTC
- Message-ID
- <7vzk1vorvn.fsf@alter.siamese.dyndns.org>
- In-Reply-To
- <cf118fcd52a0cf7bdf7b08a5a52cd0e285bd056b.1354324110.git.Sebastian.Leske@sleske.name>
Sebastian Leske <Sebastian.Leske@sleske.name> writes:
Show 21 quoted lines
> Describe what the option --follow-parent does, and what happens if it is > set or unset. > > Signed-off-by: Sebastian Leske <sebastian.leske@sleske.name> > --- > Documentation/git-svn.txt | 15 ++++++++++++--- > 1 file changed, 12 insertions(+), 3 deletions(-) > > diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt > index bfa8788..6bda014 100644 > --- a/Documentation/git-svn.txt > +++ b/Documentation/git-svn.txt > @@ -628,10 +628,19 @@ ADVANCED OPTIONS > Default: "svn" > > --follow-parent:: > + This option is only relevant if we are tracking branches (using > + one of the repository layout options --trunk, --tags, > + --branches, --stdlayout). For each tracked branch, try to find > + out where its revision was copied (i.e. branched) from, and set > + a suitable parent in the first git commit for the branch.
I also commit this sin myself often, but it is a good habit to get into to re-read the sentence after writing "... X (i.e. Y)", "... V (meaning W)", "... A (in other words B)". We often write these after realizing that "... X", "... V" or "... A" is hard to understand and attempt to paraphrase to make it easier, but while doing so we unconsciously hesitate to remove what we originally wrote. The results sometimes (but not always) reads better if you do not say X, V or A and only used the rephrased version that is meant to be easier-to-read.
In this case, I think "was copied" and "was branched" alone are equally good but adding "(i.e. branched)" sounds redundant.
Show 8 quoted lines
> This is especially helpful when we're tracking a directory > - that has been moved around within the repository, or if we > - started tracking a branch and never tracked the trunk it was > - descended from. This feature is enabled by default, use > + that has been moved around within the repository. If this > + feature is disabled, the branches created by 'git svn' will all > + be linear and not share any history, meaning that there will be > + no information on where branches where branched off or merged.
I think the second "where" is a typo for "were" here.
Show 6 quoted lines
> + However, following long/convoluted histories can take a long > + time, so disabling this feature may speed up the cloning > + process. This feature is enabled by default, use > --no-follow-parent to disable it. > + > [verse]