docs: Add man page for bootc-destructive-cleanup.service #1928
Conversation
Document the bootc-destructive-cleanup.service systemd unit that runs on first boot after an alongside installation with --cleanup. The man page explains how the service is enabled via the systemd generator, what the Fedora cleanup script does, and how distributions can customize the cleanup behavior. Resolves: https://issues.redhat.com/browse/RHEL-131317 Assisted-by: OpenCode (Claude Sonnet 4) Signed-off-by: Colin Walters <[email protected]>
cgwalters
force-pushed
the
doc-destructive-cleanup
branch
from
e935b00 to
8f42aba
Compare
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds a man page for the bootc-destructive-cleanup.service, which is a valuable addition for users of the --cleanup feature. The documentation is well-written and accurately describes the service's functionality. I've provided a couple of suggestions to enhance the clarity of the customization process for different distributions and to make the SEE ALSO section more comprehensive.
| The current implementation ships a Fedora-specific cleanup script. Other | ||
| distributions can provide their own cleanup script by creating an executable | ||
| at `/usr/lib/bootc/fedora-bootc-destructive-cleanup` or by modifying the | ||
| systemd unit file to reference a different path. |
There was a problem hiding this comment.
The explanation on how to customize the cleanup script could be clearer for non-Fedora distributions, given the hardcoded Fedora-specific script path. Consider restructuring this section for better clarity. For example:
The service executes a script at the hardcoded path `/usr/lib/bootc/fedora-bootc-destructive-cleanup`.
Distributions can customize the cleanup behavior in two ways:
- Create an executable file at `/usr/lib/bootc/fedora-bootc-destructive-cleanup` to override the default script. Note that the filename is currently not generic.
- Modify the systemd unit file to execute a script at a different path.|
|
||
| # SEE ALSO | ||
|
|
||
| **bootc**(8), **bootc-install-to-existing-root**(8), **system-reinstall-bootc**(8) |
There was a problem hiding this comment.
The SEE ALSO section could be improved by including more relevant bootc commands and systemd man pages. bootc-install(8) is a relevant parent command, and systemd.generator(7) is relevant since the service is enabled by a generator, as mentioned in the description. The reference to system-reinstall-bootc(8) could be removed as it doesn't appear to be part of bootc.
| **bootc**(8), **bootc-install-to-existing-root**(8), **system-reinstall-bootc**(8) | |
| **bootc**(8), **bootc-install**(8), **bootc-install-to-existing-root**(8), **systemd.generator**(7) |
1 participant
Document the bootc-destructive-cleanup.service systemd unit that runs on first boot after an alongside installation with --cleanup. The man page explains how the service is enabled via the systemd generator, what the Fedora cleanup script does, and how distributions can customize the cleanup behavior.
Resolves: https://issues.redhat.com/browse/RHEL-131317
Assisted-by: OpenCode (Claude Sonnet 4)