Skip to content

Commit

Permalink
Clarify cabal check no-doc documentation
Browse files Browse the repository at this point in the history
Make clear what is the heuristic we use to find changelogs files.
  • Loading branch information
ffaf1 authored and Mikolaj committed Oct 26, 2024
1 parent 9c499b1 commit db474d1
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion doc/cabal-commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit db474d1

Please sign in to comment.