Module Name: src
Committed By: uwe
Date: Tue Oct 29 00:18:55 UTC 2024
Modified Files:
src/lib/libc/gen: fts.3
Log Message:
fts(3): Don't use top-level .Sh sections for functions
The list of possible .Sh sections in a man page is kinda limited
(think DTD, or schema). As a minimal fix use .Ss sub-sections for
now. It might be better to use tagged list with .Fn items that repeat
the arglist so that when you read the descriptions of the arguments
you actually see them, but that requires more intrusive editing.
To generate a diff of this commit:
cvs rdiff -u -r1.37 -r1.38 src/lib/libc/gen/fts.3
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/lib/libc/gen/fts.3
diff -u src/lib/libc/gen/fts.3:1.37 src/lib/libc/gen/fts.3:1.38
--- src/lib/libc/gen/fts.3:1.37 Mon Oct 28 10:01:08 2024
+++ src/lib/libc/gen/fts.3 Tue Oct 29 00:18:54 2024
@@ -1,4 +1,4 @@
-.\" $NetBSD: fts.3,v 1.37 2024/10/28 10:01:08 uwe Exp $
+.\" $NetBSD: fts.3,v 1.38 2024/10/29 00:18:54 uwe Exp $
.\"
.\" Copyright (c) 1989, 1991, 1993, 1994
.\" The Regents of the University of California. All rights reserved.
@@ -356,7 +356,7 @@ The
.Fa fts_name
field is always
.Tn NUL Ns -terminated .
-.Sh FTS_OPEN
+.Ss FTS_OPEN
The
.Fn fts_open
function takes a pointer to an array of character pointers naming one
@@ -522,7 +522,7 @@ returns
and sets
.Va errno
appropriately.
-.Sh FTS_READ
+.Ss FTS_READ
The
.Fn fts_read
function returns a pointer to an
@@ -576,7 +576,7 @@ after the
structure has been returned by the function
.Fn fts_read
in post-order.
-.Sh FTS_CHILDREN
+.Ss FTS_CHILDREN
The
.Fn fts_children
function returns a pointer to an
@@ -647,7 +647,7 @@ and
.Fa fts_namelen
fields.
.El
-.Sh FTS_SET
+.Ss FTS_SET
The function
.Fn fts_set
allows the user application to determine further processing for the
@@ -718,7 +718,7 @@ The file may be one of those most recent
or
.Fn fts_read .
.El
-.Sh FTS_CLOSE
+.Ss FTS_CLOSE
The
.Fn fts_close
function closes a file hierarchy stream
