From: Christian Goeschel Ndjomouo <cgoesc2@wgu.edu>
Date: Wed, 24 Sep 2025 16:39:40 +0000 (-0400)
Subject: swapon: document --annotation option on the man page
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=577c22f372d62c51aefde8661866afb39a6f6df8;p=thirdparty%2Futil-linux.git

swapon: document --annotation option on the man page

Signed-off-by: Christian Goeschel Ndjomouo <cgoesc2@wgu.edu>
---

diff --git a/man-common/Makemodule.am b/man-common/Makemodule.am
index 11acb73de..5cbba1a5e 100644
--- a/man-common/Makemodule.am
+++ b/man-common/Makemodule.am
@@ -1,4 +1,5 @@
 ADOCFILES_COMMON += \
+	      man-common/annotation.adoc \
 	      man-common/bugreports.adoc \
 	      man-common/colors.adoc \
 	      man-common/footer.adoc \
diff --git a/man-common/annotation.adoc b/man-common/annotation.adoc
new file mode 100644
index 000000000..8f9d4c879
--- /dev/null
+++ b/man-common/annotation.adoc
@@ -0,0 +1,6 @@
+*--annotation*[**=**_when_]::
+Adds an annotation to column header names which can be printed as a
+tooltip by supporting terminals. The optional _when_ argument can be
+*always*, *never*, or *auto*. If the argument is omitted, it defaults to
+*auto*, which means that annotations will only be used when the output
+goes to a terminal.
diff --git a/man-common/meson.build b/man-common/meson.build
index b9fc92730..ffb7c1fee 100644
--- a/man-common/meson.build
+++ b/man-common/meson.build
@@ -1,4 +1,5 @@
 man_common_adocs = files(
+  'annotation.adoc',
   'bugreports.adoc',
   'colors.adoc',
   'footer.adoc',
diff --git a/po-man/po4a.cfg b/po-man/po4a.cfg
index 959ddb8bf..85ebc932e 100644
--- a/po-man/po4a.cfg
+++ b/po-man/po4a.cfg
@@ -1,6 +1,7 @@
 [po4a_langs] cs de es fr ko pl pt_BR ro sr uk
 [po4a_paths] util-linux-man.pot $lang:$lang.po
 
+[type:asciidoc] ../man-common/annotation.adoc    $lang:$lang/man-common/annotation.adoc    opt:"--keep 0"
 [type:asciidoc] ../man-common/bugreports.adoc    $lang:$lang/man-common/bugreports.adoc    opt:"--keep 0"
 [type:asciidoc] ../man-common/colors.adoc        $lang:$lang/man-common/colors.adoc        opt:"--keep 0"
 [type:asciidoc] ../man-common/footer-config.adoc $lang:$lang/man-common/footer-config.adoc opt:"--keep 0"
diff --git a/sys-utils/swapon.8.adoc b/sys-utils/swapon.8.adoc
index a9d7bbc22..29f3200ec 100644
--- a/sys-utils/swapon.8.adoc
+++ b/sys-utils/swapon.8.adoc
@@ -75,6 +75,8 @@ Display a definable table of swap areas. See the *--help* output for a list of a
 *--output-all*::
 Output all available columns.
 
+include::man-common/annotation.adoc[]
+
 *--noheadings*::
 Do not print headings when displaying *--show* output.