Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

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

Jump to bottom

add tags for empty sections in adoc man page #1338

Merged
merged 3 commits into from
Mar 4, 2021
Merged

add tags for empty sections in adoc man page #1338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d4af3d2
add tags for empty sections in adoc man page
crotwell Mar 3, 2021
537d906
fixes for test failures
crotwell Mar 4, 2021
ae7522f
more fixes for test failures
crotwell Mar 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 15 additions & 0 deletions picocli-codegen/src/main/java/picocli/codegen/docgen/manpage/ManPageGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -503,6 +503,9 @@ static void genOptions(PrintWriter pw, CommandSpec spec) {
for (ArgGroupSpec group : groups) { options.removeAll(group.options()); }

if (options.isEmpty() && !spec.usageMessage().showEndOfOptionsDelimiterInUsageHelp()) {
pw.printf("// tag::picocli-generated-man-section-options[]%n");
pw.printf("// end::picocli-generated-man-section-options[]%n");
pw.println();
return;
}
pw.printf("// tag::picocli-generated-man-section-options[]%n");
Expand Down Expand Up @@ -604,6 +607,9 @@ static void genPositionalArgs(PrintWriter pw, CommandSpec spec) {
for (ArgGroupSpec group : groups) { positionals.removeAll(group.positionalParameters()); }

if (positionals.isEmpty() && !spec.usageMessage().showAtFileInUsageHelp()) {
pw.printf("// tag::picocli-generated-man-section-arguments[]%n");
pw.printf("// end::picocli-generated-man-section-arguments[]%n");
pw.println();
return;
}
pw.printf("// tag::picocli-generated-man-section-arguments[]%n");
Expand Down Expand Up @@ -637,6 +643,9 @@ static void genCommands(PrintWriter pw, CommandSpec spec) {
}

if (spec.subcommands().isEmpty()) {
pw.printf("// tag::picocli-generated-man-section-commands[]%n");
pw.printf("// end::picocli-generated-man-section-commands[]%n");
pw.println();
return;
}
pw.printf("// tag::picocli-generated-man-section-commands[]%n");
Expand Down Expand Up @@ -667,6 +676,9 @@ static void genCommands(PrintWriter pw, CommandSpec spec) {

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;
}
String heading = makeHeading(spec.usageMessage().exitCodeListHeading(), "Exit status");
Expand All @@ -688,6 +700,9 @@ static void genExitStatus(PrintWriter pw, CommandSpec spec) {

static void genFooter(PrintWriter pw, CommandSpec spec) {
if (spec.usageMessage().footerHeading().length() == 0 || spec.usageMessage().footer().length == 0) {
pw.printf("// tag::picocli-generated-man-section-footer[]%n");
pw.printf("// end::picocli-generated-man-section-footer[]%n");
pw.println();
return;
}
String heading = makeHeading(spec.usageMessage().footerHeading(), "Footer");
Expand Down
6 changes: 6 additions & 0 deletions picocli-codegen/src/test/resources/import.manpage.txt.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,12 @@ _<file>_::

// end::picocli-generated-man-section-arguments[]

// tag::picocli-generated-man-section-commands[]
// end::picocli-generated-man-section-commands[]

// tag::picocli-generated-man-section-exit-status[]
// end::picocli-generated-man-section-exit-status[]

// tag::picocli-generated-man-section-footer[]
== Example:

Expand Down
6 changes: 6 additions & 0 deletions picocli-codegen/src/test/resources/manpagegenerator/main_class-gen-manpage.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,12 @@ For example, `-v -v -v` or `-vvv`

// end::picocli-generated-man-section-arguments[]

// tag::picocli-generated-man-section-commands[]
// end::picocli-generated-man-section-commands[]

// tag::picocli-generated-man-section-exit-status[]
// end::picocli-generated-man-section-exit-status[]

// tag::picocli-generated-man-section-footer[]
== Converting to Man Page Format

Expand Down
9 changes: 9 additions & 0 deletions picocli-codegen/src/test/resources/manpagegenerator/main_class.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@

// end::picocli-generated-man-section-description[]

// tag::picocli-generated-man-section-options[]
// end::picocli-generated-man-section-options[]

// tag::picocli-generated-man-section-arguments[]
== Arguments

Expand All @@ -46,4 +49,10 @@ _<file>_::

// end::picocli-generated-man-section-commands[]

// tag::picocli-generated-man-section-exit-status[]
// end::picocli-generated-man-section-exit-status[]

// tag::picocli-generated-man-section-footer[]
// end::picocli-generated-man-section-footer[]

// end::picocli-generated-full-manpage[]
6 changes: 6 additions & 0 deletions ...c/test/resources/manpagegenerator/top-level-command-subcommand-gen-manpage.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,12 @@ For example, `-v -v -v` or `-vvv`

// end::picocli-generated-man-section-arguments[]

// tag::picocli-generated-man-section-commands[]
// end::picocli-generated-man-section-commands[]

// tag::picocli-generated-man-section-exit-status[]
// end::picocli-generated-man-section-exit-status[]

// tag::picocli-generated-man-section-footer[]
== Converting to Man Page Format

Expand Down
9 changes: 9 additions & 0 deletions ...i-codegen/src/test/resources/manpagegenerator/top-level-command-subcommand.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ Example subcommand

// end::picocli-generated-man-section-options[]

// tag::picocli-generated-man-section-arguments[]
// end::picocli-generated-man-section-arguments[]

// tag::picocli-generated-man-section-commands[]
== Commands

Expand All @@ -49,4 +52,10 @@ Example subcommand

// end::picocli-generated-man-section-commands[]

// tag::picocli-generated-man-section-exit-status[]
// end::picocli-generated-man-section-exit-status[]

// tag::picocli-generated-man-section-footer[]
// end::picocli-generated-man-section-footer[]

// end::picocli-generated-full-manpage[]
12 changes: 12 additions & 0 deletions picocli-codegen/src/test/resources/manpagegenerator/top-level-command-visible.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,16 @@ Example visible subcommand

// end::picocli-generated-man-section-options[]

// tag::picocli-generated-man-section-arguments[]
// end::picocli-generated-man-section-arguments[]

// tag::picocli-generated-man-section-commands[]
// end::picocli-generated-man-section-commands[]

// tag::picocli-generated-man-section-exit-status[]
// end::picocli-generated-man-section-exit-status[]

// tag::picocli-generated-man-section-footer[]
// end::picocli-generated-man-section-footer[]

// end::picocli-generated-full-manpage[]
9 changes: 9 additions & 0 deletions picocli-codegen/src/test/resources/manpagegenerator/top-level-command.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ example top-level command

// end::picocli-generated-man-section-options[]

// tag::picocli-generated-man-section-arguments[]
// end::picocli-generated-man-section-arguments[]

// tag::picocli-generated-man-section-commands[]
== Commands

Expand All @@ -55,4 +58,10 @@ example top-level command

// end::picocli-generated-man-section-commands[]

// tag::picocli-generated-man-section-exit-status[]
// end::picocli-generated-man-section-exit-status[]

// tag::picocli-generated-man-section-footer[]
// end::picocli-generated-man-section-footer[]

// end::picocli-generated-full-manpage[]
3 changes: 3 additions & 0 deletions picocli-codegen/src/test/resources/myapp.manpage.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ This app does great things.

// end::picocli-generated-man-section-arguments[]

// tag::picocli-generated-man-section-commands[]
// end::picocli-generated-man-section-commands[]

// tag::picocli-generated-man-section-exit-status[]
== Exit status

Expand Down
9 changes: 9 additions & 0 deletions picocli-codegen/src/test/resources/testEndOfOptions.manpage.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,13 @@ This app does great things.

// end::picocli-generated-man-section-arguments[]

// tag::picocli-generated-man-section-commands[]
// end::picocli-generated-man-section-commands[]

// tag::picocli-generated-man-section-exit-status[]
// end::picocli-generated-man-section-exit-status[]

// tag::picocli-generated-man-section-footer[]
// end::picocli-generated-man-section-footer[]

// end::picocli-generated-full-manpage[]
12 changes: 12 additions & 0 deletions picocli-codegen/src/test/resources/testEndOfOptionsWithoutOptions.manpage.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,16 @@ This app does great things.

// end::picocli-generated-man-section-options[]

// tag::picocli-generated-man-section-arguments[]
// end::picocli-generated-man-section-arguments[]

// tag::picocli-generated-man-section-commands[]
// end::picocli-generated-man-section-commands[]

// tag::picocli-generated-man-section-exit-status[]
// end::picocli-generated-man-section-exit-status[]

// tag::picocli-generated-man-section-footer[]
// end::picocli-generated-man-section-footer[]

// end::picocli-generated-full-manpage[]
9 changes: 9 additions & 0 deletions picocli-codegen/src/test/resources/testHidden.manpage.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ This app does great things.

// end::picocli-generated-man-section-options[]

// tag::picocli-generated-man-section-arguments[]
// end::picocli-generated-man-section-arguments[]

// tag::picocli-generated-man-section-commands[]
== Commands

Expand All @@ -52,4 +55,10 @@ This app does great things.

// end::picocli-generated-man-section-commands[]

// tag::picocli-generated-man-section-exit-status[]
// end::picocli-generated-man-section-exit-status[]

// tag::picocli-generated-man-section-footer[]
// end::picocli-generated-man-section-footer[]

// end::picocli-generated-full-manpage[]
15 changes: 15 additions & 0 deletions picocli-codegen/src/test/resources/testHiddenOptions.manpage.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,19 @@ This app does great things.

// end::picocli-generated-man-section-description[]

// tag::picocli-generated-man-section-options[]
// end::picocli-generated-man-section-options[]

// tag::picocli-generated-man-section-arguments[]
// end::picocli-generated-man-section-arguments[]

// tag::picocli-generated-man-section-commands[]
// end::picocli-generated-man-section-commands[]

// tag::picocli-generated-man-section-exit-status[]
// end::picocli-generated-man-section-exit-status[]

// tag::picocli-generated-man-section-footer[]
// end::picocli-generated-man-section-footer[]

// end::picocli-generated-full-manpage[]