Skip to content
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.

Sign up for GitHub

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

Jump to bottom

./configure --help has inconsistencies in style #83341

Closed
tonybaloney mannequin opened this issue Dec 30, 2019 · 4 comments
Closed

./configure --help has inconsistencies in style #83341

tonybaloney mannequin opened this issue Dec 30, 2019 · 4 comments
Labels
3.9 only security fixes build The build process and cross-build

Comments

@tonybaloney
Copy link
Mannequin

tonybaloney mannequin commented Dec 30, 2019

BPO 39160
Nosy @Yhg1s, @ned-deily, @tonybaloney, @tonybaloney
PRs
  • bpo-39160 Align the verbs, grammar and defaults for ./configure --help #17747
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
closed_at = <Date 2020-01-14.07:12:22.423>
created_at = <Date 2019-12-30.03:45:04.121>
labels = ['build', '3.9']
title = './configure --help has inconsistencies in style'
updated_at = <Date 2020-01-14.07:12:22.413>
user = 'https://github.com/tonybaloney'

    bugs.python.org fields:

    activity = <Date 2020-01-14.07:12:22.413>
actor = 'ned.deily'
assignee = 'none'
closed = True
closed_date = <Date 2020-01-14.07:12:22.423>
closer = 'ned.deily'
components = ['Build']
creation = <Date 2019-12-30.03:45:04.121>
creator = 'anthony shaw'
dependencies = []
files = []
hgrepos = []
issue_num = 39160
keywords = ['patch']
message_count = 4.0
messages = ['359014', '359015', '359016', '359948']
nosy_count = 4.0
nosy_names = ['twouters', 'ned.deily', 'anthonypjshaw', 'anthony shaw']
pr_nums = ['17747']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue39160'
versions = ['Python 3.9']
    @tonybaloney
    Copy link
    Mannequin Author

    tonybaloney mannequin commented Dec 30, 2019

    I've noticed that ./configure --help is inconsistent.

    • The way default values are shared
    • The way enumerated
    • The verbs used (e.g. enable, set)
    • Some --with-xyx and some --with(out-xyz)
    • Some start with capitals, others don't

    Also, many of the flags could use additional explanation as to their purpose, or reference the rST file in the doc that explains what they do.

    PR to follow

    @tonybaloney tonybaloney mannequin added build The build process and cross-build labels Dec 30, 2019
    @tonybaloney
    Copy link
    Mannequin Author

    tonybaloney mannequin commented Dec 30, 2019

    Current

    Optional Features:
    --disable-option-checking ignore unrecognized --enable/--with options
    --disable-FEATURE do not include FEATURE (same as --enable-FEATURE=no)
    --enable-FEATURE[=ARG] include FEATURE [ARG=yes]
    --enable-universalsdk[=SDKDIR]
    Build fat binary against Mac OS X SDK
    --enable-framework[=INSTALLDIR]
    Build (MacOSX|Darwin) framework
    --enable-shared disable/enable building shared python library
    --enable-profiling enable C-level code profiling
    --enable-optimizations Enable expensive, stable optimizations (PGO, etc).
    Disabled by default.
    --enable-loadable-sqlite-extensions
    support loadable extensions in _sqlite module
    --enable-ipv6 Enable ipv6 (with ipv4) support
    --disable-ipv6 Disable ipv6 support
    --enable-big-digits[=BITS]
    use big digits for Python longs [[BITS=30]]

    Optional Packages:
    --with-PACKAGE[=ARG] use PACKAGE [ARG=yes]
    --without-PACKAGE do not use PACKAGE (same as --with-PACKAGE=no)
    --with-universal-archs=ARCH
    select architectures for universal build ("32-bit",
    "64-bit", "3-way", "intel", "intel-32", "intel-64",
    or "all")
    --with-framework-name=FRAMEWORK
    specify an alternate name of the framework built
    with --enable-framework
    --with-cxx-main=
    compile main() and link python executable with C++
    compiler
    --with-suffix=.exe set executable suffix
    --with-pydebug build with Py_DEBUG defined
    --with-trace-refs enable tracing references for debugging purpose
    --with-assertions build with C assertions enabled
    --with-lto Enable Link Time Optimization in any build. Disabled
    by default.
    --with-hash-algorithm=[fnv|siphash24]
    select hash algorithm
    --with-address-sanitizer
    enable AddressSanitizer (asan)
    --with-memory-sanitizer enable MemorySanitizer (msan)
    --with-undefined-behavior-sanitizer
    enable UndefinedBehaviorSanitizer (ubsan)
    --with-libs='lib1 ...' link against additional libs
    --with-system-expat build pyexpat module using an installed expat
    library
    --with-system-ffi build _ctypes module using an installed ffi library
    --with-system-libmpdec build _decimal module using an installed libmpdec
    library
    --with-tcltk-includes='-I...'
    override search for Tcl and Tk include files
    --with-tcltk-libs='-L...'
    override search for Tcl and Tk libs
    --with-dbmliborder=db1:db2:...
    order to check db backends for dbm. Valid value is a
    colon separated string with the backend names
    ndbm', gdbm' and `bdb'.
    --with(out)-doc-strings disable/enable documentation strings
    --with(out)-pymalloc disable/enable specialized mallocs
    --with(out)-c-locale-coercion
    disable/enable C locale coercion to a UTF-8 based
    locale
    --with-valgrind Enable Valgrind support
    --with(out)-dtrace disable/enable DTrace support
    --with-libm=STRING math library
    --with-libc=STRING C library
    --with(out)-computed-gotos
    Use computed gotos in evaluation loop (enabled by
    default on supported compilers)
    --with(out)-ensurepip=[=upgrade]
    "install" or "upgrade" using bundled pip
    --with-openssl=DIR root of the OpenSSL directory
    --with-ssl-default-suites=[python|openssl|STRING]
    Override default cipher suites string, python: use
    Python's preferred selection (default), openssl:
    leave OpenSSL's defaults untouched, STRING: use a
    custom string, PROTOCOL_SSLv2 ignores the setting

    @tonybaloney
    Copy link
    Mannequin Author

    tonybaloney mannequin commented Dec 30, 2019

    Updated version based on principles:

    • Should not specify --with(out) in help string
    • Sentences should start with lowercase (as autoconf generates the builtin string with lower case)
    • --with-xyx=VALUE will be described as "overriding"
    • --with-xyz will be described as "enabling" said feature
    • Mac flags should have the same descriptions as what is in Mac/README.rst
    • default value should be in brackets (if known)
    • Enumerated options should be shown as =VAL1|VAL2 or [=VAL1|VAL2] if optional

    Optional Features:
    --disable-option-checking ignore unrecognized --enable/--with options
    --disable-FEATURE do not include FEATURE (same as --enable-FEATURE=no)
    --enable-FEATURE[=ARG] include FEATURE [ARG=yes]
    --enable-universalsdk[=SDKDIR]
    create a universal binary build. SDKDIR specifies
    which macOS SDK should be used to perform the build,
    see Mac/README.rst. (default is no)
    --enable-framework[=INSTALLDIR]
    create a Python.framework rather than a traditional
    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
    no)
    --enable-profiling enable C-level code profiling with gprof (default is
    no)
    --enable-optimizations enable expensive, stable optimizations (PGO, etc.)
    (default is no)
    --enable-loadable-sqlite-extensions
    support loadable extensions in _sqlite module, see
    Doc/library/sqlite3.rst (default is no)
    --enable-ipv6 enable ipv6 (with ipv4) support, see
    Doc/library/socket.rst (default is yes if supported)
    --enable-big-digits[=15|30]
    use big digits (30 or 15 bits) for Python longs
    (default is no)]

    Optional Packages:
    --with-PACKAGE[=ARG] use PACKAGE [ARG=yes]
    --without-PACKAGE do not use PACKAGE (same as --with-PACKAGE=no)
    --with-universal-archs=ARCH
    specify the kind of universal binary that should be
    created. this option is only valid when
    --enable-universalsdk is set; options are:
    ("32-bit", "64-bit", "3-way", "intel", "intel-32",
    "intel-64", or "all") see Mac/README.rst
    --with-framework-name=FRAMEWORK
    specify the name for the python framework on macOS
    only valid when --enable-framework is set. see
    Mac/README.rst (default is 'Python')
    --with-cxx-main[=COMPILER]
    compile main() and link Python executable with C++
    compiler specified in COMPILER (default is $CXX)
    --with-suffix=SUFFIX set executable suffix to SUFFIX (default is '.exe')
    --with-pydebug build with Py_DEBUG defined (default is no)
    --with-trace-refs enable tracing references for debugging purpose
    (default is no)
    --with-assertions build with C assertions enabled (default is no)
    --with-lto enable Link-Time-Optimization in any build (default
    is no)
    --with-hash-algorithm=[fnv|siphash24]
    select hash algorithm for use in Python/pyhash.c
    (default is SipHash24)
    --with-address-sanitizer
    enable AddressSanitizer memory allocation
    controller, 'asan' (default is no)
    --with-memory-sanitizer enable MemorySanitizer memory allocation controller,
    'msan' (default is no)
    --with-undefined-behavior-sanitizer
    enable UndefinedBehaviorSanitizer memory allocation
    controller, 'ubsan' (default is no)
    --with-libs='lib1 ...' link against additional libs (default is no)
    --with-system-expat build pyexpat module using an installed system expat
    library, see Doc/library/pyexpat.rst (default is no)
    --with-system-ffi build _ctypes module using an installed ffi library,
    see Doc/library/ctypes.rst (default is system
    dependant)
    --with-system-libmpdec build _decimal module using an installed libmpdec
    library, see Doc/library/decimal.rst (default is no)
    --with-tcltk-includes='-I...'
    override search for Tcl and Tk include files
    --with-tcltk-libs='-L...'
    override search for Tcl and Tk libs
    --with-dbmliborder=db1:db2:...
    override order to check db backends for dbm. valid
    value is a colon separated string with the backend
    names ndbm', gdbm' and `bdb'.
    --with-doc-strings enable documentation strings (default is yes)
    --with-pymalloc enable specialized mallocs (default is yes)
    --with-c-locale-coercion
    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)
    --with-libm=STRING override libm math library to STRING (default is
    system dependant)
    --with-libc=STRING override libc C library to STRING (default is system
    dependant)
    --with-computed-gotos enable computed gotos in evaluation loop (enabled by
    default on supported compilers)
    --with-ensurepip[=install|upgrade|no]
    "install" or "upgrade" using bundled pip (default is
    upgrade)
    --with-openssl=DIR override root of the OpenSSL directory to DIR
    --with-ssl-default-suites=[python|openssl|STRING]
    override default cipher suites string, python: use
    Python's preferred selection (default), openssl:
    leave OpenSSL's defaults untouched, STRING: use a
    custom string, PROTOCOL_SSLv2 ignores the setting,
    see Doc/library/ssl.rst

    @ned-deily
    Copy link
    Member

    New changeset 2de064e by Ned Deily (Anthony Shaw) in branch 'master':
    bpo-39160 Align the verbs, grammar and defaults for ./configure --help (GH-17747)
    2de064e

    @ned-deily ned-deily added the 3.9 only security fixes label Jan 14, 2020
    @ned-deily ned-deily added the 3.9 only security fixes label Jan 14, 2020
    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    3.9 only security fixes build The build process and cross-build
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    1 participant
    @ned-deily