Clarify documentation for bisection #17030
Comments
From @jkeenanSome dialog from irc.perl.org #p5p this evening: ##### hydahy is not the first, because I know I have had to pose this question TonyC and other frequent bisectors, please review patch attached. |
From @jkeenan0001-Clarify-documentation-for-bisect-runner.patchFrom 4b49b8bc9f3ea9cd6ecce945e254729d21ce6e28 Mon Sep 17 00:00:00 2001
From: James E Keenan <jkeenan@cpan.org>
Date: Sat, 1 Jun 2019 21:29:22 -0400
Subject: [PATCH] Clarify documentation for bisect runner.
The -D, -A and -U switches should be spelled as if you were normally
giving them to ./Configure.
---
Porting/bisect-runner.pl | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/Porting/bisect-runner.pl b/Porting/bisect-runner.pl
index 00319211c9..cdf5760b52 100755
--- a/Porting/bisect-runner.pl
+++ b/Porting/bisect-runner.pl
@@ -430,20 +430,20 @@ as exiting with a signal or a core dump.)
=item *
--D I<config_arg=value>
+-DI<config_arg=value>
=item *
--U I<config_arg>
+-UI<config_arg>
=item *
--A I<config_arg=value>
+-AI<config_arg=value>
Arguments (C<-A>, C<-D>, C<-U>) to pass to F<Configure>. For example,
- -Dnoextensions=Encode
- -Uusedevel
+ -Dnoextensions=Encode \
+ -Uusedevel \
-Accflags=-DNO_MATHOMS
Repeated C<-A> arguments are passed
--
2.17.1
|
From @jkeenanSummary of my perl5 (revision 5 version 31 subversion 0) configuration: Characteristics of this binary (from libperl): |
From @tonycozOn Sat, 01 Jun 2019 18:33:12 -0700, jkeenan@pobox.com wrote:
--D I<config_arg=value> =item * --U I<config_arg> =item * --A I<config_arg=value> bisect.pl accepts the switches both with and without the space, just as Configure does which is what it looks like you're changing here. For example, I ran: perl ../bisect.pl --start=v5.26.0 -D prefix=/home/tony/perl/bisect -e 'my $a := 2' and in the resulting config.sh: config_args='-dEs -Dcc=ccache cc -Dld=cc -Dlibpth=/lib/x86_64-linux-gnu /lib/../lib /usr/lib/x86_64-linux-gnu /usr/lib/../lib /lib /usr/lib /usr/local/lib64 /lib64 /usr/lib64 -Doptimize=-g -Dprefix=/home/tony/perl/bisect -Dusedevel' The I<config_arg> in the documentation might be ambiguous if you're not familiar with Configure (ie. that it accepts -A, -D and -U switches), but your patch doesn't change that (config_name instead, maybe?) I suspect the best change would be to include your commit message: The -D, -A and -U switches should be spelled as if you were normally which would resolve the ambiguity. I don't think the following is needed: - -Dnoextensions=Encode as those are intended as separate examples. Tony |
|
The RT System itself - Status changed from 'new' to 'open' |
From @jkeenanOn Tue, 04 Jun 2019 00:20:10 GMT, tonyc wrote:
Thanks. Pushed to blead in commit 6aed8e2. -- |
|
@jkeenan - Status changed from 'open' to 'pending release' |
From @TuxOn Sat, 01 Jun 2019 18:33:12 -0700, "James E Keenan \(via RT\)"
Not using bisectors a lot, but I fully agree with this patch -- |
Migrated from rt.perl.org#134164 (status was 'pending release')
Searchable as RT134164$
The text was updated successfully, but these errors were encountered: