We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
By default the asciidoc man page templates include lines like:
include::{includedir}/xxx.adoc[tag=picocli-generated-man-section-exit-status]
But a commands without an exit status, these tags are missing in the generated asciidoc man files. This causes asciidoctor to emit a warning like:
WARNING: xxx.adoc: line 19: tag 'picocli-generated-man-section-exit-status' not found in include file: xxxxxx/build/picocli/man/xxx.adoc
While commenting out the import lines in the template is easy enough, it would be nice if the asciidoc generator could put in empty tages like:
// tag::picocli-generated-man-section-exit-status[] // end::picocli-generated-man-section-exit-status[]
so that the no warning is printed.
A fix would be to change
static void genExitStatus(PrintWriter pw, CommandSpec spec) { if (spec.usageMessage().exitCodeList().isEmpty()) { return; }
to
static void genExitStatus(PrintWriter pw, CommandSpec spec) { if (spec.usageMessage().exitCodeList().isEmpty()) { pw.printf("// tag::picocli-generated-man-section-exit-status[]%n"); pw.printf("// end::picocli-generated-man-section-exit-status[]%n"); pw.println(); return; }
Similar issue with commands, arguments and footer, maybe others.
Using picocli 4.6.1 and gradle asciidoctor plugin 3.3.0.
The text was updated successfully, but these errors were encountered:
Good point, and thank you for providing the #1338 PR! I added some comment on that ticket.
Sorry, something went wrong.
9032c04
[remkop#1337][remkop#1338] update RELEASE-NOTES for preventing WARNIN…
c84fcde
…G messages when generating man pages Closes remkop#1337
Revert "[remkop#1337][remkop#1338] update RELEASE-NOTES for preventin…
fc276fc
…g WARNING messages when generating man pages" This reverts commit c84fcde.
299d5bc
No branches or pull requests
By default the asciidoc man page templates include lines like:
But a commands without an exit status, these tags are missing in the generated asciidoc man files. This causes asciidoctor to emit a warning like:
While commenting out the import lines in the template is easy enough, it would be nice if the asciidoc generator could put in empty tages like:
so that the no warning is printed.
A fix would be to change
to
Similar issue with commands, arguments and footer, maybe others.
Using picocli 4.6.1 and gradle asciidoctor plugin 3.3.0.
The text was updated successfully, but these errors were encountered: