-
-
Notifications
You must be signed in to change notification settings - Fork 32.3k
bpo-39160 Align the verbs, grammar and defaults for ./configure --help
#17747
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Also requesting review from @Yhg1s (if the expert index is up to date). Although this doesn't change any behaviours in autoconf |
Unix install. optional INSTALLDIR specifies the | ||
installation path. see Mac/README.rst (default is | ||
no) | ||
--enable-shared enable building a shared Python library (default is |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As a follow on. This needs more documentation somewhere, it's only referenced in the release notes
enable C locale coercion to a UTF-8 based locale | ||
(default is yes) | ||
--with-valgrind enable Valgrind support (default is no) | ||
--with-dtrace enable DTrace support (default is no) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the dtrace support also needs documenting somewhere, it's a really useful feature when you know how to use it. It's not mentioned in the profiling section of docs
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
I have made the requested changes; please review again |
Thanks for making the requested changes! @Yhg1s: please review the changes made to this pull request. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ned-deily should review the framework help strings, since I don't know much about that.
AS_HELP_STRING([--with-cxx-main=<compiler>], | ||
[compile main() and link python executable with C++ compiler]), | ||
AS_HELP_STRING([--with-cxx-main@<:@=COMPILER@:>@], | ||
[compile main() and link Python executable with C++ compiler specified in COMPILER (default is $CXX)]), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a little misleading: the default is not to link with CXX at all, although the default value when passing --with-cxx-main
is indeed CXX. (As an aside, I don't think this option is useful anymore; I believe it was only necessary with gcc 2.95, perhaps only on some platforms.)
thanks, @Yhg1s, the framework help strings are copied from |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me. It's a nice improvement, thanks! I'm going to merge the PR as it stands. If you want to follow up on the suggestions for additional changes, let's open another PR for that.
Updated version based on principles:
--with(out)-xyz
in help string, it's implied by default--with-xyx=VALUE
will be described as "overriding"--with-xyz
will be described as "enabling" said featurehttps://bugs.python.org/issue39160