Skip to content

Doc: link to "command line version of constraint field" leads nowhere reasonable #7803

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
Closed
andreasabel opened this issue Nov 8, 2021 · 0 comments · Fixed by #7902
Closed

Doc: link to "command line version of constraint field" leads nowhere reasonable #7803

andreasabel opened this issue Nov 8, 2021 · 0 comments · Fixed by #7902
Labels
documentation re: constraint Concerning the constraint syntax, field, and command-line option type: bug

Comments

@andreasabel
Copy link
Member

andreasabel commented Nov 8, 2021 •
edited
Loading

See

cabal/doc/cabal-project.rst

Lines 325 to 327 in 5b4258c

Valid constraints take the same form as for the `constraint
command line option
<installing-packages.html#cmdoption-setup-configure-constraint>`__. 

.. cfg-field:: constraints: constraints list (comma separated)
               --constraint="pkg >= 2.0", -c "pkg >= 2.0"
    :synopsis: Extra dependencies constraints.

    Add extra constraints to the version bounds, flag settings,
    and other properties a solver can pick for a
    package. 

    ...

    Valid constraints take the same form as for the `constraint
    command line option
    <installing-packages.html#cmdoption-setup-configure-constraint>`__.

The command option --constraint seems to be documented above, I suppose the link dates from more ancient version of the documentation!?
@andreasabel andreasabel mentioned this issue Nov 8, 2021
Open
@andreasabel andreasabel added documentation re: constraint Concerning the constraint syntax, field, and command-line option labels Nov 8, 2021
andreasabel added a commit to andreasabel/cabal that referenced this issue Nov 8, 2021
@andreasabel
Fix haskell#7803: doc: replace broken link to --constraint doc by s.t…
8c3c9c7 
…h. reasonable
@andreasabel andreasabel mentioned this issue Nov 8, 2021
Closed
andreasabel added a commit that referenced this issue Jan 12, 2022
@andreasabel
Fix #7712 fix #7803: do not link to other .rst file by .html links an…
cfc3aa1 
…ymore

Links to .html files are not checked by sphinx and thus bit-rot.
Rather, link by :ref:, :doc:, :option: etc.

This commit does not address the links of the form

  ../release/cabal-latest/doc/API/**.html

which I do not know how to handle.  These are all broken on
readthedocs.org and I have no clue how these were supposed to work.
@andreasabel andreasabel mentioned this issue Jan 12, 2022
Merged
jneira pushed a commit that referenced this issue Jan 13, 2022
@andreasabel
Fix #7712 fix #7803: do not link to other .rst file by .html links an…
1d0105d 
…ymore

Links to .html files are not checked by sphinx and thus bit-rot.
Rather, link by :ref:, :doc:, :option: etc.

This commit does not address the links of the form

  ../release/cabal-latest/doc/API/**.html

which I do not know how to handle.  These are all broken on
readthedocs.org and I have no clue how these were supposed to work.
@mergify mergify bot closed this as completed in #7902 Jan 13, 2022
mergify bot added a commit that referenced this issue Jan 13, 2022
@mergify
Merge pull request #7902 from haskell/doc-html-links-issue-7712
a7f5d24 
Fix #7712 fix #7803: do not link to other .rst files by .html links
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation re: constraint Concerning the constraint syntax, field, and command-line option type: bug
Projects
None yet
Milestone
No milestone
2 participants
@jneira @andreasabel