gperciva
commented
2 years ago I did consider trying to generate short descriptions of options by parsing the man-page directly. However, the first sentence of options
- was not always less than 1 line of text
- did not always explain the option. (That's not a problem in the man-page, since there were subsequent sentences)
After spending far too long on working on parsing the man-page, and rewriting parts of the man-page so that the first sentence of each option would serve as a 1-line short description, I realized that it would be less work to have an independent file.
This is the step 1/2 towards a replacement for #226. This step:
adds a
misc/describe-options.txt, which contains short (1-line) descriptions of tarsnap options.adds python code to parse that file, and match those descriptions against the options in the man-page.
As of this PR,
misc/describe-options.txtis only used as a sanity check, but the following PR will use that as part of the zsh completion file generation.