Skip to content

improve cli documentation for questions #754

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

Merged
jreidinger merged 8 commits into from
Sep 18, 2023
Merged

improve cli documentation for questions #754

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
fa056ce
improve cli documentation for questions
jreidinger Sep 14, 2023
47452df
changes
jreidinger Sep 14, 2023
d349a03
Merge remote-tracking branch 'origin/master' into questions_documenta…
jreidinger Sep 14, 2023
450e58b
fmt rust
jreidinger Sep 15, 2023
c5a7cd8
add wrap_help feature of clap for better help wrapping
jreidinger Sep 15, 2023
b9a7e4c
Apply suggestions from code review
jreidinger Sep 15, 2023
651ef17
Apply suggestions from code review
jreidinger Sep 18, 2023
487e3a7
make rust linter happy
jreidinger Sep 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions rust/Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion rust/agama-cli/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
clap = { version = "4.1.4", features = ["derive"] }
clap = { version = "4.1.4", features = ["derive", "wrap_help"] }
agama-lib = { path="../agama-lib" }
agama-settings = { path="../agama-settings" }
serde = { version = "1.0.152" }
Expand Down
9 changes: 8 additions & 1 deletion rust/agama-cli/src/commands.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,14 @@ pub enum Commands {
/// Autoinstallation profile handling
#[command(subcommand)]
Profile(ProfileCommands),
/// Questions handling
/// Configuration for questions that come from installer
///
/// Questions are raised when unexpected situation happen in Installer

@mvidner mvidner Sep 15, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@mvidner mvidner Sep 15, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@jreidinger jreidinger Sep 15, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

/// like if encrypted partition is detected and cannot be inspected,
Comment thread
jreidinger marked this conversation as resolved.
Outdated
/// if repository is sign by unknown GPG key or if installer is not sure
Comment thread
jreidinger marked this conversation as resolved.
Outdated
/// if multipath should be activated.
///
/// For more details see official agama documentation for Questions.
#[command(subcommand)]
Questions(QuestionsCommands),
}
12 changes: 11 additions & 1 deletion rust/agama-cli/src/questions.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,19 @@ use clap::{Args, Subcommand, ValueEnum};

#[derive(Subcommand, Debug)]
pub enum QuestionsCommands {
/// Set mode for answering questions.
/// Sets the mode for answering questions.
///
/// It allows to decide if questions will be interactive or
/// if it should not block installation.
Comment thread
jreidinger marked this conversation as resolved.
Outdated
Mode(ModesArgs),
/// 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.

@mvidner mvidner Sep 15, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to have a more helpful reference here

@mvidner mvidner Sep 15, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@jreidinger jreidinger Sep 15, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread
jreidinger marked this conversation as resolved.
Answers {
/// Local path to file with answers in YAML format
path: String,
},
}
Expand Down
5 changes: 5 additions & 0 deletions rust/package/agama-cli.changes
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
-------------------------------------------------------------------
Thu Sep 14 19:44:57 UTC 2023 - Josef Reidinger <jreidinger@suse.com>

- Improve questions CLI help text (gh#openSUSE/agama#754)

-------------------------------------------------------------------
Thu Sep 14 10:10:37 UTC 2023 - Imobach Gonzalez Sosa <igonzalezsosa@suse.com>

Expand Down