Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify cabal check no-doc documentation #10475

Merged
merged 1 commit into from
Oct 26, 2024
Merged

Clarify cabal check no-doc documentation #10475

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion doc/cabal-commands.rst
View file
Open in desktop
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
Loading