[PATCH v1] man/man5/{ld.so,tunables}.conf.5: Add subsections

[PATCH v1] man/man5/{ld.so,tunables}.conf.5: Add subsections

[Alejandro Colomar]

[-- Attachment #1: Type: text/plain, Size: 3903 bytes --]

Signed-off-by: Alejandro Colomar <alx@kernel.org>
---

Hi DJ,

This is a patch for improving a little bit the organization of the two
files.  Here's how it looks after formatting:

	$ MANWIDTH=64 diffman-git HEAD--- HEAD^:man/man5/ld.so.conf.5
	+++ HEAD:man/man5/ld.so.conf.5
	@@ -13,6 +13,7 @@ DESCRIPTION
	      The file is parsed by ldconfig(8) and the results stored
	      in /etc/ld.so.cache.
	 
	+   Directives
	      The syntax allows lines to start with the keyword include
	      followed by a glob(7) pattern.  Files matching that pat‐
	      tern will be processed as if their contents were included
	--- HEAD^:man/man5/tunables.conf.5
	+++ HEAD:man/man5/tunables.conf.5
	@@ -21,14 +21,19 @@ DESCRIPTION
	      program starts execution.
	 
	      Each line in the file /etc/tunables.conf specifies a tun‐
	-     able, which is specified with a string of the form
	+     able, a directive, or a filter.
	+
	+   Tunables
	+     A tunable is specified with a string of the form
	      name=value.
	 
	+   Directives
	      The syntax allows lines to start with the keyword include
	      followed by a glob(7) pattern.  Files matching that pat‐
	      tern will be processed as if their contents were included
	      at that point.
	 
	+   Modifiers
	      Each line may include zero or more keywords or symbols at
	      the beginning, which affect how each tunable affects each
	      processes.  The keywords must be separated by whitespace,
	@@ -56,9 +61,9 @@ DESCRIPTION
	      *      The tunable applies to both AT_SECURE and non‐
		     AT_SECURE processes.
	 
	-     The file may also contain filters, which limit the tun‐
	-     ables following it.  The effects of a filter are termi‐
	-     nated by any of the following:
	+   Filters
	+     Filters limit the tunables following it.  The effects of a
	+     filter are terminated by any of the following:
	 
	      •  The end of the file.
	      •  The end of an included file.


Let me know what you think.


Have a lovely night!
Alex

 man/man5/ld.so.conf.5    |  2 +-
 man/man5/tunables.conf.5 | 18 ++++++++++--------
 2 files changed, 11 insertions(+), 9 deletions(-)

diff --git a/man/man5/ld.so.conf.5 b/man/man5/ld.so.conf.5
index d9fae3c1f377..a94e82747f9d 100644
--- a/man/man5/ld.so.conf.5
+++ b/man/man5/ld.so.conf.5
@@ -14,7 +14,7 @@ .SH DESCRIPTION
 .BR \%ldconfig (8)
 and the results stored in
 .IR /etc/ld.so.cache .
-.P
+.SS Directives
 The syntax allows lines to start with the keyword
 .B include
 followed by a
diff --git a/man/man5/tunables.conf.5 b/man/man5/tunables.conf.5
index a27f78cde6f7..91bb6b81cb85 100644
--- a/man/man5/tunables.conf.5
+++ b/man/man5/tunables.conf.5
@@ -27,10 +27,14 @@ .SH DESCRIPTION
 .P
 Each line in the file
 .I /etc/tunables.conf
-specifies a tunable,
-which is specified with a string of the form
+specifies
+a tunable,
+a directive,
+or a filter.
+.SS Tunables
+A tunable is specified with a string of the form
 .IB name = value \f[R].\f[]
-.P
+.SS Directives
 The syntax allows lines to start with the keyword
 .B include
 followed by a
@@ -38,7 +42,7 @@ .SH DESCRIPTION
 pattern.
 Files matching that pattern will be processed
 as if their contents were included at that point.
-.P
+.SS Modifiers
 Each line may include zero or more keywords or symbols at the beginning,
 which affect how each tunable affects each processes.
 The keywords must be separated by whitespace,
@@ -81,10 +85,8 @@ .SH DESCRIPTION
 and
 .RB non- AT_SECURE
 processes.
-.P
-The file may also contain
-.IR filters ,
-which limit the tunables following it.
+.SS Filters
+Filters limit the tunables following it.
 The effects of a filter are terminated by
 any of the following:
 .IP \[bu] 3

base-commit: 6bb006086657277c670f120981aeb41d6a4ea14c
-- 
2.53.0


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]