git: c796cc5afff2 - main - nlist.3: Move deprecation notice after intro
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Wed, 20 May 2026 15:09:33 UTC
The branch main has been updated by ziaee:
URL: https://cgit.FreeBSD.org/src/commit/?id=c796cc5afff2dffd542880c5f624439b25d74402
commit c796cc5afff2dffd542880c5f624439b25d74402
Author: Alexander Ziaee <ziaee@FreeBSD.org>
AuthorDate: 2026-05-20 15:06:31 +0000
Commit: Alexander Ziaee <ziaee@FreeBSD.org>
CommitDate: 2026-05-20 15:09:16 +0000
nlist.3: Move deprecation notice after intro
Its more clear and good practice for the first sentence of a description
to describe what something is, because there are a lot of different use
cases for documentation.
Fixes: 94b7a335683a ("nlist.3: Add discouraged use notice")
Reviewed by: emaste
Differential Revision: https://reviews.freebsd.org/D57128
---
lib/libc/gen/nlist.3 | 9 ++++-----
1 file changed, 4 insertions(+), 5 deletions(-)
diff --git a/lib/libc/gen/nlist.3 b/lib/libc/gen/nlist.3
index 4912180e9bcd..12a3dab41ab6 100644
--- a/lib/libc/gen/nlist.3
+++ b/lib/libc/gen/nlist.3
@@ -25,7 +25,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd May 19, 2026
+.Dd May 20, 2026
.Dt NLIST 3
.Os
.Sh NAME
@@ -40,10 +40,6 @@
.Sh DESCRIPTION
The
.Fn nlist
-function is provided for compatibility with legacy applications.
-Its use is discouraged.
-The
-.Fn nlist
function
retrieves name list entries from
.Xr elf 5
@@ -52,6 +48,9 @@ sections with type
or
.Dv SHT_SYMTAB
in an ELF object (for example, an executable file or shared library).
+This function is provided for compatibility with legacy applications.
+Its use is discouraged.
+.Pp
The argument
.Fa \&nl
is set to reference the