You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@subversion.apache.org by Lieven Govaerts <lg...@mobsol.be> on 2006/07/31 19:09:44 UTC
Add help text for extensions in svn 1.4
Hi,
subversion 1.4 introduced some new extensions for diff, blame and merge (-x
args). More specifically args '-b [--ignore-space-change]', '-w
[--ignore-all-space]' and '--ignore-eol-style'.
Attached patch will document these extensions for the command-line client.
The layout isn't ideal, but I think it's as good as possible. Please verify
if the text is correct.
This patch should have been in the 1.4 release, too bad I didn't find time
before RC4 was released.
regards,
Lieven.
[[[
Add the help text for the new extensions added in 1.4:
'-b [--ignore-space-change]', '-w [--ignore-all-space]' and
'--ignore-eol-style'.
* subversion/svn/main.c
(svn_cl__options): add description of the extensions.
]]]
Re: Add help text for extensions in svn 1.4
Posted by Lieven Govaerts <lg...@mobsol.be>.
Garrett Rooney wrote:
> On 7/31/06, Lieven Govaerts <lg...@mobsol.be> wrote:
>>
>>
>> [[[
>> Add the help text for the new extensions added in 1.4:
>> '-b (--ignore-space-change)', '-w (--ignore-all-space)' and
>> '--ignore-eol-style'.
>>
>> * subversion/svn/main.c
>> (svn_cl__options): add description of the extensions.
>> ]]]
>
> That seems fine to me. +1 to commit.
>
> -garrett
>
Thanks for the review!
Committed in r20926.
Lieven.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Re: Add help text for extensions in svn 1.4
Posted by Garrett Rooney <ro...@electricjellyfish.net>.
On 7/31/06, Lieven Govaerts <lg...@mobsol.be> wrote:
>
>
> > -----Original Message-----
> > From: Karl Fogel [mailto:kfogel@google.com]
> > Sent: maandag 31 juli 2006 23:20
> ..
> >
> > "If Subversion is invoking an external diff program, ARG is simply
> > passed along to the program. But if Subversion is using its
> > internal diff implementation (the default), ARG should be any of
> > the following: ..."
> >
>
> I took your IRC proposal (the one above + the change for svn blame) and
> prefixed it with "Default: '-u'".
>
> The new help text looks fine now for diff, merge & blame. (it's a lot of
> text though).
>
> Lieven.
>
> [[[
> Add the help text for the new extensions added in 1.4:
> '-b (--ignore-space-change)', '-w (--ignore-all-space)' and
> '--ignore-eol-style'.
>
> * subversion/svn/main.c
> (svn_cl__options): add description of the extensions.
> ]]]
That seems fine to me. +1 to commit.
-garrett
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
RE: Add help text for extensions in svn 1.4
Posted by Lieven Govaerts <lg...@mobsol.be>.
> -----Original Message-----
> From: Karl Fogel [mailto:kfogel@google.com]
> Sent: maandag 31 juli 2006 23:20
..
>
> "If Subversion is invoking an external diff program, ARG is simply
> passed along to the program. But if Subversion is using its
> internal diff implementation (the default), ARG should be any of
> the following: ..."
>
I took your IRC proposal (the one above + the change for svn blame) and
prefixed it with "Default: '-u'".
The new help text looks fine now for diff, merge & blame. (it's a lot of
text though).
Lieven.
[[[
Add the help text for the new extensions added in 1.4:
'-b (--ignore-space-change)', '-w (--ignore-all-space)' and
'--ignore-eol-style'.
* subversion/svn/main.c
(svn_cl__options): add description of the extensions.
]]]
Re: Add help text for extensions in svn 1.4
Posted by Karl Fogel <kf...@google.com>.
"Lieven Govaerts" <lg...@mobsol.be> writes:
> Well that seems to be the current choice for 1.4, so if you want to put this
> up for further discussion, then better be quick :)
I'll let it slide; I don't have anything better to propose off the top
of my head :-).
> Attached patch has a slightly altered first sentence. Can you check if this
> is correct? (my English isn't good enough to cram that much information in
> such a small space).
I think most users don't know what "internal diff" means out of
context, but they might understand it this way:
"If Subversion is invoking an external diff program, ARG is simply
passed along to the program. But if Subversion is using its
internal diff implementation (the default), ARG should be any of
the following: ..."
?
>> Independently of the above, I'd recommend using parens
>> instead of square brackets, since the square brackets imply
>> an optional param, not an alternate name for an option.
>
> Hm, while I can agree with you here, why are the top-level options all
> specified as '-c [--change]', -x [--extensions] arg' etc.? I don't see the
> difference.
Oh. Well, okay, IMHO those should be changed to parens too, but
obviously not as part of this change.
-Karl
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
RE: Add help text for extensions in svn 1.4
Posted by Lieven Govaerts <lg...@mobsol.be>.
> -----Original Message-----
> From: Karl Fogel [mailto:kfogel@google.com]
> I'm a bit confused by the new help text, and by the semantics
> of -x in general...
>
> When passing options through to an external diff-cmd, we
> shouldn't be interpreting the options at all -- they are
> opaque strings that we pass along to some external program
> we're firing up, end of story. So for that circumstance, the
> help text can't claim to know any of the meanings of the sub-options.
Yeah that's right. Current text doesn't show that clearly.
> When giving the user a way to change the behavior of our
> *internal* diff-cmd implementation, well, -x seems like an
> odd way to do that, but if we *are* going to use -x to do
> that, then the help text should make it clear that we're only
> talking about our internal diff implementation, Your Mileage
> May Vary, etc :-).
Well that seems to be the current choice for 1.4, so if you want to put this
up for further discussion, then better be quick :)
Attached patch has a slightly altered first sentence. Can you check if this
is correct? (my English isn't good enough to cram that much information in
such a small space).
> Independently of the above, I'd recommend using parens
> instead of square brackets, since the square brackets imply
> an optional param, not an alternate name for an option.
Hm, while I can agree with you here, why are the top-level options all
specified as '-c [--change]', -x [--extensions] arg' etc.? I don't see the
difference.
thanks for the review,
Lieven.
[[[
Add the help text for the new extensions added in 1.4:
'-b (--ignore-space-change)', '-w (--ignore-all-space)' and
'--ignore-eol-style'.
* subversion/svn/main.c
(svn_cl__options): add description of the extensions.
]]]
Re: Add help text for extensions in svn 1.4
Posted by Karl Fogel <kf...@google.com>.
"Lieven Govaerts" <lg...@mobsol.be> writes:
> subversion 1.4 introduced some new extensions for diff, blame and merge (-x
> args). More specifically args '-b [--ignore-space-change]', '-w
> [--ignore-all-space]' and '--ignore-eol-style'.
>
> Attached patch will document these extensions for the command-line client.
> The layout isn't ideal, but I think it's as good as possible. Please verify
> if the text is correct.
>
> This patch should have been in the 1.4 release, too bad I didn't find time
> before RC4 was released.
I'm a bit confused by the new help text, and by the semantics of -x in
general...
When passing options through to an external diff-cmd, we shouldn't be
interpreting the options at all -- they are opaque strings that we
pass along to some external program we're firing up, end of story. So
for that circumstance, the help text can't claim to know any of the
meanings of the sub-options.
When giving the user a way to change the behavior of our *internal*
diff-cmd implementation, well, -x seems like an odd way to do that,
but if we *are* going to use -x to do that, then the help text should
make it clear that we're only talking about our internal diff
implementation, Your Mileage May Vary, etc :-).
Independently of the above, I'd recommend using parens instead of
square brackets, since the square brackets imply an optional param,
not an alternate name for an option.
-Karl
> regards,
>
> Lieven.
>
> [[[
> Add the help text for the new extensions added in 1.4:
> '-b [--ignore-space-change]', '-w [--ignore-all-space]' and
> '--ignore-eol-style'.
>
> * subversion/svn/main.c
> (svn_cl__options): add description of the extensions.
> ]]]
>
>
> Index: subversion/svn/main.c
> ===================================================================
> --- subversion/svn/main.c (revision 20915)
> +++ subversion/svn/main.c (working copy)
> @@ -98,7 +98,25 @@
> N_("specify a password ARG")},
> #ifndef AS400
> {"extensions", 'x', 1,
> - N_("pass ARG to --diff-cmd as options (default: '-u')")},
> + N_("pass ARG to --diff-cmd as options (default: '-u')\n"
> + " "
> + " An extension argument can be one of:\n"
> + " "
> + " -u [--unified]:\n"
> + " "
> + " Output 3 lines of unified context.\n"
> + " "
> + " -b [--ignore-space-change]:\n"
> + " "
> + " Ignore changes in the amount of white space.\n"
> + " "
> + " -w [--ignore-all-space]:\n"
> + " "
> + " Ignore all white space.\n"
> + " "
> + " --ignore-eol-style:\n"
> + " "
> + " Ignore changes in EOL style")},
> #endif
> {"targets", svn_cl__targets_opt, 1,
> N_("pass contents of file ARG as additional args")},
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
> For additional commands, e-mail: dev-help@subversion.tigris.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org