Skip to content

Inconsistent --help output formatting #5377

Open
@quasicomputational

Description

@quasicomputational
$ cabal build --help
Compile all/specific components.

Usage: cabal build [FLAGS]
   or: cabal build COMPONENTS [FLAGS]

Components encompass executables, tests, and benchmarks.

Affected by configuration options, see `configure`.

Flags for build:
 -h --help              Show this help text
 -v --verbose[=n]       Control verbosity (n is 0--3, default verbosity level
                        is 1)
    --builddir=DIR      The directory where Cabal puts generated build files
                        (default dist)
 -j --jobs[=NUM]        Run NUM jobs simultaneously (or '$ncpus' if no NUM is
                        given).
    --with-PROG=PATH    give the path to PROG
    --PROG-option=OPT   give an extra option to PROG (no need to quote options
                        containing spaces)
    --PROG-options=OPTS give extra options to PROG
    --only              Don't reinstall add-source dependencies (sandbox-only)

Examples:
  cabal build               All the components in the package
  cabal build foo           A component (i.e. lib, exe, test suite)

The flags --with-PROG and --PROG-option(s) can be used with the following programs:
  alex ar c2hs cpphs doctest gcc ghc ghc-pkg ghcjs ghcjs-pkg greencard haddock
  happy haskell-suite haskell-suite-pkg hmake hpc hsc2hs hscolour jhc ld lhc
  lhc-pkg pkg-config runghc strip tar uhc

Note that in one place we're using backquotes and in another we're using straight quotes and some things that could be quoted aren't quoted at all. We should probably be consistent and polished with this.

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