view tests/check-gendoc @ 35939:a622a927fe03

sshpeer: document the handshake mechanism

The mechanism by which SSH peers establish connections with remotes
is wonky and requires a bit of code archeology to understand. While
it is already documented in `hg help internals.wireproto`, it helps
to have documentation in the code as well.

Differential Revision: https://phab.mercurial-scm.org/D2035

#!/bin/sh
HGENCODING=UTF-8
export HGENCODING

echo ".. -*- coding: utf-8 -*-" > gendoc.txt
echo "" >> gendoc.txt
LANGUAGE=$1 python "$TESTDIR/../doc/gendoc.py" >> gendoc.txt 2> /dev/null || exit

echo "checking for parse errors"
python "$TESTDIR/../doc/docchecker" gendoc.txt
python "$TESTDIR/../doc/runrst" html gendoc.txt /dev/null