Merge pull request #8182 from ulysses4ever/t8177

docs: move Configuration chapter to cabal-install reference

Author: mergify[bot]

doc/cabal-commands.rst

@@ -1,5 +1,5 @@
-cabal-install Commands
-======================
+Commands
+========
 
 ``cabal help`` groups commands into global, package, new-style project and
 legacy sections. We talk in detail about some global and package commands.

doc/cabal-config-and-commands.rst

@@ -0,0 +1,6 @@
+cabal-install Configuration and Commands
+****************************************
+
+.. toctree::
+   config
+   cabal-commands

doc/cabal-package.rst

@@ -52,16 +52,16 @@ directory of the package:
 
 :file:`Setup.hs`
     a single-module Haskell program to perform various setup tasks (with
-    the interface described in the section on :ref:`installing-packages`).
+    the interface described in the section on :ref:`setup-commands`).
     This module should import only modules that will be present in all Haskell
     implementations, including modules of the Cabal library. The content of
     this file is determined by the :pkg-field:`build-type` setting in the
     ``.cabal`` file. In most cases it will be trivial, calling on the Cabal
     library to do most of the work.
 
 Once you have these, you can create a source bundle of this directory
-for distribution. Building of the package is discussed in the section on
-:ref:`installing-packages`.
+for distribution. Building of the package is demonstrated in the section
+:ref:`building-packages`.
 
 One of the purposes of Cabal is to make it easier to build a package
 with different Haskell implementations. So it provides abstractions of
@@ -3389,9 +3389,7 @@ a few options:
                                   sysconfdir=$(destdir)/$(sysconfdir) \
 
 -  Finally, with the :pkg-field:`build-type` ``Custom``, you can also write your
-   own setup script from scratch. It must conform to the interface
-   described in the section on :doc:`building and installing
-   packages <installing-packages>`, and you may use the Cabal
+   own setup script from scratch, and you may use the Cabal
    library for all or part of the work. One option is to copy the source
    of ``Distribution.Simple``, and alter it for your needs. Good luck.
 

doc/config-and-install.rst

@@ -256,25 +256,3 @@ recommended instead to use a *secure* local repository:
 The layout of these secure local repos matches the layout of remote
 repositories exactly; the :hackage-pkg:`hackage-repo-tool`
 can be used to create and manage such repositories.
-
-.. _installing-packages:
-
-Building and installing packages
-================================
-
-To be written
-
-Installing packages from Hackage
---------------------------------
-
-The ``cabal`` tool also can download, configure, build and install a
-`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.
-
-.. _Hackage: https://hackage.haskell.org/

doc/installing-packages.rst renamed to doc/config.rst

@@ -259,6 +259,7 @@ your libraries and executable sections. For example:
 Note that the ``import`` **must** be the first thing in the stanza. For more
 information see the :ref:`common-stanzas` section.
 
+.. _building-packages:
 
 Building the package
 --------------------

doc/developing-packages.rst

@@ -8,10 +8,9 @@ Welcome to the Cabal User Guide
 
    getting-started
    intro
-   config-and-install
    concepts-and-development
    nix-local-build-overview
-   cabal-commands
+   cabal-config-and-commands
    cabal-package
    cabal-project
    setup-commands

doc/index.rst

@@ -102,9 +102,6 @@ which Haskell implementation to use and whether to build optimised code
 or build with the ability to profile code. It is not expected that users
 will have to modify any of the information in the ``.cabal`` file.
 
-For full details, see the section on :doc:`building and installing
-packages <installing-packages>`.
-
 Note that ``cabal`` is not the only tool for working with Cabal
 packages. Due to the standardised format and a library for reading
 ``.cabal`` files, there are several other special-purpose tools.

doc/intro.rst

@@ -1,3 +1,5 @@
+.. _setup-commands:
+
 Setup.hs Commands
 =================