improve cli documentation for questions

[jreidinger]

Problem

There is insufficient documentation of questions CLI.

Solution

Improve it

Testing

• Tested manually

Screenshots

Before:

jreidinger@localhost:~/prace/yast/d-installer/rust/target/debug> ./agama questions --help
Questions handling

Usage: agama questions <COMMAND>

Commands:
  mode     Set mode for answering questions
  answers  
  help     Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help



jreidinger@localhost:~/prace/yast/d-installer/rust/target/debug> ./agama questions mode --help
Set mode for answering questions

Usage: agama questions mode <VALUE>

Arguments:
  <VALUE>  [possible values: interactive, non-interactive]

Options:
  -h, --help  Print help



jreidinger@localhost:~/prace/yast/d-installer/rust/target/debug> ./agama questions answers --help
Usage: agama questions answers <PATH>

Arguments:
  <PATH>  

Options:
  -h, --help  Print help

After:

jreidinger@localhost:~/prace/yast/d-installer/rust/target/debug> ./agama questions --help
Configuration for questions that come from installer

Questions are raised when unexpected situation happen in Installer like if encrypted partition is detected and cannot be inspected, if repository is sign by unknown GPG key or if installer is not sure if multipath should be activated.

For more details see official agama documentation for Questions.

Usage: agama questions <COMMAND>

Commands:
  mode     Sets the mode for answering questions
  answers  Loads predefined answers to questions
  help     Print this message or the help of the given subcommand(s)

Options:
  -h, --help
          Print help (see a summary with '-h')



jreidinger@localhost:~/prace/yast/d-installer/rust/target/debug> ./agama questions mode --help
Sets the mode for answering questions.

It allows to decide if questions will be interactive or if it should not block installation.

Usage: agama questions mode <VALUE>

Arguments:
  <VALUE>
          [possible values: interactive, non-interactive]

Options:
  -h, --help
          Print help (see a summary with '-h')



jreidinger@localhost:~/prace/yast/d-installer/rust/target/debug> ./agama questions answers --help
Loads predefined answers to questions.

It allows to predefine answers for certain questions to skip them in interactive mode or change answer in automatic mode.

For more details and examples see official Agama documentation.

Usage: agama questions answers <PATH>

Arguments:
  <PATH>
          Local path to file with answers in YAML format

Options:
  -h, --help
          Print help (see a summary with '-h')

[coveralls]

coverage: 72.653% (+0.007%) from 72.646% when pulling 487e3a7 on questions_documentation into 5b3172e on master.

[mvidner]

Suggested change

	/// Questions are raised when unexpected situation happen in Installer
	/// Questions are raised when an unexpected situation happens in the installer:

[mvidner]

Well unexpected is wrong. It is expected, that's why we have coded a special case for it

[jreidinger]

yeah, I am not sure what is better word. Maybe "uncommon" or "rare"? not sure

[mvidner]

I'd like to have a more helpful reference here

[mvidner]

https://github.com/openSUSE/agama/blob/master/doc/questions.md or anything else?

[jreidinger]

That is what I am not sure if it will be documented on official suse side or not..and if it will be product specific or not.

[mvidner]

I have put the remaining info into the comments