Update docs
This commit is contained in:
@@ -2,30 +2,30 @@
|
||||
* xref:getting-started.adoc[]
|
||||
* xref:using-shell-basics.adoc[]
|
||||
** xref:using-shell-basics-reading.adoc[]
|
||||
* xref:using-shell-commands.adoc[]
|
||||
** xref:using-shell-commands-registration.adoc[]
|
||||
** xref:using-shell-commands-registration-programmatic.adoc[]
|
||||
** xref:using-shell-commands-registration-annotation.adoc[]
|
||||
** xref:using-shell-commands-registration-legacyannotation.adoc[]
|
||||
** xref:using-shell-commands-organize.adoc[]
|
||||
** xref:using-shell-commands-availability.adoc[]
|
||||
** xref:using-shell-commands-exceptionhandling.adoc[]
|
||||
*** xref:using-shell-commands-exceptionhandling-resolving.adoc[]
|
||||
*** xref:using-shell-commands-exceptionhandling-mappings.adoc[]
|
||||
*** xref:using-shell-commands-exceptionhandling-annotation.adoc[]
|
||||
** xref:using-shell-commands-hidden.adoc[]
|
||||
** xref:using-shell-commands-helpoptions.adoc[]
|
||||
** xref:using-shell-commands-interactionmode.adoc[]
|
||||
** xref:using-shell-commands-builtin.adoc[]
|
||||
*** xref:using-shell-commands-builtin-help.adoc[]
|
||||
*** xref:using-shell-commands-builtin-clear.adoc[]
|
||||
*** xref:using-shell-commands-builtin-exit.adoc[]
|
||||
*** xref:using-shell-commands-builtin-stacktrace.adoc[]
|
||||
*** xref:using-shell-commands-builtin-script.adoc[]
|
||||
*** xref:using-shell-commands-builtin-history.adoc[]
|
||||
*** xref:using-shell-commands-builtin-completion.adoc[]
|
||||
*** xref:using-shell-commands-builtin-version.adoc[]
|
||||
** xref:using-shell-commands-writing.adoc[]
|
||||
* xref:commands/index.adoc[]
|
||||
** xref:commands/registration/index.adoc[]
|
||||
** xref:commands/registration/programmatic.adoc[]
|
||||
** xref:commands/registration/annotation.adoc[]
|
||||
** xref:commands/registration/legacyannotation.adoc[]
|
||||
** xref:commands/organize.adoc[]
|
||||
** xref:commands/availability.adoc[]
|
||||
** xref:commands/exceptionhandling/index.adoc[]
|
||||
*** xref:commands/exceptionhandling/resolving.adoc[]
|
||||
*** xref:commands/exceptionhandling/mappings.adoc[]
|
||||
*** xref:commands/exceptionhandling/annotation.adoc[]
|
||||
** xref:commands/hidden.adoc[]
|
||||
** xref:commands/helpoptions.adoc[]
|
||||
** xref:commands/interactionmode.adoc[]
|
||||
** xref:commands/builtin/index.adoc[]
|
||||
*** xref:commands/builtin/help.adoc[]
|
||||
*** xref:commands/builtin/clear.adoc[]
|
||||
*** xref:commands/builtin/exit.adoc[]
|
||||
*** xref:commands/builtin/stacktrace.adoc[]
|
||||
*** xref:commands/builtin/script.adoc[]
|
||||
*** xref:commands/builtin/history.adoc[]
|
||||
*** xref:commands/builtin/completion.adoc[]
|
||||
*** xref:commands/builtin/version.adoc[]
|
||||
** xref:commands/writing.adoc[]
|
||||
* xref:options/index.adoc[]
|
||||
** xref:options/basics/index.adoc[]
|
||||
*** xref:options/basics/programmatic.adoc[]
|
||||
|
||||
@@ -53,7 +53,7 @@ Command 'download' exists but is not currently available because you are not con
|
||||
Details of the error have been omitted. You can use the stacktrace command to print the full stacktrace.
|
||||
----
|
||||
|
||||
Information about currently unavailable commands is also used in the integrated help. See xref:using-shell-commands-builtin-help.adoc[Help].
|
||||
Information about currently unavailable commands is also used in the integrated help. See xref:commands/builtin/help.adoc[Help].
|
||||
|
||||
[TIP]
|
||||
====
|
||||
@@ -7,7 +7,7 @@ accessing a web browser or any other rich UI application (such as a PDF viewer)
|
||||
be possible. This is why it is important that the shell commands are correctly self-documented, and this is where the `help`
|
||||
command comes in.
|
||||
|
||||
Typing `help` + `ENTER` lists all the commands known to the shell (including xref:using-shell-commands-availability.adoc[unavailable] commands)
|
||||
Typing `help` + `ENTER` lists all the commands known to the shell (including xref:commands/availability.adoc[unavailable] commands)
|
||||
and a short description of what they do, similar to the following:
|
||||
|
||||
[source, bash]
|
||||
@@ -90,10 +90,10 @@ as a model.
|
||||
|`true` if showing groups is enabled. Otherwise, false.
|
||||
|
||||
|`groups`
|
||||
|The commands variables (see xref:using-shell-commands-builtin-help.adoc#groupcommandinfomodel-variables[GroupCommandInfoModel Variables]).
|
||||
|The commands variables (see xref:commands/builtin/help.adoc#groupcommandinfomodel-variables[GroupCommandInfoModel Variables]).
|
||||
|
||||
|`commands`
|
||||
|The commands variables (see xref:using-shell-commands-builtin-help.adoc#commandinfomodel-variables[CommandInfoModel Variables]).
|
||||
|The commands variables (see xref:commands/builtin/help.adoc#commandinfomodel-variables[CommandInfoModel Variables]).
|
||||
|
||||
|`hasUnavailableCommands`
|
||||
|`true` if there is unavailable commands. Otherwise, false.
|
||||
@@ -108,7 +108,7 @@ as a model.
|
||||
|The name of a group, if set. Otherwise, empty.
|
||||
|
||||
|`commands`
|
||||
|The commands, if set. Otherwise, empty. Type is a multi value, see xref:using-shell-commands-builtin-help.adoc#commandinfomodel-variables[CommandInfoModel Variables].
|
||||
|The commands, if set. Otherwise, empty. Type is a multi value, see xref:commands/builtin/help.adoc#commandinfomodel-variables[CommandInfoModel Variables].
|
||||
|===
|
||||
|
||||
[[commandinfomodel-variables]]
|
||||
@@ -129,10 +129,10 @@ as a model.
|
||||
|The description of a command, if set. Otherwise, null.
|
||||
|
||||
|`parameters`
|
||||
|The parameters variables, if set. Otherwise empty. Type is a multi value, see xref:using-shell-commands-builtin-help.adoc#commandparameterinfomodel-variables[CommandParameterInfoModel Variables].
|
||||
|The parameters variables, if set. Otherwise empty. Type is a multi value, see xref:commands/builtin/help.adoc#commandparameterinfomodel-variables[CommandParameterInfoModel Variables].
|
||||
|
||||
|`availability`
|
||||
|The availability variables (see xref:using-shell-commands-builtin-help.adoc#commandavailabilityinfomodel-variables[CommandAvailabilityInfoModel Variables]).
|
||||
|The availability variables (see xref:commands/builtin/help.adoc#commandavailabilityinfomodel-variables[CommandAvailabilityInfoModel Variables]).
|
||||
|===
|
||||
|
||||
[[commandparameterinfomodel-variables]]
|
||||
@@ -11,8 +11,8 @@ In the programmatic model, you use a more low level approach, defining command
|
||||
registrations (either as beans or by dynamically registering with a command catalog).
|
||||
|
||||
Starting from _3.1.x_ a better support for defining commands using
|
||||
xref:using-shell-commands-registration-annotation.adoc[annotations] were added. Firstly because eventually standard
|
||||
package providing xref:using-shell-commands-registration-legacyannotation.adoc[legacy annotations] will get deprecated
|
||||
xref:commands/registration/annotation.adoc[annotations] were added. Firstly because eventually standard
|
||||
package providing xref:commands/registration/legacyannotation.adoc[legacy annotations] will get deprecated
|
||||
and removed. Secondly so that we're able to provide same set of features than using underlying
|
||||
`CommandRegistration`. Creating new a annotation model allows us to rethink and modernise that
|
||||
part without breaking existing applications.
|
||||
@@ -24,7 +24,7 @@ include::{snippets}/AnnotationRegistrationSnippets.java[tag=snippet1]
|
||||
|
||||
The only required attribute of the `@ShellMethod` annotation is its `value` attribute, which should have
|
||||
a short, one-sentence, description of what the command does. This lets your users
|
||||
get consistent help about your commands without having to leave the shell (see xref:using-shell-commands-builtin-help.adoc[Help]).
|
||||
get consistent help about your commands without having to leave the shell (see xref:commands/builtin/help.adoc[Help]).
|
||||
|
||||
NOTE: The description of your command should be short -- no more than one or two sentences. For better
|
||||
consistency, it should start with a capital letter and end with a period.
|
||||
@@ -17,7 +17,7 @@ be autowired. Default implementation of this supplier returns
|
||||
a new builder so you don't need to worry about its internal state.
|
||||
|
||||
IMPORTANT: Commands registered programmatically automatically
|
||||
add _help options_ mentioned in xref:using-shell-commands-helpoptions.adoc[Help Options].
|
||||
add _help options_ mentioned in xref:commands/helpoptions.adoc[Help Options].
|
||||
|
||||
If bean of this supplier type is defined then auto-configuration
|
||||
will back off giving you an option to redefine default functionality.
|
||||
@@ -5,8 +5,8 @@
|
||||
Throughout this documentation, we make references to configuring something by using
|
||||
annotations or programmatic examples.
|
||||
|
||||
NOTE: There are two annotation models, xref:using-shell-commands-registration-annotation.adoc[annotations]
|
||||
referred to new annotation model, xref:using-shell-commands-registration-legacyannotation.adoc[legacy annotations]
|
||||
NOTE: There are two annotation models, xref:commands/registration/annotation.adoc[annotations]
|
||||
referred to new annotation model, xref:commands/registration/legacyannotation.adoc[legacy annotations]
|
||||
referred to old legacy annotation model.
|
||||
|
||||
Old legacy annotation model mostly relates to use of `@ShellMethod` and `@ShellOption` and
|
||||
|
||||
@@ -57,4 +57,4 @@ include::{snippets}/CompletionSnippets.java[tag=anno-method]
|
||||
== Command-Line
|
||||
|
||||
Command-line completion currently only support _bash_ and is documented
|
||||
in a built-in `completion` command xref:using-shell-commands-builtin-completion.adoc[Completion].
|
||||
in a built-in `completion` command xref:commands/builtin/completion.adoc[Completion].
|
||||
|
||||
Reference in New Issue
Block a user