[PATCH 0 of 1] doc: add the tool to check section marks in help documents

[Mads Kiilerich]

On 13/08/12 14:35, FUJIWARA Katsunori wrote:
> This patch series adds "doc/check-seclevel.py" which checks section
> mark usages in Mercurial help documents.
>
> In this series, to avoid adding new test script under tests, I added
> "doc/check-seclevel.py" invocation to "tests/test-help.t", because I

('sec' translates to 'security' for me. 'check-rst' seems more spot-on')
> couldn't find other appropriate tests for it.
>
> But "tests/test-help.t" seems to be the test only for the help
> function itself.
>
> Should I add it to another one or add new test script under tests ?

Wouldn't it be simpler to do the strict validation in the normal code 
path in minirst and let it fail or warn if the markup doesn't comply 
with our standards? I doubt the overhead would be measurable. Being less 
flexible could perhaps even make it faster ... but I guess we perhaps 
still want to be able to handle all kinds of (non-compliant) rst.

/Mads