Skip to content

Don't use lists in footnotes #11378

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

Merged
mergify merged 1 commit into from
Jan 9, 2026
+7 −5
Merged

Don't use lists in footnotes #11378

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
12 changes: 7 additions & 5 deletions doc/cabal-package-description-file.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3455,8 +3455,10 @@ a few options:
.. rubric:: Footnotes

.. [#old-style-build-tool-depends]
Some packages (ab)use :pkg-field:`build-depends` on old-style builds, but this has a few major drawbacks:

- using Nix-style builds it's considered an error if you depend on a exe-only package via build-depends: the solver will refuse it.
- it may or may not place the executable on ``PATH``.
- it does not ensure the correct version of the package is installed, so you might end up overwriting versions with each other.
Some packages (ab)use :pkg-field:`build-depends` on old-style builds, but
this has a few major drawbacks. First, with Nix-style builds it's considered
an error if you depend on a exe-only package via ``build-depends``: the
solver will refuse it. Next, ``build-depends`` may or may not place the
executable on ``PATH``. Finally, ``build-depends`` does not ensure the
correct version of the package is installed, so you might end up overwriting
versions with each other.
Loading