svn commit: r358891 - head/share/man/man5

[Ed Maste]

Author: emaste
Date: Wed Mar 11 18:15:18 2020
New Revision: 358891
URL: https://svnweb.freebsd.org/changeset/base/358891

Log:
  elf.5: start documenting ELF note sections
  
  I intend to document FreeBSD's ELF notes (see review D23982), but start
  with a section documenting the format of the note section itself.
  
  Sponsored by:	The FreeBSD Foundation

Modified:
  head/share/man/man5/elf.5

Modified: head/share/man/man5/elf.5
==============================================================================
--- head/share/man/man5/elf.5	Wed Mar 11 15:12:31 2020	(r358890)
+++ head/share/man/man5/elf.5	Wed Mar 11 18:15:18 2020	(r358891)
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd December 18, 2005
+.Dd March 11, 2020
 .Dt ELF 5
 .Os
 .Sh NAME
@@ -1276,6 +1276,26 @@ member.
 This member specifies a constant addend used to compute the value to be
 stored into the relocatable field.
 .El
+.Ss Note Section
+ELF note sections consist of entries with the following format.
+.Bl -column -offset indent "Sy Field" "Sy Size" "Sy Description"
+.It Sy Field Ta Sy Size Ta Sy Description
+.It namesz   Ta 32 bits Ta Size of "name"
+.It descsz   Ta 32 bits Ta Size of "desc"
+.It type     Ta 32 bits Ta OS-dependent note type
+.It name     Ta namesz  Ta Null-terminated originator name
+.It desc     Ta descsz  Ta OS-dependent note data
+.El
+.Pp
+The
+.Sy name
+and
+.Sy desc
+fields are padded to ensure 4-byte alignemnt.
+.Sy namesz
+and
+.Sy descsz
+specify the unpadded length.
 .Sh SEE ALSO
 .Xr as 1 ,
 .Xr gdb 1 ,