view docs/README @ 5862:5056fb0c919e stable

evolve: use nullrev for an empty cache key

Pairing nullid with nullrev (-1) seems more logical than pairing it with 0.

This also means we don't false-detect strips out of nowhere. That used to
happen because newkey (-1, nullid) != self._cachekey (0, nullid).

Doc is generated with sphinx.

You can generate the doc with:

```
make
```

# Tutorials

For updating the tutorials, you need to have the docgraph extension installed
(https://pypi.python.org/pypi/hg-docgraph).

Then run the test-topic-tutorial.t and test-tutorial.t to update the output if
needed.

You'll need the dot binary (likely installed by the graphviz package in your
package manager) in order to have graphviz graphs rendered in the html output.

Simply run make in the docs directory should takes care of the conversion of
the tutorial .t files into .rst files. Then sphinx should do the rest of the
jobs by rendering graphviz graphs.