Merge pull request #19304 from mkouba/command-line-docs-fix

Command mode apps - fix the restart key in the docs
quarkusio · Aug 9, 2021 · 1ca696f · 1ca696f
2 parents e59b466 + 6b5ec2e
commit 1ca696f
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/docs/src/main/asciidoc/command-mode-reference.adoc b/docs/src/main/asciidoc/command-mode-reference.adoc
@@ -114,7 +114,7 @@ in order to unblock the main thread and initiate the shutdown process.
 
 === Dev mode
 
-Also for command mode applications the dev mode is supported. When running `mvn compile quarkus:dev`, the command mode application is executed and on press of the Enter key, is restarted.
+Also for command mode applications the dev mode is supported. When running `mvn compile quarkus:dev`, the command mode application is executed and on press of the `Space bar` key, is restarted.
 
 As command mode applications will often require arguments to be passed on the commandline, this is also possible in dev mode via:
 

diff --git a/docs/src/main/asciidoc/picocli.adoc b/docs/src/main/asciidoc/picocli.adoc
@@ -290,6 +290,10 @@ annotationProcessor enforcedPlatform("${quarkusPlatformGroupId}:${quarkusPlatfor
 annotationProcessor 'info.picocli:picocli-codegen'
 ----
 
+== Development Mode
+
+In the development mode, i.e. when running `mvn quarkus:dev`, the application is executed and restarted every time the `Space bar` key is pressed. You can also pass arguments to your command line app via the `quarkus.args` system property, e.g. `mvn quarkus:dev -Dquarkus.args='--help'` and `mvn quarkus:dev -Dquarkus.args='-c -w --val 1'`.
+
 == Configuration Reference
 
 include::{generated-dir}/config/quarkus-picocli.adoc[opts=optional, leveloffset=+1]