Ævar Arnfjörð Bjarmason [off-list ref] writes:
quoted
Taking this point into consideration, a middle-ground alternative to
Ævar's idea would be to add tooling which only compares (by some
definition of "compare") the output of `git blah -h` with the synopsis
in `git-blah.txt` and complains if there are significant differences
(by some definition "significant" and "difference"). It doesn't
automate-away the work of keeping the synopsis up-to-date, but at
least would flag inconsistencies.
Or we could do the reverse and move the source code version of it to be
generated from the [verse] sections in the documentation.
Either would be far more preferrable than committing generated files,
or committing us to work on unreadable sources.
Thanks.