Skip site navigation (1)Skip section navigation (2)
Date:      Sat, 19 Dec 2020 14:54:28 +0000 (UTC)
From:      Gordon Bergling <gbe@FreeBSD.org>
To:        src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org
Subject:   svn commit: r368817 - in head/lib/libc: locale net stdlib sys x86/sys
Message-ID:  <202012191454.0BJEsSaH001310@repo.freebsd.org>

next in thread | raw e-mail | index | archive | help
Author: gbe (doc committer)
Date: Sat Dec 19 14:54:28 2020
New Revision: 368817
URL: https://svnweb.freebsd.org/changeset/base/368817

Log:
  libc: Fix most issues reported by mandoc
  
  - varios "new sentence, new line" warnings
  - varios "sections out of conventional order" warnings
  - varios "unusual Xr order" warnings
  - varios "missing section argument" warnings
  - varios "no blank before trailing delimiter" warnings
  - varios "normalizing date format" warnings
  
  MFC after:	1 month

Modified:
  head/lib/libc/locale/setlocale.3
  head/lib/libc/net/gethostbyname.3
  head/lib/libc/stdlib/system.3
  head/lib/libc/sys/_umtx_op.2
  head/lib/libc/sys/copy_file_range.2
  head/lib/libc/sys/execve.2
  head/lib/libc/sys/fhlink.2
  head/lib/libc/sys/open.2
  head/lib/libc/sys/pdfork.2
  head/lib/libc/sys/ptrace.2
  head/lib/libc/sys/revoke.2
  head/lib/libc/sys/rtprio.2
  head/lib/libc/sys/sendfile.2
  head/lib/libc/sys/thr_exit.2
  head/lib/libc/sys/thr_new.2
  head/lib/libc/sys/thr_self.2
  head/lib/libc/sys/thr_set_name.2
  head/lib/libc/sys/thr_suspend.2
  head/lib/libc/sys/thr_wake.2
  head/lib/libc/x86/sys/pkru.3

Modified: head/lib/libc/locale/setlocale.3
==============================================================================
--- head/lib/libc/locale/setlocale.3	Sat Dec 19 13:56:19 2020	(r368816)
+++ head/lib/libc/locale/setlocale.3	Sat Dec 19 14:54:28 2020	(r368817)
@@ -157,6 +157,15 @@ if the given combination of
 and
 .Fa locale
 makes no sense.
+.Sh FILES
+.Bl -tag -width /usr/share/locale/locale/category -compact
+.It Pa $PATH_LOCALE/ Ns Em locale/category
+.It Pa /usr/share/locale/ Ns Em locale/category
+locale file for the locale
+.Em locale
+and the category
+.Em category .
+.El
 .Sh EXAMPLES
 The following code illustrates how a program can initialize the
 international environment for one language, while selectively
@@ -176,15 +185,6 @@ following manner before using any of the locale-specif
 .Bd -literal
     setlocale(LC_ALL, "");
 .Ed
-.Sh FILES
-.Bl -tag -width /usr/share/locale/locale/category -compact
-.It Pa $PATH_LOCALE/ Ns Em locale/category
-.It Pa /usr/share/locale/ Ns Em locale/category
-locale file for the locale
-.Em locale
-and the category
-.Em category .
-.El
 .Sh ERRORS
 No errors are defined.
 .Sh SEE ALSO

Modified: head/lib/libc/net/gethostbyname.3
==============================================================================
--- head/lib/libc/net/gethostbyname.3	Sat Dec 19 13:56:19 2020	(r368816)
+++ head/lib/libc/net/gethostbyname.3	Sat Dec 19 14:54:28 2020	(r368817)
@@ -303,8 +303,27 @@ for example, a mail-forwarder may be registered for th
 .Xr hosts 5 ,
 .Xr hostname 7 ,
 .Xr named 8
-.Sh CAVEAT
+.Sh HISTORY
 The
+.Fn herror
+function appeared in
+.Bx 4.3 .
+The
+.Fn endhostent ,
+.Fn gethostbyaddr ,
+.Fn gethostbyname ,
+.Fn gethostent ,
+and
+.Fn sethostent
+functions appeared in
+.Bx 4.2 .
+The
+.Fn gethostbyname2
+function first appeared in
+.Tn BIND
+version 4.9.4.
+.Sh CAVEATS
+The
 .Fn gethostent
 function
 is defined, and
@@ -343,25 +362,6 @@ The
 .Fn endhostent
 function
 closes the file.
-.Sh HISTORY
-The
-.Fn herror
-function appeared in
-.Bx 4.3 .
-The
-.Fn endhostent ,
-.Fn gethostbyaddr ,
-.Fn gethostbyname ,
-.Fn gethostent ,
-and
-.Fn sethostent
-functions appeared in
-.Bx 4.2 .
-The
-.Fn gethostbyname2
-function first appeared in
-.Tn BIND
-version 4.9.4.
 .Sh BUGS
 These functions use a thread-specific data storage;
 if the data is needed for future use, it should be

Modified: head/lib/libc/stdlib/system.3
==============================================================================
--- head/lib/libc/stdlib/system.3	Sat Dec 19 13:56:19 2020	(r368816)
+++ head/lib/libc/stdlib/system.3	Sat Dec 19 14:54:28 2020	(r368817)
@@ -108,4 +108,4 @@ because all meta-characters supported by
 would be honored.
 User supplied parameters should always be carefully santized
 before they appear in
-.Fa string.
+.Fa string .

Modified: head/lib/libc/sys/_umtx_op.2
==============================================================================
--- head/lib/libc/sys/_umtx_op.2	Sat Dec 19 13:56:19 2020	(r368816)
+++ head/lib/libc/sys/_umtx_op.2	Sat Dec 19 14:54:28 2020	(r368817)
@@ -1180,7 +1180,7 @@ request:
 .It Dv UMTX_SHM_CREAT
 Creates the anonymous shared memory object, which can be looked up
 with the specified key
-.Fa uaddr.
+.Fa uaddr .
 If the object associated with the
 .Fa uaddr
 key already exists, it is returned instead of creating a new object.
@@ -1198,7 +1198,7 @@ the specified key
 an error is returned, and no new object is created.
 .It Dv UMTX_SHM_DESTROY
 De-associate the shared object with the specified key
-.Fa uaddr.
+.Fa uaddr .
 The object is destroyed after the last open file descriptor is closed
 and the last mapping for it is destroyed.
 .It Dv UMTX_SHM_ALIVE

Modified: head/lib/libc/sys/copy_file_range.2
==============================================================================
--- head/lib/libc/sys/copy_file_range.2	Sat Dec 19 13:56:19 2020	(r368816)
+++ head/lib/libc/sys/copy_file_range.2	Sat Dec 19 14:54:28 2020	(r368817)
@@ -117,7 +117,6 @@ with
 .Dv SEEK_DATA
 arguments and this system call for the
 data ranges found.
-.Pp
 .Sh RETURN VALUES
 If it succeeds, the call returns the number of bytes copied, which can be fewer
 than
@@ -144,11 +143,9 @@ will fail if:
 .Bl -tag -width Er
 .It Bq Er EBADF
 If
-.Fa
-infd
+.Fa infd
 is not open for reading or
-.Fa
-outfd
+.Fa outfd
 is not open for writing, or opened for writing with
 .Dv O_APPEND ,
 or if
@@ -175,8 +172,7 @@ are reset to the initial values for the system call.
 and
 .Fa outfd
 refer to the same file and the byte ranges overlap or
-.Fa
-flags
+.Fa flags
 is not zero.
 .It Bq Er EIO
 An I/O error occurred while reading/writing the files.

Modified: head/lib/libc/sys/execve.2
==============================================================================
--- head/lib/libc/sys/execve.2	Sat Dec 19 13:56:19 2020	(r368816)
+++ head/lib/libc/sys/execve.2	Sat Dec 19 14:54:28 2020	(r368817)
@@ -348,7 +348,7 @@ system call conforms to The Open Group Extended API Se
 The
 .Fn execve
 system call appeared in
-.At V7 .
+.At v7 .
 The
 .Fn fexecve
 system call appeared in

Modified: head/lib/libc/sys/fhlink.2
==============================================================================
--- head/lib/libc/sys/fhlink.2	Sat Dec 19 13:56:19 2020	(r368816)
+++ head/lib/libc/sys/fhlink.2	Sat Dec 19 14:54:28 2020	(r368817)
@@ -272,6 +272,6 @@ is not
 nor a file descriptor associated with a directory.
 .El
 .Sh SEE ALSO
-.Xr fhstat 2 ,
-.Xr fhreadlink 2 ,
 .Xr fhopen 2 ,
+.Xr fhreadlink 2 ,
+.Xr fhstat 2

Modified: head/lib/libc/sys/open.2
==============================================================================
--- head/lib/libc/sys/open.2	Sat Dec 19 13:56:19 2020	(r368816)
+++ head/lib/libc/sys/open.2	Sat Dec 19 14:54:28 2020	(r368817)
@@ -339,7 +339,7 @@ returns
 if any intermediate component of the specified relative path does not
 reside in the directory hierarchy beneath the topping directory.
 Comparing to
-.Dv O_BENEATH,
+.Dv O_BENEATH ,
 absolute paths or even the temporal escape from beneath of the topping
 directory is not allowed.
 .Pp

Modified: head/lib/libc/sys/pdfork.2
==============================================================================
--- head/lib/libc/sys/pdfork.2	Sat Dec 19 13:56:19 2020	(r368816)
+++ head/lib/libc/sys/pdfork.2	Sat Dec 19 14:54:28 2020	(r368817)
@@ -161,8 +161,8 @@ for
 .Xr fork 2 ,
 .Xr fstat 2 ,
 .Xr kill 2 ,
-.Xr poll 2 ,
 .Xr kqueue 2 ,
+.Xr poll 2 ,
 .Xr wait4 2 ,
 .Xr capsicum 4 ,
 .Xr procdesc 4

Modified: head/lib/libc/sys/ptrace.2
==============================================================================
--- head/lib/libc/sys/ptrace.2	Sat Dec 19 13:56:19 2020	(r368816)
+++ head/lib/libc/sys/ptrace.2	Sat Dec 19 14:54:28 2020	(r368817)
@@ -577,7 +577,7 @@ Only valid when
 or
 .Dv PL_FLAG_SCX
 is set in
-.Va pl_flags.
+.Va pl_flags .
 .It Va pl_syscall_narg
 The number of arguments passed to the current system call not counting
 the system call identifier.
@@ -588,7 +588,7 @@ Only valid when
 or
 .Dv PL_FLAG_SCX
 is set in
-.Va pl_flags.
+.Va pl_flags .
 .El
 .It Dv PT_GETNUMLWPS
 This request returns the number of kernel threads associated with the
@@ -622,7 +622,7 @@ The
 and
 .Fa data
 arguments are used the same as for
-.Dv PT_CONTINUE.
+.Dv PT_CONTINUE .
 .It Dv PT_TO_SCX
 This request will set the
 .Dv PTRACE_SCX
@@ -632,7 +632,7 @@ The
 and
 .Fa data
 arguments are used the same as for
-.Dv PT_CONTINUE.
+.Dv PT_CONTINUE .
 .It Dv PT_SYSCALL
 This request will set the
 .Dv PTRACE_SYSCALL
@@ -643,7 +643,7 @@ The
 and
 .Fa data
 arguments are used the same as for
-.Dv PT_CONTINUE.
+.Dv PT_CONTINUE .
 .It Dv PT_GET_SC_ARGS
 For the thread which is stopped in either
 .Dv PL_FLAG_SCE
@@ -698,7 +698,6 @@ value.
 If the system call completed in an unusual fashion,
 .Va sr_error
 is set to a negative value:
-.Pp
 .Bl -tag -width Dv EJUSTRETURN -compact
 .It Dv ERESTART
 System call will be restarted.
@@ -830,7 +829,6 @@ The
 .Fa data
 argument is ignored.
 .El
-.Pp
 .Sh x86 MACHINE-SPECIFIC REQUESTS
 .Bl -tag -width "Dv PT_GETXSTATE_INFO"
 .It Dv PT_GETXMMREGS
@@ -860,7 +858,7 @@ machine instruction
 .Dv FXRSTOR .
 .Pp
 As with
-.Dv PT_GETXMMREGS,
+.Dv PT_GETXMMREGS ,
 this request is only valid for i386 programs.
 .Pp
 The

Modified: head/lib/libc/sys/revoke.2
==============================================================================
--- head/lib/libc/sys/revoke.2	Sat Dec 19 13:56:19 2020	(r368816)
+++ head/lib/libc/sys/revoke.2	Sat Dec 19 14:54:28 2020	(r368817)
@@ -31,7 +31,7 @@
 .\"     @(#)revoke.2	8.1 (Berkeley) 6/4/93
 .\" $FreeBSD$
 .\"
-.Dd Jan 25, 2016
+.Dd January 25, 2016
 .Dt REVOKE 2
 .Os
 .Sh NAME

Modified: head/lib/libc/sys/rtprio.2
==============================================================================
--- head/lib/libc/sys/rtprio.2	Sat Dec 19 13:56:19 2020	(r368816)
+++ head/lib/libc/sys/rtprio.2	Sat Dec 19 14:54:28 2020	(r368817)
@@ -135,7 +135,10 @@ field ranges between 0 and
 .Pq usually 31 .
 0 is the highest possible priority.
 .Pp
-Realtime and idle priority is inherited through fork() and exec().
+Realtime and idle priority is inherited through
+.Fn fork
+and
+.Fn exec .
 .Pp
 A realtime thread can only be preempted by a thread of equal or
 higher priority, or by an interrupt; idle priority threads will run only

Modified: head/lib/libc/sys/sendfile.2
==============================================================================
--- head/lib/libc/sys/sendfile.2	Sat Dec 19 13:56:19 2020	(r368816)
+++ head/lib/libc/sys/sendfile.2	Sat Dec 19 14:54:28 2020	(r368817)
@@ -381,14 +381,14 @@ does not support
 The socket peer has closed the connection.
 .El
 .Sh SEE ALSO
-.Xr loader.conf 5 ,
 .Xr netstat 1 ,
 .Xr open 2 ,
 .Xr send 2 ,
 .Xr socket 2 ,
 .Xr writev 2 ,
-.Xr sysctl 8 ,
-.Xr tuning 7
+.Xr loader.conf 5 ,
+.Xr tuning 7 ,
+.Xr sysctl 8
 .Rs
 .%A K. Elmeleegy
 .%A A. Chanda
@@ -442,4 +442,4 @@ it will return
 and set
 .Va errno
 to
-.Er EINVAL.
+.Er EINVAL .

Modified: head/lib/libc/sys/thr_exit.2
==============================================================================
--- head/lib/libc/sys/thr_exit.2	Sat Dec 19 13:56:19 2020	(r368816)
+++ head/lib/libc/sys/thr_exit.2	Sat Dec 19 14:54:28 2020	(r368817)
@@ -72,12 +72,12 @@ A return from the function indicates that the calling 
 last one in the process.
 .Sh SEE ALSO
 .Xr _exit 2 ,
+.Xr _umtx_op 2 ,
 .Xr thr_kill 2 ,
 .Xr thr_kill2 2 ,
 .Xr thr_new 2 ,
 .Xr thr_self 2 ,
 .Xr thr_set_name 2 ,
-.Xr _umtx_op 2 ,
 .Xr pthread_exit 3
 .Sh STANDARDS
 The

Modified: head/lib/libc/sys/thr_new.2
==============================================================================
--- head/lib/libc/sys/thr_new.2	Sat Dec 19 13:56:19 2020	(r368816)
+++ head/lib/libc/sys/thr_new.2	Sat Dec 19 14:54:28 2020	(r368817)
@@ -225,6 +225,7 @@ There was not enough kernel memory to allocate the new
 .El
 .Sh SEE ALSO
 .Xr ps 1 ,
+.Xr _umtx_op 2 ,
 .Xr execve 2 ,
 .Xr racct 2 ,
 .Xr thr_exit 2 ,
@@ -232,7 +233,6 @@ There was not enough kernel memory to allocate the new
 .Xr thr_kill2 2 ,
 .Xr thr_self 2 ,
 .Xr thr_set_name 2 ,
-.Xr _umtx_op 2 ,
 .Xr pthread_create 3
 .Sh STANDARDS
 The

Modified: head/lib/libc/sys/thr_self.2
==============================================================================
--- head/lib/libc/sys/thr_self.2	Sat Dec 19 13:56:19 2020	(r368816)
+++ head/lib/libc/sys/thr_self.2	Sat Dec 19 14:54:28 2020	(r368817)
@@ -71,12 +71,12 @@ The memory pointed to by the
 argument is not valid.
 .El
 .Sh SEE ALSO
+.Xr _umtx_op 2 ,
 .Xr thr_exit 2 ,
 .Xr thr_kill 2 ,
 .Xr thr_kill2 2 ,
 .Xr thr_new 2 ,
 .Xr thr_set_name 2 ,
-.Xr _umtx_op 2 ,
 .Xr pthread_getthreadid_np 3 ,
 .Xr pthread_self 3
 .Sh STANDARDS

Modified: head/lib/libc/sys/thr_set_name.2
==============================================================================
--- head/lib/libc/sys/thr_set_name.2	Sat Dec 19 13:56:19 2020	(r368816)
+++ head/lib/libc/sys/thr_set_name.2	Sat Dec 19 14:54:28 2020	(r368817)
@@ -78,12 +78,12 @@ does not exist in the current process.
 .El
 .Sh SEE ALSO
 .Xr ps 1 ,
+.Xr _umtx_op 2 ,
 .Xr thr_exit 2 ,
 .Xr thr_kill 2 ,
 .Xr thr_kill2 2 ,
 .Xr thr_new 2 ,
 .Xr thr_self 2 ,
-.Xr _umtx_op 2 ,
 .Xr pthread_set_name_np 3 ,
 .Xr ddb 4 ,
 .Xr ktr 9

Modified: head/lib/libc/sys/thr_suspend.2
==============================================================================
--- head/lib/libc/sys/thr_suspend.2	Sat Dec 19 13:56:19 2020	(r368816)
+++ head/lib/libc/sys/thr_suspend.2	Sat Dec 19 14:54:28 2020	(r368817)
@@ -98,7 +98,6 @@ As with
 called from another thread, the next
 .Nm
 call does not result in suspension.
-.Pp
 .Sh RETURN VALUES
 .Rv -std thr_suspend
 .Sh ERRORS

Modified: head/lib/libc/sys/thr_wake.2
==============================================================================
--- head/lib/libc/sys/thr_wake.2	Sat Dec 19 13:56:19 2020	(r368816)
+++ head/lib/libc/sys/thr_wake.2	Sat Dec 19 14:54:28 2020	(r368817)
@@ -74,7 +74,7 @@ If
 .Fa id
 is not equal to the current thread identifier, the specified thread is
 woken up if suspended by the
-.Xr thr_suspend
+.Xr thr_suspend 2
 system call.
 If the thread is not suspended at the time of the
 .Nm

Modified: head/lib/libc/x86/sys/pkru.3
==============================================================================
--- head/lib/libc/x86/sys/pkru.3	Sat Dec 19 13:56:19 2020	(r368816)
+++ head/lib/libc/x86/sys/pkru.3	Sat Dec 19 14:54:28 2020	(r368817)
@@ -95,7 +95,7 @@ syscall.
 Per-key permissions are managed using the user-mode instructions
 .Em RDPKRU
 and
-.Em WRPKRU.
+.Em WRPKRU .
 The system provides convenient library helpers for both the syscall and
 the instructions, described below.
 .Pp



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202012191454.0BJEsSaH001310>