Document what dune-project (name) does

See discussion in ocaml#1532
brendanlong · Nov 16, 2018 · f0e412d · f0e412d
1 parent df0778c
commit f0e412d
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/doc/project-layout-specification.rst b/doc/project-layout-specification.rst
@@ -182,7 +182,8 @@ Additionally, they can contains the following stanzas.
 name
 ----
 
-Sets the name of the project:
+Sets the name of the project. This is used by :ref:`dune subst <dune-subst>`
+and error messages.
 
 .. code:: scheme
 

diff --git a/doc/usage.rst b/doc/usage.rst
@@ -521,6 +521,8 @@ publishing releases. However they might still want to substitute the
 watermarks when the package is pinned by the user. To help with this,
 dune provides the ``subst`` sub-command.
 
+.. _dune-subst
+
 dune subst
 ==========