From 1877a0ea9c952147518fc6bbfa03ae79c4d2ea88 Mon Sep 17 00:00:00 2001 From: Francesco Ariis Date: Thu, 24 Oct 2024 19:02:34 +0200 Subject: [PATCH] Clarify cabal check `no-doc` documentation Make clear what is the heuristic we use to find changelogs files. --- doc/cabal-commands.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/cabal-commands.rst b/doc/cabal-commands.rst index c1987afbfd8..60795c4d7f6 100644 --- a/doc/cabal-commands.rst +++ b/doc/cabal-commands.rst @@ -1413,7 +1413,10 @@ A list of all warnings with their constructor: - ``missing-conf-script``: missing ``configure`` script with ``build-type: Configure``. - ``unknown-directory``: paths refer to a directory which does not exist. - ``no-repository``: missing ``source-repository`` section. -- ``no-docs``: missing expected documentation files (changelog). +- ``no-docs``: missing expected documentation files. Checks + whether there is anything similar to a changelog file in your working + directory (e.g. ``CHANGELOG``, ``NEWS``, ``changelog.md``, etc.). If this + file is not present in the :pkg-field:`extra-doc-files` field, warns about it. - ``doc-place``: documentation files listed in ``extra-source-files`` instead of ``extra-doc-files``. .. _cabal-sdist: