Add a glossary

haskell · Dec 10, 2024 · 5fdc1d5 · 5fdc1d5
1 parent 949464d
commit 5fdc1d5
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/doc/glossary.rst b/doc/glossary.rst
@@ -0,0 +1,22 @@
+.. _glossary:
+
+Glossary
+========
+
+.. glossary::
+
+   Cabal
+      The Common Architecture for Building Applications and Libraries. Also a
+      library of the same name.
+
+   cabal
+     The command line tool, ``cabal-install:exe:cabal``, the executable named
+     ``cabal`` from the ``cabal-install`` package.
+
+   cabal-install:exe:cabal
+     A more explicit way to refer to the ``cabal`` command line tool.
+
+   cabal-install
+     The package that provides the ``cabal`` command line tool. Also,
+     confusingly, people will say ``cabal-install`` when they want to
+     disambiguate between ``cabal`` the tool and ``Cabal`` the library.
diff --git a/doc/index.rst b/doc/index.rst
@@ -43,3 +43,4 @@ Welcome to the Cabal User Guide
    cabal-context
    package-concepts
    cabal-interface-stability
+   glossary