Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions doc/reference/config/project_defaults.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ of the :doc:`../dune-project/index` file when initializing a project with

``<optional-fields>`` are:

.. describe:: (authors <string(s)>)
.. confval:: (authors <string(s)>)

Specify authors.

Expand All @@ -27,7 +27,7 @@ of the :doc:`../dune-project/index` file when initializing a project with
"Jane Doe <[email protected]>"
"John Doe <[email protected]>"))

.. describe:: (maintainers <string(s)>)
.. confval:: (maintainers <string(s)>)

Specify maintainers.

Expand All @@ -40,7 +40,7 @@ of the :doc:`../dune-project/index` file when initializing a project with
"Jane Doe <[email protected]>"
"John Doe <[email protected]>"))

.. describe:: (license <string(s)>)
.. confval:: (license <string(s)>)

Specify license, ideally as an identifier from the `SPDX License List
<https://spdx.org/licenses/>`__.
Expand Down
16 changes: 8 additions & 8 deletions doc/reference/dune-project/dialect.rst
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
dialect
-------

.. describe:: (dialect ...)
.. confval:: (dialect ...)

Declare a new :term:`dialect`.

.. describe:: (name <name>)
.. confval:: (name <name>)

The name of the dialect being defined. It must be unique in a given
project.

This field is required.

.. describe:: (implementation ...)
.. confval:: (implementation ...)

Details related to the implementation files (corresponding to `*.ml`).

.. versionchanged:: 3.9 This field is made optional.

.. describe:: (extension <string>)
.. confval:: (extension <string>)

Specify the file extension used for this dialect.

Expand All @@ -29,7 +29,7 @@ dialect

This field is required.

.. describe:: (preprocess <action>)
.. confval:: (preprocess <action>)

Run `<action>` to produce a valid OCaml abstract syntax tree.

Expand All @@ -43,7 +43,7 @@ dialect

.. seealso:: :ref:`preprocessing-actions`

.. describe:: (format <action>)
.. confval:: (format <action>)

Run `<action>` to format source code for this dialect.

Expand All @@ -58,15 +58,15 @@ dialect

.. seealso:: :doc:`/howto/formatting`

.. describe:: (interface ...)
.. confval:: (interface ...)

Details related to the interface files (corresponding to `*.mli`).

This field supports the same sub-fields as ``implementation``.

.. versionchanged:: 3.9 This field is made optional.

.. describe:: (merlin_reader <program> <args>...)
.. confval:: (merlin_reader <program> <args>...)

Configure Merlin to use `<program> <args>...` as READER. Merlin's READER
is a mechanism to extend Merlin to support OCaml dialects by providing
Expand Down
36 changes: 18 additions & 18 deletions doc/reference/dune-project/package.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,104 +4,104 @@ package
This stanza is used to specify package metadata. In particular, this information
is used when generating OPAM files (see :doc:`generate_opam_files`).

.. describe:: (package ...)
.. confval:: (package ...)

Define package-specific metadata.

.. describe:: (name <string>)
.. confval:: (name <string>)

The name of the package.

This must be specified.

.. describe:: (synopsis <string>)
.. confval:: (synopsis <string>)

A short package description.

.. describe:: (description <string>)
.. confval:: (description <string>)

A longer package description.

.. describe:: (depends <dep-specification>)
.. confval:: (depends <dep-specification>)

Package dependencies, as :token:`~pkg-dep:dep_specification`.

.. describe:: (conflicts <dep-specification>)
.. confval:: (conflicts <dep-specification>)

Package conflicts, as :token:`~pkg-dep:dep_specification`.

.. describe:: (depopts <dep-specification>)
.. confval:: (depopts <dep-specification>)

Optional package dependencies, as :token:`~pkg-dep:dep_specification`.

.. describe:: (tags <tags>)
.. confval:: (tags <tags>)

A list of tags.

.. describe:: (deprecated_package_names <name list>)
.. confval:: (deprecated_package_names <name list>)

A list of names that can be used with the
:doc:`../dune/deprecated_library_name` stanza to migrate legacy libraries
from other build systems that do not follow Dune's convention of
prefixing the library's public name with the package name.

.. describe:: (license ...)
.. confval:: (license ...)

.. versionadded:: 2.0

The same as (and takes precedences over) the corresponding global field
(see :doc:`license`).

.. describe:: (authors ...)
.. confval:: (authors ...)

.. versionadded:: 2.0

The same as (and takes precedences over) the corresponding global field
(see :doc:`authors`).

.. describe:: (maintainers ...)
.. confval:: (maintainers ...)

.. versionadded:: 2.0

The same as (and takes precedences over) the corresponding global field
(see :doc:`maintainers`).

.. describe:: (maintenance_intent ...)
.. confval:: (maintenance_intent ...)

.. versionadded:: 3.18

The same as (and takes precedences over) the corresponding global field
(see :doc:`maintenance_intent`).

.. describe:: (source ...)
.. confval:: (source ...)

.. versionadded:: 2.0

The same as (and takes precedences over) the corresponding global field
(see :doc:`source`).

.. describe:: (bug_reports ...)
.. confval:: (bug_reports ...)

.. versionadded:: 2.0

The same as (and takes precedences over) the corresponding global field
(see :doc:`bug_reports`).

.. describe:: (homepage ...)
.. confval:: (homepage ...)

.. versionadded:: 2.0

The same as (and takes precedences over) the corresponding global field
(see :doc:`homepage`).

.. describe:: (documentation ...)
.. confval:: (documentation ...)

.. versionadded:: 2.0

The same as (and takes precedences over) the corresponding global field
(see :doc:`documentation`).

.. describe:: (sites ...)
.. confval:: (sites ...)

Define a site.

Expand Down
10 changes: 5 additions & 5 deletions doc/reference/dune-project/pin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ Pins are package overrides used in the context of package management. They
allow to fix a package at a specific version which is not affected by the
package repositories selected.

.. describe:: (pin ...)
.. confval:: (pin ...)

.. versionadded:: 3.14

Define a package override.

.. describe:: (url <string>)
.. confval:: (url <string>)

The URL of the package source.

Expand All @@ -29,19 +29,19 @@ package repositories selected.

This must be specified.

.. describe:: (package ...)
.. confval:: (package ...)

Defines which package is to be pinned.

This must be specified.

.. describe:: (name <string>)
.. confval:: (name <string>)

The name of the package.

This must be specified.

.. describe:: (version <string>)
.. confval:: (version <string>)

The version that the package should be assumed to be. Defaults to
``dev`` if unspecified.
Expand Down
18 changes: 9 additions & 9 deletions doc/reference/dune-workspace/lock_dir.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,18 @@ This stanza configures the lock directory settings for the current workspace.
For the default workflow no configuration is necessary, but the defaults can be
changed if desired.

.. describe:: (lock_dir ...)
.. confval:: (lock_dir ...)

.. versionadded:: 3.13

Configures a specific lock directory to be created or used.

.. describe:: (path <string>)
.. confval:: (path <string>)

The location in the source tree where the lock directory will be
created or read from. If not specified defaults to ``dune.lock``.

.. describe:: (repositories <name list>)
.. confval:: (repositories <name list>)

The repositories to be used for finding a package solution, specified
in priority order. Supports ``:standard`` which contains ``upstream`` and
Expand All @@ -30,28 +30,28 @@ changed if desired.
Additional repositories can be defined using the
:doc:`/reference/dune-workspace/repository` stanza.

.. describe:: (solver_env ...)
.. confval:: (solver_env ...)

The environment that is injected into the solver when creating the lock
directory.

It consists of a sequence of ``(<name> <value>)`` pairs.

.. describe:: (unset_variables <name list>)
.. confval:: (unset_variables <name list>)

A list of variables that are used in solving that are deliberately unset
even if the solver could provide bindings for them.

The variables here cannot overlap with those defined in ``solver_env``.

.. describe:: (pins <name list>)
.. confval:: (pins <name list>)

.. versionadded:: 3.15

Define which pins are enabled for this particular lock dir. See
:doc:`/reference/dune-workspace/pin` for details on how to define pins.

.. describe:: (version_preference <string>)
.. confval:: (version_preference <string>)

Can be one of:

Expand All @@ -60,7 +60,7 @@ changed if desired.
- ``oldest``: The solver will pick the lowest version that will satisfy
the constraints

.. describe:: (constraints <dep-specification>)
.. confval:: (constraints <dep-specification>)

Adds additional solver constraints that are passed to the solver. Follows
the :token:`~pkg-dep:dep_specification` format.
Expand All @@ -72,7 +72,7 @@ changed if desired.
additional constraints if the packages to which the constraint is
applied are selected and don't do anything otherwise.

.. describe:: (depopts <name list>)
.. confval:: (depopts <name list>)

.. versionadded:: 3.19

Expand Down
12 changes: 6 additions & 6 deletions doc/reference/dune-workspace/pin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,20 @@ project and used for building dependencies.
Defining a pin does not enable it by default. It needs to be enabled in a
lock directory using the :doc:`/reference/dune-workspace/lock_dir` stanza.

.. describe:: (pin ...)
.. confval:: (pin ...)

.. versionadded:: 3.15

Defines a new package source.

.. describe:: (name <string>)
.. confval:: (name <string>)

The name of the newly defined pin. This can be anything, it does not
have to match the package.

This must be specified.

.. describe:: (url <string>)
.. confval:: (url <string>)

This can be a path to a directory on the local file system or remote Git
repository. Local paths can be absolute or relative, and may optionally
Expand All @@ -38,17 +38,17 @@ project and used for building dependencies.

This must be specified.

.. describe:: (package ...)
.. confval:: (package ...)

Specifies the the packages to assign this pin to.

.. describe:: (name <string>)
.. confval:: (name <string>)

The name of the package.

This must be specified.

.. describe:: (version <string>)
.. confval:: (version <string>)

The version that the package should be assumed to be. Defaults to
``dev`` if unspecified.
Expand Down
6 changes: 3 additions & 3 deletions doc/reference/dune-workspace/repository.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,19 @@ location to it.
enabled in a lock directory using the :doc:`/reference/dune-workspace/lock_dir`
stanza.

.. describe:: (repository ...)
.. confval:: (repository ...)

.. versionadded:: 3.12

Defines a named package repository.

.. describe:: (name <string>)
.. confval:: (name <string>)

The name used to refer to the repository. Names have to be unique.

This must be specified.

.. describe:: (url <string>)
.. confval:: (url <string>)

The location from which the repository will be loaded.

Expand Down
Loading
Loading