Skip to content

Bullet points for each option help text? #12220

Description

@philderbeast

Describe the feature request
Can we add some kind of marker showing where an option help text starts? The option itself kind of does this but is often well-separated from its help text.

This would help to see where one item of help text starts, otherwise the help text looks like a column of text.

$  ~/.ghcup/bin/cabal --numeric-version
3.16.1.0

$ ~/.ghcup/bin/cabal build --help
...
 --enable-tests                 Enable dependency checking and compilation for
                                test suites listed in the package description
                                file.
 --disable-tests                Disable dependency checking and compilation
                                for test suites listed in the package
                                description file.
 --enable-coverage              Enable build package with Haskell Program
                                Coverage. (GHC only)
 --disable-coverage             Disable build package with Haskell Program
                                Coverage. (GHC only)
 --enable-library-coverage      Enable build package with Haskell Program
                                Coverage. (GHC only) (DEPRECATED)
 --disable-library-coverage     Disable build package with Haskell Program
                                Coverage. (GHC only) (DEPRECATED)
 --enable-benchmarks            Enable dependency checking and compilation for
                                benchmarks listed in the package description
                                file.
 --disable-benchmarks           Disable dependency checking and compilation
                                for benchmarks listed in the package
                                description file.
 --enable-relocatable           Enable building a package that is relocatable.
                                (GHC only)
 --disable-relocatable          Disable building a package that is
                                relocatable. (GHC only)
 --disable-response-files       enable workaround for old versions of programs
                                like "ar" that do not support @file arguments
 --allow-depending-on-private-libs
                                Allow depending on private libraries. If set,
                                the library visibility check MUST be done
                                externally.
 --coverage-for=UNITID          A list of unit-ids of libraries to include in
                                the Haskell Program Coverage report.
 --ignore-build-tools           Ignore build tool dependencies. If set,
                                declared build tools needn't be found for
                                compilation to proceed.
 --with-PROG=PATH               give the path to PROG

Something like:

 --enable-tests               - Enable dependency checking and compilation for
                                test suites listed in the package description
                                file.
 --disable-tests              - Disable dependency checking and compilation
                                for test suites listed in the package
                                description file.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions