Hello everyone,
I have pushed some changes to the next branch that break
the tests. This is because I have integrated the test/CheckTests.py
script into the test suite and it shows areas where ledger can
be improved.
The script checks whether all options know to ledger are documented
in the manpage (doc/ledger.1) and in the manual (doc/ledger3.texi),
and whether there are options documented in those files that aren't
supported by ledger.
Please find below a list of errors reported by test/CheckTests.py,
if you know what (some of) those options do I kindly ask you to
to write a short documentation and issue a pull request on github
or respond to this mail, so we can improve the documentation.
In order to document options in the manpage follow the given
mdoc (7) formatting: .It Fl \-option-to-document
I have commented many undocumented options running the following
command will show you which those are:
% grep '.\".It Fl' doc/ledger.1
To test the options documented in the manual I have expanded
test/CheckTets.py so that it searches for lines with @c option,
e.g.: @item --help @c option
There are also several FIXME's in doc/ledger3.texi, that need,
well fixing ;)
Should you document an option in the manual please add the string
`@c option` to it, so that CheckTests.py can verify it and search
for the option in the whole manual, it may be documented in several
places.
Thanks!
Alexis
Here's the output of:
% python test/CheckTests.py --ledger ${PATH_TO}/ledger --source .
Missing man page entries for:
--auto-match
--base
--cache
--day-break
--exact
--explicit
--full-help
--help-calc
--help-comm
--help-disp
--import
--lots-actual
--no-pager
--permissive
--revalued
--revalued-only
--revalued-total
--rich-data
--sort-all
--time-report
--value-expr
--verify-memory
Missing texi entries for:
--auto-match
--base
--cache
--datetime-format
--day-break
--exact
--full-help
--help-calc
--help-comm
--help-disp
--import
--lots-actual
--no-pager
--permissive
--revalued
--revalued-only
--revalued-total
--rich-data
--sort-all
--time-report
--value-expr
--verify-memory
Texi entry for unknown option:
--getquote
--
---
You received this message because you are subscribed to the Google Groups
"Ledger" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
For more options, visit https://groups.google.com/d/optout.
