docs/tutorial/README.rst
author Anton Shestakov <av6@dwimlabs.net>
Sun, 05 May 2019 17:39:46 +0800
changeset 4650 7c05b1625921
parent 3376 aad37ffd7d58
permissions -rw-r--r--
stack: get stack data directly from stack and remove stackdata() stackdata function began its life in 137f8b04901e as a proto-stack: it computed stack revs on its own and only had one property to return, "changesetcount". Later it started to prepare and return more properties, but since b933a8068c17 it was computing revs using a getstack function. And then finally in 17749d9d3968 it started to rely on stack class entirely. It was a good function, but now, when all the logic it provided was factored into stack class, I'd say it's finally time for it to be put to rest.

=============================
Training supports
=============================

Contributing
============

The main source for the supports is the `slides.md` but it doesn't contains
all the source.

The `slides.md` file contains several snippets that are replaced by other
files at compilation time.

For example:

.. code:: markdown

  ~~~raw-file
  output/fix-a-bug-base.log
  ~~~

Will replace this three lines by the content of the file `output/fix-a-bug-
base.log` which is generated when running the .t test file (see below for
instruction how to do that).

.. code:: markdown

  ~~~graphviz-file
  graphs/fix-bug-1.dot
  ~~~

Will replace this three lines by the svg rendering of the graphviz definition
in the file `graphs/fix-bug-1.dot`. This file is generated when running the .t
test file (see below for instruction how to do that).


Environment preparation
=======================

This training supports needs pandoc to compile.

You'll need a copy of the Mercurial source in order to generate the training
supports.

You will also needs a functioning Python environment with the possibility to
use `pip install` with your current user. In doubt, you can use a `virtualenv
<https://virtualenv.pypa.io/en/stable/>`.

You can then run the `prepare.sh` script that will configure the environment
for you.

Generating the supports
=======================

First, you need to run a .t test file to generate a bunch of files. You can
run the test file with this command:

`python /PATH/TO/MERCURIAL/tests/run-tests.py -l test-training.t`

It should have generated files in at least two directories: `graphs` and
`output`.

Finally, launch the `compile.sh` to generate the `index.html` output file.