Skip to content

Added documentation for agama.finish boot option and CLI#47

Merged
teclator merged 3 commits intomainfrom
agama.finish_doc
Feb 19, 2025
Merged

Added documentation for agama.finish boot option and CLI#47
teclator merged 3 commits intomainfrom
agama.finish_doc

Conversation

@teclator
Copy link
Contributor

Added documentation for agama-project/agama#1970

- `agama.finish`
During an unattended installation, if the installation is completed successfully then the
installer will reboot into the target system by default. This behavior can be modified allowing
to `stop`, `halt` or `poweroff` the machine at the end of the installation.
Copy link
Contributor

Choose a reason for hiding this comment

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

NP: we don't have something like agama.finish=reboot or agama.finish=default ? Just for cases when someone want to express default behavior explicitly in his use case.

Copy link
Contributor

@mchf mchf Feb 19, 2025

Choose a reason for hiding this comment

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

NP: we don't have something like agama.finish=reboot or agama.finish=default ? Just for cases when someone want to express default behavior explicitly in his use case.

Ah ... we do ... here https://github.com/agama-project/agama-project.github.io/pull/47/files#diff-8f73a449c31f0bace7e660fd5dc8b2b021bd218841bafeab47ea8b3c2e2bc931R333 So, may be that mentioning reboot even here would be nice too.

Something like " ... installer will reboot into the target ..." Could be enough to just give user a pointer that such argument exists too.

Copy link
Contributor Author

@teclator teclator Feb 19, 2025

Choose a reason for hiding this comment

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

Yep, as I mentioned that it will reboot by default I only documented the options to avoid that as it does not makes to match sense to specify the parameter if not needed.

:::

- `agama.finish`
During an unattended installation, if the installation is completed successfully then the
Copy link
Contributor

Choose a reason for hiding this comment

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

so it does not have any effect if user do not specify agama.auto, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Exactly, not by now.

Copy link
Contributor

Choose a reason for hiding this comment

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

So may be mention that explicitly ... taking into account what bugs we sometimes get ;-)

Copy link
Contributor

@mchf mchf left a comment

Choose a reason for hiding this comment

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

lgtm

@teclator teclator merged commit 55ddd2f into main Feb 19, 2025
4 checks passed
@teclator teclator deleted the agama.finish_doc branch February 19, 2025 13:02
@mvidner mvidner mentioned this pull request Feb 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants