Skip to content

Commit

Permalink
Reference to group links
Browse files Browse the repository at this point in the history
  • Loading branch information
philderbeast committed Jul 10, 2023
1 parent 6e3571d commit 5ccd316
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions doc/cabal-commands.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
Commands
========

``cabal help`` groups commands into :ref:`global<Global commands>`,
:ref:`package<Package database commands>`, :ref:`initial<Initialization and
download>`, :ref:`project<Project configuration>`, :ref:`build<Project building
and installing>`, :ref:`run<Running and testing>` and :ref:`ship<Sanity checks
and shipping>` sections.
``cabal help`` groups commands into :ref:`global<command-group-global>`,
:ref:`package<command-group-package>`, :ref:`initial<command-group-initial>`,
:ref:`project<command-group-project>`, :ref:`build<command-group-build>`,
:ref:`run<command-group-run>` and :ref:`ship<command-group-ship>` sections.

::

Expand Down Expand Up @@ -248,6 +247,8 @@ A cabal command target can take any of the following forms:
file. This is supported by ``build``, ``repl``, ``run``, and ``clean``.
Script targets are not part of a package.

.. _command-group-global:

Global commands
---------------

Expand Down Expand Up @@ -283,6 +284,7 @@ cabal preferences. It is very useful when you are e.g. first configuring
Note how ``--augment`` syntax follows ``cabal user-config diff``
output.

.. _command-group-package:

Package database commands
-------------------------
Expand Down Expand Up @@ -340,6 +342,7 @@ packages.
file, ``global`` or ``user``. The initial list is ``['global'], ['global',
'user']``, depending on context. Use ``clear`` to reset the list to empty.

.. _command-group-initial:

Initialization and download
---------------------------
Expand Down Expand Up @@ -420,6 +423,8 @@ ask for a spefic one by adding version numbers

Unpacks the pristine tarball, i.e. disregarding any Hackage revision.

.. _command-group-project:

Project configuration
---------------------

Expand Down Expand Up @@ -572,6 +577,8 @@ description file or freeze file.

See `the section on listing outdated dependency version bounds <cabal-package.html#listing-outdated-dependency-version-bounds>`__ for more details and examples.

.. _command-group-build:

Project building and installing
-------------------------------

Expand Down Expand Up @@ -759,6 +766,8 @@ artifacts for the script, which are stored under the .cabal/script-builds direct
In addition when clean is invoked it will remove all script build artifacts for
which the corresponding script no longer exists.

.. _command-group-run:

Running and testing
-------------------

Expand Down Expand Up @@ -1024,6 +1033,8 @@ cabal exec
using the project's environment. That is, passing the right flags to compiler
invocations and bringing the project's executables into scope.

.. _command-group-ship:

Sanity checks and shipping
--------------------------

Expand Down

0 comments on commit 5ccd316

Please sign in to comment.