[PATCH] tmpfs.5: extend with new noswap documentation

Luis Chamberlain posted 1 patch 2 years, 8 months ago
There is a newer version of this series
man5/tmpfs.5 | 5 +++++
1 file changed, 5 insertions(+)
[PATCH] tmpfs.5: extend with new noswap documentation
Posted by Luis Chamberlain 2 years, 8 months ago
Linux commit 2c6efe9cf2d7 ("shmem: add support to ignore swap")
merged as of v6.4 added support to disable swap for tmpfs mounts.

This extends the man page to document that.

Signed-off-by: Luis Chamberlain <mcgrof@kernel.org>
---
 man5/tmpfs.5 | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/man5/tmpfs.5 b/man5/tmpfs.5
index 09d9558985e9..f7f90f112103 100644
--- a/man5/tmpfs.5
+++ b/man5/tmpfs.5
@@ -99,6 +99,11 @@ suffixes like
 .BR size ,
 but not a % suffix.
 .TP
+.BR noswap "(since Linux 6.4)"
+.\" commit 2c6efe9cf2d7841b75fe38ed1adbd41a90f51ba0
+Disables swap. Remounts must respect the original settings.
+By default swap is enabled.
+.TP
 .BR mode "=\fImode\fP"
 Set initial permissions of the root directory.
 .TP
-- 
2.39.2
Re: [PATCH] tmpfs.5: extend with new noswap documentation
Posted by Alejandro Colomar 2 years, 8 months ago
Hi Luis,

On 5/26/23 23:07, Luis Chamberlain wrote:
> Linux commit 2c6efe9cf2d7 ("shmem: add support to ignore swap")
> merged as of v6.4 added support to disable swap for tmpfs mounts.
> 
> This extends the man page to document that.
> 
> Signed-off-by: Luis Chamberlain <mcgrof@kernel.org>
> ---
>  man5/tmpfs.5 | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/man5/tmpfs.5 b/man5/tmpfs.5
> index 09d9558985e9..f7f90f112103 100644
> --- a/man5/tmpfs.5
> +++ b/man5/tmpfs.5
> @@ -99,6 +99,11 @@ suffixes like
>  .BR size ,
>  but not a % suffix.
>  .TP
> +.BR noswap "(since Linux 6.4)"
> +.\" commit 2c6efe9cf2d7841b75fe38ed1adbd41a90f51ba0
> +Disables swap. Remounts must respect the original settings.

Please use semantic newlines.  See man-pages(7):
   Use semantic newlines
       In the source of a manual page, new sentences should be started
       on  new  lines,  long  sentences  should be split into lines at
       clause breaks (commas, semicolons, colons, and so on), and long
       clauses should be split at phrase boundaries.  This convention,
       sometimes known as "semantic newlines", makes it easier to  see
       the  effect of patches, which often operate at the level of in‐
       dividual sentences, clauses, or phrases.

Thanks,
Alex

> +By default swap is enabled.
> +.TP
>  .BR mode "=\fImode\fP"
>  Set initial permissions of the root directory.
>  .TP

-- 
<http://www.alejandro-colomar.es/>
GPG key fingerprint: A9348594CE31283A826FBDD8D57633D441E25BB5