[2/2] ref-manual: document overlayfs-etc image feature

Message ID 20211215171138.127272-2-uvv.mail@gmail.com
State New
Headers show
Series [1/2] ref-manual: add overlayfs-etc class | expand

Commit Message

Vyacheslav Yurkov Dec. 15, 2021, 5:11 p.m. UTC
Signed-off-by: Vyacheslav Yurkov <uvv.mail@gmail.com>
---
 documentation/ref-manual/features.rst | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Michael Opdenacker Dec. 15, 2021, 8:54 p.m. UTC | #1
On 12/15/21 6:11 PM, Vyacheslav Yurkov wrote:
> Signed-off-by: Vyacheslav Yurkov <uvv.mail@gmail.com>
> ---
>  documentation/ref-manual/features.rst | 4 ++++
>  1 file changed, 4 insertions(+)
>
> diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst
> index ded653221..5f6c00fac 100644
> --- a/documentation/ref-manual/features.rst
> +++ b/documentation/ref-manual/features.rst
> @@ -219,6 +219,10 @@ Here are the image features available for all images:
>  -  *empty-root-password:* Sets the root password to an empty string,
>     which allows logins with a blank password.
>  
> +-  *overlayfs-etc:* Configures ``/etc`` directory to be in ``overlayfs``.


/s/Configures/Configures the/

> +   This allows to store device specific information elsewhere, especially
> +   if rootfs is configured to be read-only.

s/rootfs/the root filesystem/

I'll propose a guideline to replace "rootfs" by "root filesystem", but
the way. Everyone understands this term here of course, but that's
better English ;-)

Thanks for the patch, and thanks in advance for the V2 ;)
Cheers
Michael.

Patch

diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst
index ded653221..5f6c00fac 100644
--- a/documentation/ref-manual/features.rst
+++ b/documentation/ref-manual/features.rst
@@ -219,6 +219,10 @@  Here are the image features available for all images:
 -  *empty-root-password:* Sets the root password to an empty string,
    which allows logins with a blank password.
 
+-  *overlayfs-etc:* Configures ``/etc`` directory to be in ``overlayfs``.
+   This allows to store device specific information elsewhere, especially
+   if rootfs is configured to be read-only.
+
 -  *package-management:* Installs package management tools and preserves
    the package manager database.