Skip to content

Commit

Permalink
source-repository versus source-repository-package
Browse files Browse the repository at this point in the history
- Adds pijul as type
- explicit dot is the same as root
  • Loading branch information
philderbeast committed Feb 8, 2024
1 parent 0e66a4b commit d63e3d8
Showing 1 changed file with 39 additions and 5 deletions.
44 changes: 39 additions & 5 deletions doc/cabal-package-description-file.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2671,8 +2671,42 @@ Source Repositories
.. pkg-section:: source-repository
:since: 1.6

It is often useful to be able to specify a source revision control
repository for a package. Cabal lets you specify this information in
.. warning::

A ``source-repository`` is for a version of the source of its package
whereas each ``source-repository-package`` is for one or more source
dependencies of a project. The fields of each are much the same.

.. list-table::
:header-rows: 1
:widths: 30 30 40

* - Field Name
- source-repository (head|this)
- source-repository-package
* - type
- 🗹
- 🗹
* - location
- 🗹
- 🗹
* - branch
- 🗹
- 🗹
* - tag
- 🗹
- 🗹
* - subdir
- 🗹 (0 or 1)
- 🗹 (0 or 1 for each dependency)
* - module (CVS only)
- 🗹
- ☐
* - post-checkout-command
- ☐
- 🗹

Cabal lets you specify source repositories for a package in
a relatively structured form which enables other tools to interpret and
make effective use of the information. For example the information
should be sufficient for an automatic tool to checkout the sources.
Expand Down Expand Up @@ -2729,6 +2763,7 @@ The exact fields are as follows:
- ``bazaar`` (or alias ``bzr``)
- ``arch``
- ``monotone``
- ``pijul``

This field is required.

Expand Down Expand Up @@ -2778,9 +2813,8 @@ The exact fields are as follows:
package, i.e. the directory containing the package's ``.cabal``
file.

This field is optional. It defaults to empty which corresponds to the
root directory of the repository.

This field is optional. It defaults to empty which corresponds to the root
directory of the repository and is the same as specifying ``.`` explicitly.

Custom setup scripts
--------------------
Expand Down

0 comments on commit d63e3d8

Please sign in to comment.