Bring in an errno.9 manual page (based on NetBSD's).
authorSascha Wildner <saw@online.de>
Wed, 16 May 2018 07:18:38 +0000 (09:18 +0200)
committerSascha Wildner <saw@online.de>
Wed, 16 May 2018 07:18:38 +0000 (09:18 +0200)
lib/libc/sys/intro.2
share/man/man9/Makefile
share/man/man9/errno.9 [new file with mode: 0644]

index b3e35fb..d93efb3 100644 (file)
@@ -28,7 +28,7 @@
 .\"     @(#)intro.2    8.5 (Berkeley) 2/27/95
 .\" $FreeBSD: src/lib/libc/sys/intro.2,v 1.48 2007/01/09 00:28:14 imp Exp $
 .\"
-.Dd December 29, 2015
+.Dd May 16, 2018
 .Dt INTRO 2
 .Os
 .Sh NAME
@@ -749,4 +749,5 @@ chosen from the address family in which the socket was created.
 .El
 .Sh SEE ALSO
 .Xr intro 3 ,
-.Xr perror 3
+.Xr perror 3 ,
+.Xr errno 9
index 66e90f8..cb0cf1d 100644 (file)
@@ -79,6 +79,7 @@ MAN=  accept_filter.9 \
        devtoname.9 \
        driver.9 \
        DRIVER_MODULE.9 \
+       errno.9 \
        EVENTHANDLER.9 \
        extattr.9 \
        fetch.9 \
diff --git a/share/man/man9/errno.9 b/share/man/man9/errno.9
new file mode 100644 (file)
index 0000000..a99c515
--- /dev/null
@@ -0,0 +1,96 @@
+.\"    $NetBSD: errno.9,v 1.5 2010/03/22 18:58:33 joerg Exp $
+.\"
+.\" Copyright (c) 2004 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed to The NetBSD Foundation
+.\" by Andrew Brown.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.Dd May 16, 2018
+.Dt ERRNO 9
+.Os
+.Sh NAME
+.Nm errno
+.Nd kernel internal error numbers
+.Sh SYNOPSIS
+.In sys/errno.h
+.Sh DESCRIPTION
+This section provides an overview of the error numbers used internally
+by the kernel and indicate neither success nor failure.
+These error numbers are not returned to userland code.
+.Sh DIAGNOSTICS
+Kernel functions that indicate success or failure by means of either 0
+or an
+.Xr errno 2
+value sometimes have a need to indicate that
+.Dq special
+handling is required at an upper layer or, in the case of
+.Xr ioctl 2
+processing, that
+.Dq nothing was wrong but the request was not handled .
+To handle these cases, some negative
+.Xr errno 2
+values are defined which are handled by the kernel before returning a
+different
+.Xr errno 2
+value to userland or simply zero.
+.Pp
+The following is a list of the defined names and their meanings as
+given in
+.In errno.h .
+.\"It is important to note that the value \-1 is
+.\".Em not
+.\"used, since it is commonly used to indicate generic failure and leaves
+.\"it up to the caller to determine the action to take.
+.Bl -hang -width Ds
+.It Er \-1 ERESTART Em "Restart syscall" .
+The system call should be restarted.
+This typically means that the machine dependent system call trap code
+will reposition the process's instruction pointer or program counter
+to re-execute the current system call with no other work required.
+.It Er \-2 EJUSTRETURN Em "Do not modify regs, just return" .
+No more work is required and the function should just return.
+.It Er \-3 ENOIOCTL Em "Ioctl not handled by this layer" .
+The
+.Xr ioctl 2
+was not handled and should be passed through to another layer.
+.It Er \-4 EMOUNTEXIT Em "Mountpoint released via vfs_start()" .
+Specific to
+.Xr mfs 4 .
+.El
+.Sh SEE ALSO
+.Xr errno 2 ,
+.Xr ioctl 9
+.Sh HISTORY
+An
+.Nm
+manual page appeared in
+.At v6 .
+This
+.Nm
+manual page appeared in
+.Nx 3.0 .