aboutsummaryrefslogtreecommitdiffstats
path: root/man7/man-pages.7
diff options
context:
space:
mode:
authorMichael Kerrisk <mtk.manpages@gmail.com>2017-04-21 15:39:23 +0200
committerMichael Kerrisk <mtk.manpages@gmail.com>2017-04-21 15:39:23 +0200
commit520caa5540b980c74010b5b22caba46594070164 (patch)
tree105bec335e71de63d313c1e11ac470c978a47bf4 /man7/man-pages.7
parent9152b8c9cf6e7a954160723869839e0c893910fa (diff)
downloadman-pages-520caa5540b980c74010b5b22caba46594070164.tar.gz
man-pages.7: Note preferred approach for 'duplicate' errors
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
Diffstat (limited to 'man7/man-pages.7')
-rw-r--r--man7/man-pages.78
1 files changed, 8 insertions, 0 deletions
diff --git a/man7/man-pages.7 b/man7/man-pages.7
index 5d43ed7cd0..3c3c3c7113 100644
--- a/man7/man-pages.7
+++ b/man7/man-pages.7
@@ -316,6 +316,14 @@ values that may be placed in
in the event of an error, along with information about the cause
of the errors.
+Where several different conditions produce the same error,
+the preferred approach is to create separate list entries
+(with duplicate error names) for each of the conditions.
+This makes the separate conditions clear, may make the list easier to read,
+and allows metainformation
+(e.g., kernel version number where the condition first became applicable)
+to be more easily marked for each condition.
+
.IR "The error list should be in alphabetical order" .
.TP
.B ENVIRONMENT