Repair --list option and correct obsolete descriptions of the --list option #607
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
A few lines in the help text no longer conformed to the rules used by txt2man(1), causing errors in generating man-pages and an HTML version of the documentation available via the "help" subcommand.
The --list option was incorrectly trimming pathnames when suffix=.false. was present, and the meaning of the --list option has changed from originally being an option to display the full pathnames of targets to displaying a table of matching target basenames. Since the --runner command can be used to display the full pathnames and the runner command defaults to an "echo" command the pathnames can still easily be generated, but an example was added to reflect that. As the help text needed editing anyway, changed some whitespace to conform to the requirements of the txt2man(1) utility, to facilitate easily generating man-pages and HTML versions of the help text.
awvwgk
approved these changes
Nov 12, 2021
LKedward
approved these changes
Nov 13, 2021
There was a problem hiding this comment.
Thanks @urbanjost! LGTM.
I also wonder whether we could incorporate your man page to html workflow within our Github actions here and deploy under fortran-lang.org?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #606.
--list now has non-intuitive differences between build --list and [run,test] --list and install --list, as it originally showed the full pathname of targets on all commands. Not sure if it should be renamed on [run,test] to --show; or if their should be a --path option specifically for the long names; but on [run,test] you can still get full pathnames via --runner so no functionality is lost; but
I do think it is less intuitive what --list does not, as it varies somewhat become subcommands.https://urbanjost.github.io/fpm-tools/manual.html
Did not add a new test for checking the --list option, but the need for this patch would probably be avoidable if we had one. Will try to add one in a separate PR, as a good number of features are not tested and we probably could use a separate project to get the tests up to par (especially since part of the design of fpm is specifically to encourage the development of tests :>).
To review the revised help text as HTML see this regenerated version of 'fpm version 0.4.0 manual'