Skip to content

docs: explicitly list programs known to Cabal (fix #7899) #11141

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

Merged
merged 1 commit into from
Aug 11, 2025
Merged

docs: explicitly list programs known to Cabal (fix #7899) #11141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Cabal/src/Distribution/Simple/Program/Builtin.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,9 @@ import qualified Data.Map as Map

-- ------------------------------------------------------------

-- NOTE: if you modify the list of builtin programs below, also update documentation in
-- the Cabal manual: option `--with-PROG` described in doc/setup-commands.rst

-- | The default list of programs.
-- These programs are typically used internally to Cabal.
builtinPrograms :: [Program]
Expand Down
7 changes: 5 additions & 2 deletions doc/setup-commands.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,8 +201,11 @@ files of a package:
name of a program that can be found on the program search path. For
example: ``--with-ghc=ghc-6.6.1`` or
``--with-cpphs=/usr/local/bin/cpphs``. The full list of accepted
programs is not enumerated in this user guide. Rather, run
``cabal install --help`` to view the list.
programs is as follows:
``alex``, ``ar``, ``c2hs``, ``cpphs``, ``doctest``, ``gcc``, ``ghc``,
``ghc-pkg``, ``ghcjs``, ``ghcjs-pkg``, ``haddock``, ``happy``,
``hpc``, ``hsc2hs``, ``hscolour``, ``jhc``, ``ld``, ``pkg-config``,
``runghc``, ``strip``, ``tar``, ``uhc``.

.. option:: --PROG-options=OPTS

Expand Down
Loading