Commit 2b668ff1 authored by Oleg Grenrus's avatar Oleg Grenrus Committed by GitHub

Merge pull request #6953 from jhrcek/fix-broken-links-in-docs

Fix broken links in documentation
parents 0205fd25 7699644b
......@@ -2123,7 +2123,7 @@ system-dependent values for these fields.
developer documentation for more details on frameworks. This entry
is ignored on all other platforms.
.. pkg-field:: extra-frameworks-dirs: directory list
.. pkg-field:: extra-framework-dirs: directory list
:since: 1.24
On Darwin/MacOS X, a list of directories to search for frameworks.
......@@ -2571,6 +2571,8 @@ a conditional and outside then they are combined using the following rules.
else
Main-is: Main.hs
.. _common-stanzas:
Common stanzas
^^^^^^^^^^^^^^
......
......@@ -119,7 +119,7 @@ format:
``{vendor,pkgs}/*.cabal`` matches all Cabal files in the ``vendor``
and ``pkgs`` subdirectories.
Formally, the format described by the following BNF:
Formally, the format is described by the following BNF:
.. todo::
convert globbing grammar to proper ABNF_ syntax
......
......@@ -209,7 +209,7 @@ your libraries and executable sections. For example:
Proglet
Note that the ``import`` **must** be the first thing in the stanza. For more
information see the `Common stanzas`_ section.
information see the :ref:`common-stanzas` section.
Building the package
--------------------
......@@ -300,7 +300,7 @@ of digits such as "1.0.1" or "2.0". There are a range of common
conventions for "versioning" packages, that is giving some meaning to
the version number in terms of changes in the package, such as
e.g. `SemVer <http://semver.org>`__; however, for packages intended to be
distributed via Hackage Haskell's `Package Versioning Policy`_ applies
distributed via Hackage Haskell's `Package Versioning Policy <https://pvp.haskell.org/>`_ applies
(see also the `PVP/SemVer FAQ section <https://pvp.haskell.org/faq/#semver>`__).
The combination of package name and version is called the *package ID*
......
......@@ -67,7 +67,7 @@ relative to the respective preceding *published* version.
import foo-deps
* Allow redundant leading or trailing commas in package fields with
optional commas, such as :pkg-field:`exposed-modules`
optional commas, such as :pkg-field:`library:exposed-modules`
* Require fields with optional commas to consistently omit or place
commas between elements.
......
......@@ -235,12 +235,13 @@ Installing packages from Hackage
--------------------------------
The ``cabal`` tool also can download, configure, build and install a
Hackage_ package and all of its
`Hackage`_ package and all of its
dependencies in a single step. To do this, run:
::
$ cabal install [PACKAGE...]
To browse the list of available packages, visit the
Hackage_ web site.
To browse the list of available packages, visit the `Hackage`_ web site.
.. _Hackage: https://hackage.haskell.org/
\ No newline at end of file
Nix-style Local Builds
======================
.. _nix-style-builds
.. _nix-style-builds:
Nix-style local builds are a new build system implementation inspired by Nix.
The Nix-style local build system is commonly called "v2-build" for short
......
......@@ -34,7 +34,7 @@ results to some permanent place and registers the package with GHC.
.. note ::
Global installing of packages is not recommended.
The :ref:`_nix-style-builds` is the preferred of building and installing
The :ref:`Nix-style builds<nix-style-builds>` is the preferred way of building and installing
packages.
Creating a binary package
......@@ -1002,7 +1002,7 @@ Miscellaneous options
(:pkg-field:`build-depends`), build dependencies of build
dependencies, and so on. Constraints normally do not apply to
dependencies of the ``Setup.hs`` script of any package
(:pkg-field:`setup-depends`) nor do they apply to build tools
(:pkg-field:`custom-setup:setup-depends`) nor do they apply to build tools
(:pkg-field:`build-tool-depends`) or the dependencies of build
tools. To explicitly apply a constraint to a setup or build
tool dependency, you can add a qualifier to the constraint as
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment