docs: filesystems: overlayfs: Rename overlayfs.txt to .rst
Subsystems (2)
Amir Goldstein
maintainerPATCH 1/1 docs: filesystems: overlayfs: Rename overlayfs.txt to .rst
It is already formatted as RST.
---
Hi John,
Not sure if this doc is up to standards, but it is already displayed fairly well on github as .rst.
If you want me to make more changes to bring it into compliance, before the rename please let me know what needs to be done.
Is there a script to check doc compliance?
Otherwise, you can just take this rename patch and leave it to other devlopers to clean it up.
Thanks,
Amir.
Documentation/filesystems/{overlayfs.txt => overlayfs.rst} | 0
1 file changed, 0 insertions(+), 0 deletions(-)
rename Documentation/filesystems/{overlayfs.txt => overlayfs.rst} (100%)Documentation/filesystems/overlayfs.rst renamed from Documentation/filesystems/overlayfs.txt +0 -0
Signature · 1 line
2.17.1
Amir Goldstein
maintainerQuoted 11 lines · Amir Goldstein
It is already formatted as RST.
Signed-off-by Amir Goldstein <[email protected]>---
Hi John,
Not sure if this doc is up to standards, but it is already displayed fairly well on github as .rst.
You'd probably want to apply the attached patch as well.
I wasn't sure if those should go through documentation tree or overlayfs tree. Miklos, if you have any objections or would like to carry this though your tree please speak up.
Thanks,
Amir.
From 7570169cbfb96bb4f2ce2b62caa021c671d345cd Mon Sep 17 00:00:00 2001
From: Amir Goldstein <[email protected]>
Date: Mon, 25 Nov 2019 11:51:25 +0200
Subject: [PATCH] docs: filesystems: overlayfs: Fix restview warnings
Fix only the obvious problems
--- Documentation/filesystems/overlayfs.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
Documentation/filesystems/overlayfs.rst +4 -4
@@ -181,7 +181,7 @@ Kernel config options: worried about backward compatibility with kernels that have the redirect_dir feature and follow redirects even if turned off. -Module options (can also be changed through /sys/module/overlay/parameters/*): +Module options (can also be changed through /sys/module/overlay/parameters/): - "redirect_dir=BOOL": See OVERLAY_FS_REDIRECT_DIR kernel config option above.
@@ -263,7 +263,7 @@ top, lower2 the middle and lower3 the bottom layer. Metadata only copy up --------------------- +--------------------- When metadata only copy up feature is enabled, overlayfs will only copy up metadata (as opposed to whole file), when a metadata specific operation
@@ -286,10 +286,10 @@ pointed by REDIRECT. This should not be possible on local system as setting "trusted." xattrs will require CAP_SYS_ADMIN. But it should be possible for untrusted layers like from a pen drive. -Note: redirect_dir={off|nofollow|follow(*)} conflicts with metacopy=on, and +Note: redirect_dir={off|nofollow|follow[*]} conflicts with metacopy=on, and results in an error. -(*) redirect_dir=follow only conflicts with metacopy=on if upperdir=... is +[*] redirect_dir=follow only conflicts with metacopy=on if upperdir=... is given. Sharing and copying layers
Signature · 1 line
2.17.1