docs: add documentation for root.transient-ro feature #1470
Conversation
github-actions
bot
added
documentation
control/skip-ci
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
docs/src/filesystem.md
Outdated
|
|
||
| ### Configuration | ||
|
|
||
| To enable this feature, add the following to `/etc/ostree/prepare-root.conf`: |
There was a problem hiding this comment.
This section recommends modifying /etc/ostree/prepare-root.conf, while other sections in this document (e.g., for root.transient or composefs) refer to /usr/lib/ostree/prepare-root.conf. While using /etc is correct for host-specific configuration, this difference could be confusing for readers.
It would be helpful to clarify that /etc is for per-machine configuration, and mention that /usr/lib could be used to enable the feature in a base image for all derived systems.
There was a problem hiding this comment.
Yes for bootc we should really only talk about the /usr/lib variant.
docs/src/filesystem.md
Outdated
|
|
||
| ### Configuration | ||
|
|
||
| To enable this feature, add the following to `/etc/ostree/prepare-root.conf`: |
There was a problem hiding this comment.
Yes for bootc we should really only talk about the /usr/lib variant.
gursewak1997
force-pushed
the
add-docs-transient-ro
branch
from
32927e7 to
214c6f2
Compare
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request adds clear and comprehensive documentation for the root.transient-ro feature. The new content is well-written and effectively explains the feature's functionality and use cases. I've included a couple of minor suggestions to enhance consistency within the documentation.
gursewak1997
force-pushed
the
add-docs-transient-ro
branch
from
214c6f2 to
6cdea9e
Compare
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request adds valuable documentation for the transient-ro feature. The new section is well-structured and provides a good overview, use cases, and an example. My review includes a critical correction to the option name and configuration snippet, which are incorrect as written and would prevent the feature from working. I've also included a few suggestions to improve the clarity and completeness of the documentation.
docs/src/filesystem.md
Outdated
| [prepare-root] | ||
| root.transient-ro = true |
There was a problem hiding this comment.
This configuration example is incorrect and will prevent the feature from working. The transient-ro option should be under the [root] section, not [prepare-root]. This is similar to how the transient option is configured elsewhere in this document.
| [prepare-root] | |
| root.transient-ro = true | |
| [root] | |
| transient-ro = true |
Add comprehensive documentation for the root.transient-ro option that allows privileged users to create dynamic top-level mountpoints at runtime while keeping the filesystem read-only by default.
gursewak1997
force-pushed
the
add-docs-transient-ro
branch
from
6cdea9e to
4407a37
Compare
2 participants
Add comprehensive documentation for the
root.transient-rooption that allows privileged users to create dynamic top-level mountpoints at runtime while keeping thefilesystemread-only by default.