bpf-helpers.7: Refresh against Linux 5.0-rc8

[thirdparty/man-pages.git] / man3 / insque.3

diff --git a/man3/insque.3 b/man3/insque.3
index b540bffc1df5eab0a28352405dd7daf8abc673a2..b6e07bb1cfec0cad1a5161e91b5f1d080a537b9d 100644 (file)
--- a/man3/insque.3
+++ b/man3/insque.3
@@ -2,6 +2,7 @@
 .\" $Id: insque.3,v 1.2 1996/10/30 21:03:39 meem Exp meem $
 .\" and Copyright (c) 2010, Michael Kerrisk <mtk.manpages@gmail.com>
 .\"
+.\" %%%LICENSE_START(VERBATIM)
 .\" Permission is granted to make and distribute verbatim copies of this
 .\" manual provided the copyright notice and this permission notice are
 .\" preserved on all copies.
@@ -21,6 +22,7 @@
 .\"
 .\" Formatted or processed versions of this manual, if unaccompanied by
 .\" the source, must acknowledge the copyright and authors of this work.
+.\" %%%LICENSE_END
 .\"
 .\" References consulted:
 .\"   Linux libc source code (5.4.7)
@@ -31,26 +33,33 @@
 .\" mtk, 2010-09-09: Noted glibc 2.4 bug, added info on circular
 .\"    lists, added example program
 .\"
-.TH INSQUE 3  2010-09-09 "" "Linux Programmer's Manual"
+.TH INSQUE 3  2017-09-15 "" "Linux Programmer's Manual"
 .SH NAME
 insque, remque \- insert/remove an item from a queue
 .SH SYNOPSIS
 .nf
 .B #include <search.h>
-.sp
+.PP
 .BI "void insque(void *" elem ", void *" prev );
-
+.PP
 .BI "void remque(void *" elem );
 .fi
-.sp
+.PP
 .in -4n
 Feature Test Macro Requirements for glibc (see
 .BR feature_test_macros (7)):
 .in
-.sp
+.PP
+.ad l
 .BR insque (),
 .BR remque ():
-_SVID_SOURCE || _XOPEN_SOURCE\ >=\ 500
+.RS 4
+_XOPEN_SOURCE\ >=\ 500
+.\"    || _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
+    || /* Glibc since 2.19: */ _DEFAULT_SOURCE
+    || /* Glibc versions <= 2.19: */ _SVID_SOURCE
+.RE
+.ad
 .SH DESCRIPTION
 The
 .BR insque ()
@@ -63,19 +72,19 @@ backward pointer.
 The linked list may be linear (i.e., NULL forward pointer at
 the end of the list and NULL backward pointer at the start of the list)
 or circular.
-
+.PP
 The
 .BR insque ()
 function inserts the element pointed to by \fIelem\fP
 immediately after the element pointed to by \fIprev\fP.
-
+.PP
 If the list is linear, then the call
 .I "insque(elem, NULL)"
 can be used to insert the initial list element,
 and the call sets the forward and backward pointers of
 .I elem
 to NULL.
-
+.PP
 If the list is circular,
 the caller should ensure that the forward and backward pointers of the
 first element are initialized to point to that element,
@@ -84,39 +93,54 @@ and the
 argument of the
 .BR insque ()
 call should also point to the element.
-
+.PP
 The
 .BR remque ()
 function removes the element pointed to by \fIelem\fP from the
 doubly-linked list.
-.SH "CONFORMING TO"
-POSIX.1-2001.
-.SH "NOTES"
-Traditionally (e.g., SunOS, Linux libc 4 and libc 5),
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lb lb lb
+l l l.
+Interface      Attribute       Value
+T{
+.BR insque (),
+.BR remque ()
+T}     Thread safety   MT-Safe
+.TE
+.sp 1
+.SH CONFORMING TO
+POSIX.1-2001, POSIX.1-2008.
+.SH NOTES
+On ancient systems,
+.\" e.g., SunOS, Linux libc4 and libc5
 the arguments of these functions were of type \fIstruct qelem *\fP,
 defined as:
-
+.PP
 .in +4n
-.nf
+.EX
 struct qelem {
     struct qelem *q_forw;
     struct qelem *q_back;
     char          q_data[1];
 };
-.fi
+.EE
 .in
-
+.PP
 This is still what you will get if
 .B _GNU_SOURCE
 is defined before
 including \fI<search.h>\fP.
-
+.PP
 The location of the prototypes for these functions differs among several
-versions of Unix.
+versions of UNIX.
 The above is the POSIX version.
 Some systems place them in \fI<string.h>\fP.
-Linux libc4 and libc 5 placed them
-in \fI<stdlib.h>\fP.
+.\" Linux libc4 and libc 5 placed them
+.\" in \fI<stdlib.h>\fP.
 .SH BUGS
 In glibc 2.4 and earlier, it was not possible to specify
 .I prev
@@ -128,20 +152,20 @@ with the forward and backward pointers in each element suitably initialized.
 The program below demonstrates the use of
 .BR insque ().
 Here is an example run of the program:
+.PP
 .in +4n
-.nf
-
+.EX
 .RB "$ " "./a.out -c a b c"
 Traversing completed list:
     a
     b
     c
 That was a circular list
-.fi
+.EE
 .in
 .SS Program source
 \&
-.nf
+.EX
 #include <stdio.h>
 #include <stdlib.h>
 #include <unistd.h>
@@ -160,7 +184,7 @@ new_element(void)
 
     e = malloc(sizeof(struct element));
     if (e == NULL) {
-        fprintf(stderr, "malloc() failed\\n");
+        fprintf(stderr, "malloc() failed\en");
         exit(EXIT_FAILURE);
     }
 
@@ -190,7 +214,7 @@ main(int argc, char *argv[])
     }
 
     if (errfnd || optind >= argc) {
-        fprintf(stderr,  "Usage: %s [\-c] string...\\n", argv[0]);
+        fprintf(stderr,  "Usage: %s [\-c] string...\en", argv[0]);
         exit(EXIT_FAILURE);
     }
 
@@ -200,7 +224,7 @@ main(int argc, char *argv[])
     first = elem;
 
     elem\->name = argv[optind];
-    
+
     if (circular) {
         elem\->forward = elem;
         elem\->backward = elem;
@@ -221,16 +245,18 @@ main(int argc, char *argv[])
 
     /* Traverse the list from the start, printing element names */
 
-    printf("Traversing completed list:\\n");
+    printf("Traversing completed list:\en");
     elem = first;
     do {
-        printf("    %s\\n", elem\->name);
+        printf("    %s\en", elem\->name);
         elem = elem\->forward;
     } while (elem != NULL && elem != first);
 
     if (elem == first)
-        printf("That was a circular list\\n");
+        printf("That was a circular list\en");
 
     exit(EXIT_SUCCESS);
 }
-.fi
+.EE
+.SH SEE ALSO
+.BR queue (3)