Skip to content

Add glossary and disambiguate cabal vs Cabal - #10631

Draft
philderbeast wants to merge 3 commits into
haskell:masterfrom
cabalism:doc/add-glossary
Draft

Add glossary and disambiguate cabal vs Cabal#10631
philderbeast wants to merge 3 commits into
haskell:masterfrom
cabalism:doc/add-glossary

Conversation

@philderbeast

Copy link
Copy Markdown
Collaborator

Fixes #9976, by referring to glossary terms.

Warning

Very much a draft but review comments are welcome. Am I on the right track with this?

  • Patches conform to the coding conventions.
  • Is this a PR that fixes CI? If so, it will need to be backported to older cabal release branches (ask maintainers for directions).

@philderbeast
philderbeast marked this pull request as draft December 10, 2024 02:40
satisfy this requirement.

When ``cabal.project`` doesn't exist, ``cabal-install`` fabricates an ephemeral
When ``cabal.project`` doesn't exist, :term:`cabal-install:exe:cabal` fabricates an ephemeral

@geekosaur geekosaur Dec 10, 2024

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In other places, cabal-install describes the package and cabal the command.

:default: 1

Control the verbosity of ``cabal`` commands, valid values are from 0
Control the verbosity of :term:`cabal` commands, valid values are from 0

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

…this line being an example

Comment thread doc/external-commands.rst Outdated
:term:`cabal-install:exe:cabal` provides a system for external commands, akin to the ones used by tools like ``git`` or ``cargo``.

If you execute ``cabal <cmd>``, ``cabal-install`` will search the path for an executable named ``cabal-<cmd>`` and execute it. The name of the command is passed as the first argument and
If you execute ``cabal <cmd>``, :term:`cabal-install:exe:cabal` will search the path for an executable named ``cabal-<cmd>`` and execute it. The name of the command is passed as the first argument and

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mmm, and here's a third one for the same thing. Consistency would be nice.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Disambiguate docs, cabal versus Cabal

2 participants