Skip to content

Commit db474d1

Browse files
ffaf1Mikolaj
authored andcommitted
Clarify cabal check no-doc documentation
Make clear what is the heuristic we use to find changelogs files.
1 parent 9c499b1 commit db474d1

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

doc/cabal-commands.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1413,7 +1413,10 @@ A list of all warnings with their constructor:
14131413
- ``missing-conf-script``: missing ``configure`` script with ``build-type: Configure``.
14141414
- ``unknown-directory``: paths refer to a directory which does not exist.
14151415
- ``no-repository``: missing ``source-repository`` section.
1416-
- ``no-docs``: missing expected documentation files (changelog).
1416+
- ``no-docs``: missing expected documentation files. Checks
1417+
whether there is anything similar to a changelog file in your working
1418+
directory (e.g. ``CHANGELOG``, ``NEWS``, ``changelog.md``, etc.). If this
1419+
file is not present in the :pkg-field:`extra-doc-files` field, warns about it.
14171420
- ``doc-place``: documentation files listed in ``extra-source-files`` instead of ``extra-doc-files``.
14181421

14191422
.. _cabal-sdist:

0 commit comments

Comments
 (0)