Commit 4216274a authored by Herbert Valerio Riedel's avatar Herbert Valerio Riedel 🕺

Tweak plan.json section in user's guide

This also enables and makes use of the Sphinx todo extension which
provides an idiomatic way to annotate TODO items in .rst
parent a7fe9156
......@@ -15,7 +15,7 @@ import cabaldomain
version = "2.5.0.0"
extensions = ['sphinx.ext.extlinks']
extensions = ['sphinx.ext.extlinks', 'sphinx.ext.todo']
templates_path = ['_templates']
source_suffix = '.rst'
......@@ -120,6 +120,8 @@ latex_logo = 'images/logo.pdf'
# If true, show page references after internal links.
latex_show_pagerefs = True
# http://www.sphinx-doc.org/en/master/usage/extensions/todo.html
todo_include_todos = True
# -- Options for manual page output ---------------------------------------
......
......@@ -235,12 +235,28 @@ this folder (the most important two are first):
``improved-plan`` (binary)
Like ``solver-plan``, but with all non-inplace packages improved
into pre-existing copies from the store.
``plan.json`` (JSON)
A JSON serialization of the computed install plan intended
for integrating ``cabal`` with external tooling.
The `cabal-plan <http://hackage.haskell.org/package/cabal-plan>`__
package provides a library for parsing ``plan.json`` files into a
Haskell data structure as well as an example tool showing possible
applications.
.. todo::
Document JSON schema (including version history of schema)
Note that every package also has a local cache managed by the Cabal
build system, e.g., in ``$distdir/cache``.
There is another useful file in ``dist-newstyle/cache``, ``plan.json``,
which is a JSON serialization of the computed install plan. (TODO: docs)
There is another useful file in ``dist-newstyle/cache``,
``plan.json``, which is a JSON serialization of the computed install
plan and is intended for integrating with external tooling.
Commands
========
......
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