From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wr1-x430.google.com (mail-wr1-x430.google.com [IPv6:2a00:1450:4864:20::430]) by sourceware.org (Postfix) with ESMTPS id AE1483851C04 for ; Mon, 15 Feb 2021 20:32:00 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org AE1483851C04 Received: by mail-wr1-x430.google.com with SMTP id n8so10494433wrm.10 for ; Mon, 15 Feb 2021 12:32:00 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:cc:subject:to:references:from:message-id:date :user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=z1DzNld3xDeT0xMdu2koXPwqzhRDPbzb1j6g/o3wVYo=; b=LamCM7vge6dPRSedDwTOIhNTHuyoik7opLAKwH8bC3ljAs0LoQhIZTQEIsu8X3h6LP +PQkihNe6wPap7xzSwpRla1zsQXepo3XPnABR/OFSxKpaYQLYyFV2tnB2jc7mo9XCMRH nBShOZymahb7o6QPOcFaG78UiW/kO5K0Iardg0oSt3juvDtD8s3mJI4JqNtOrFFeOREj D20z4CeFNinnw5zu846doPE36hTKaLUDtuo0vNTlWFrgGwiV2M/xRMRyUyDqueMEARO+ iEzKatWLaQzS8/vG+3ClOP4rXZoAWLFm7/ofPuy5K8vOaBSK4aFe4vKNkXmGK/c6G/Ki xr2Q== X-Gm-Message-State: AOAM533BhpQUA6qjKoS8fSrsnDppdx45/Ozq2MlFvzrc6UTf7b9knQbr HhB1TgaF3yHqM/RAYQOtYJTIRWlT+OZSew== X-Google-Smtp-Source: ABdhPJzzBPTusItjoVG/nAHSc3k+fPLHOz7+egBEZhkYM9Xs7osI8uSVAEKCpKPh9iMyjDaLUdTBGw== X-Received: by 2002:adf:d1cb:: with SMTP id b11mr20720601wrd.118.1613421119548; Mon, 15 Feb 2021 12:31:59 -0800 (PST) Received: from ?IPv6:2001:a61:3a2d:1d01:e14:1e8b:dca4:7d73? ([2001:a61:3a2d:1d01:e14:1e8b:dca4:7d73]) by smtp.gmail.com with ESMTPSA id r12sm466092wmg.44.2021.02.15.12.31.58 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Mon, 15 Feb 2021 12:31:59 -0800 (PST) Cc: mtk.manpages@gmail.com, linux-man@vger.kernel.org, libc-alpha@sourceware.org Subject: Re: [PATCH v3] simpleq.3, stailq.3, queue.7, SIMPLEQ_*.3: Document SIMPLEQ_*() as an alias to STAILQ_*() macros To: Alejandro Colomar References: <20210215161243.517608-1-alx.manpages@gmail.com> <20210215163236.518482-1-alx.manpages@gmail.com> From: "Michael Kerrisk (man-pages)" Message-ID: Date: Mon, 15 Feb 2021 21:31:56 +0100 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.6.0 MIME-Version: 1.0 In-Reply-To: <20210215163236.518482-1-alx.manpages@gmail.com> Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit X-Spam-Status: No, score=-11.4 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, FREEMAIL_FROM, GIT_PATCH_0, KAM_SHORT, NICE_REPLY_A, RCVD_IN_DNSWL_NONE, SPF_HELO_NONE, SPF_PASS, TXREP autolearn=ham autolearn_force=no version=3.4.2 X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on server2.sourceware.org X-BeenThere: libc-alpha@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Libc-alpha mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 15 Feb 2021 20:32:02 -0000 Hi Alex, On 2/15/21 5:32 PM, Alejandro Colomar wrote: > Signed-off-by: Alejandro Colomar > --- > > v2: Add link: simpleq.3 -> stailq.3 (for symmetry) Thanks. Patch applied. Cheers, Michael > > v3: Resend (typo in email) > > --- > man3/SIMPLEQ_EMPTY.3 | 1 + > man3/SIMPLEQ_ENTRY.3 | 1 + > man3/SIMPLEQ_FIRST.3 | 1 + > man3/SIMPLEQ_FOREACH.3 | 1 + > man3/SIMPLEQ_HEAD.3 | 1 + > man3/SIMPLEQ_HEAD_INITIALIZER.3 | 1 + > man3/SIMPLEQ_INIT.3 | 1 + > man3/SIMPLEQ_INSERT_AFTER.3 | 1 + > man3/SIMPLEQ_INSERT_HEAD.3 | 1 + > man3/SIMPLEQ_INSERT_TAIL.3 | 1 + > man3/SIMPLEQ_NEXT.3 | 1 + > man3/SIMPLEQ_REMOVE.3 | 1 + > man3/SIMPLEQ_REMOVE_HEAD.3 | 1 + > man3/simpleq.3 | 1 + > man3/stailq.3 | 31 +++++++++++++++++++++++++++++++ > man7/queue.7 | 9 +++++++++ > 16 files changed, 54 insertions(+) > create mode 100644 man3/SIMPLEQ_EMPTY.3 > create mode 100644 man3/SIMPLEQ_ENTRY.3 > create mode 100644 man3/SIMPLEQ_FIRST.3 > create mode 100644 man3/SIMPLEQ_FOREACH.3 > create mode 100644 man3/SIMPLEQ_HEAD.3 > create mode 100644 man3/SIMPLEQ_HEAD_INITIALIZER.3 > create mode 100644 man3/SIMPLEQ_INIT.3 > create mode 100644 man3/SIMPLEQ_INSERT_AFTER.3 > create mode 100644 man3/SIMPLEQ_INSERT_HEAD.3 > create mode 100644 man3/SIMPLEQ_INSERT_TAIL.3 > create mode 100644 man3/SIMPLEQ_NEXT.3 > create mode 100644 man3/SIMPLEQ_REMOVE.3 > create mode 100644 man3/SIMPLEQ_REMOVE_HEAD.3 > create mode 100644 man3/simpleq.3 > > diff --git a/man3/SIMPLEQ_EMPTY.3 b/man3/SIMPLEQ_EMPTY.3 > new file mode 100644 > index 000000000..fbb71f02c > --- /dev/null > +++ b/man3/SIMPLEQ_EMPTY.3 > @@ -0,0 +1 @@ > +.so man3/stailq.3 > diff --git a/man3/SIMPLEQ_ENTRY.3 b/man3/SIMPLEQ_ENTRY.3 > new file mode 100644 > index 000000000..fbb71f02c > --- /dev/null > +++ b/man3/SIMPLEQ_ENTRY.3 > @@ -0,0 +1 @@ > +.so man3/stailq.3 > diff --git a/man3/SIMPLEQ_FIRST.3 b/man3/SIMPLEQ_FIRST.3 > new file mode 100644 > index 000000000..fbb71f02c > --- /dev/null > +++ b/man3/SIMPLEQ_FIRST.3 > @@ -0,0 +1 @@ > +.so man3/stailq.3 > diff --git a/man3/SIMPLEQ_FOREACH.3 b/man3/SIMPLEQ_FOREACH.3 > new file mode 100644 > index 000000000..fbb71f02c > --- /dev/null > +++ b/man3/SIMPLEQ_FOREACH.3 > @@ -0,0 +1 @@ > +.so man3/stailq.3 > diff --git a/man3/SIMPLEQ_HEAD.3 b/man3/SIMPLEQ_HEAD.3 > new file mode 100644 > index 000000000..fbb71f02c > --- /dev/null > +++ b/man3/SIMPLEQ_HEAD.3 > @@ -0,0 +1 @@ > +.so man3/stailq.3 > diff --git a/man3/SIMPLEQ_HEAD_INITIALIZER.3 b/man3/SIMPLEQ_HEAD_INITIALIZER.3 > new file mode 100644 > index 000000000..fbb71f02c > --- /dev/null > +++ b/man3/SIMPLEQ_HEAD_INITIALIZER.3 > @@ -0,0 +1 @@ > +.so man3/stailq.3 > diff --git a/man3/SIMPLEQ_INIT.3 b/man3/SIMPLEQ_INIT.3 > new file mode 100644 > index 000000000..fbb71f02c > --- /dev/null > +++ b/man3/SIMPLEQ_INIT.3 > @@ -0,0 +1 @@ > +.so man3/stailq.3 > diff --git a/man3/SIMPLEQ_INSERT_AFTER.3 b/man3/SIMPLEQ_INSERT_AFTER.3 > new file mode 100644 > index 000000000..fbb71f02c > --- /dev/null > +++ b/man3/SIMPLEQ_INSERT_AFTER.3 > @@ -0,0 +1 @@ > +.so man3/stailq.3 > diff --git a/man3/SIMPLEQ_INSERT_HEAD.3 b/man3/SIMPLEQ_INSERT_HEAD.3 > new file mode 100644 > index 000000000..fbb71f02c > --- /dev/null > +++ b/man3/SIMPLEQ_INSERT_HEAD.3 > @@ -0,0 +1 @@ > +.so man3/stailq.3 > diff --git a/man3/SIMPLEQ_INSERT_TAIL.3 b/man3/SIMPLEQ_INSERT_TAIL.3 > new file mode 100644 > index 000000000..fbb71f02c > --- /dev/null > +++ b/man3/SIMPLEQ_INSERT_TAIL.3 > @@ -0,0 +1 @@ > +.so man3/stailq.3 > diff --git a/man3/SIMPLEQ_NEXT.3 b/man3/SIMPLEQ_NEXT.3 > new file mode 100644 > index 000000000..fbb71f02c > --- /dev/null > +++ b/man3/SIMPLEQ_NEXT.3 > @@ -0,0 +1 @@ > +.so man3/stailq.3 > diff --git a/man3/SIMPLEQ_REMOVE.3 b/man3/SIMPLEQ_REMOVE.3 > new file mode 100644 > index 000000000..fbb71f02c > --- /dev/null > +++ b/man3/SIMPLEQ_REMOVE.3 > @@ -0,0 +1 @@ > +.so man3/stailq.3 > diff --git a/man3/SIMPLEQ_REMOVE_HEAD.3 b/man3/SIMPLEQ_REMOVE_HEAD.3 > new file mode 100644 > index 000000000..fbb71f02c > --- /dev/null > +++ b/man3/SIMPLEQ_REMOVE_HEAD.3 > @@ -0,0 +1 @@ > +.so man3/stailq.3 > diff --git a/man3/simpleq.3 b/man3/simpleq.3 > new file mode 100644 > index 000000000..fbb71f02c > --- /dev/null > +++ b/man3/simpleq.3 > @@ -0,0 +1 @@ > +.so man3/stailq.3 > diff --git a/man3/stailq.3 b/man3/stailq.3 > index b43f9c60b..22582eeae 100644 > --- a/man3/stailq.3 > +++ b/man3/stailq.3 > @@ -31,6 +31,26 @@ > .\" > .TH STAILQ 3 2020-10-21 "GNU" "Linux Programmer's Manual" > .SH NAME > +.\"SIMPLEQ_CONCAT, > +SIMPLEQ_EMPTY, > +SIMPLEQ_ENTRY, > +SIMPLEQ_FIRST, > +SIMPLEQ_FOREACH, > +.\"SIMPLEQ_FOREACH_FROM, > +.\"SIMPLEQ_FOREACH_FROM_SAFE, > +.\"SIMPLEQ_FOREACH_SAFE, > +SIMPLEQ_HEAD, > +SIMPLEQ_HEAD_INITIALIZER, > +SIMPLEQ_INIT, > +SIMPLEQ_INSERT_AFTER, > +SIMPLEQ_INSERT_HEAD, > +SIMPLEQ_INSERT_TAIL, > +.\"SIMPLEQ_LAST, > +SIMPLEQ_NEXT, > +SIMPLEQ_REMOVE, > +.\"SIMPLEQ_REMOVE_AFTER, > +SIMPLEQ_REMOVE_HEAD, > +.\"SIMPLEQ_SWAP, > STAILQ_CONCAT, > STAILQ_EMPTY, > STAILQ_ENTRY, > @@ -96,6 +116,8 @@ STAILQ_REMOVE_HEAD, > .\" .BI "void STAILQ_SWAP(STAILQ_HEAD *" head1 ", STAILQ_HEAD *" head2 , > .\" .BI " STAILQ_ENTRY " NAME ); > .fi > +.IR Note : > +Identical macros prefixed with SIMPLEQ instead of STAILQ exist; see NOTES. > .SH DESCRIPTION > These macros define and operate on singly linked tail queues. > .PP > @@ -299,6 +321,15 @@ fixes this limitation by allowing > .I var > to safely be removed from the list and freed from within the loop > without interfering with the traversal. > +.SH NOTES > +Some BSDs provide SIMPLEQ instead of STAILQ. > +They are identical, but for historical reasons > +they were named differently on different BSDs. > +STAILQ originated on FreeBSD, and SIMPLEQ originated on NetBSD. > +For compatibility reasons, some systems provide both sets of macros. > +Glibc provides both STAILQ and SIMPLEQ, > +which are identical except for a missing SIMPLEQ equivalent to > +.BR STAILQ_CONCAT (). > .SH EXAMPLES > .EX > #include > diff --git a/man7/queue.7 b/man7/queue.7 > index f92887a36..c3facafd0 100644 > --- a/man7/queue.7 > +++ b/man7/queue.7 > @@ -138,6 +138,15 @@ Not in POSIX.1, POSIX.1-2001, or POSIX.1-2008. > Present on the BSDs. > .I > macros first appeared in 4.4BSD. > +.SH NOTES > +Some BSDs provide SIMPLEQ instead of STAILQ. > +They are identical, but for historical reasons > +they were named differently on different BSDs. > +STAILQ originated on FreeBSD, and SIMPLEQ originated on NetBSD. > +For compatibility reasons, some systems provide both sets of macros. > +Glibc provides both STAILQ and SIMPLEQ, > +which are identical except for a missing SIMPLEQ equivalent to > +.BR STAILQ_CONCAT (). > .SH SEE ALSO > .BR circleq (3), > .BR insque (3), > -- Michael Kerrisk Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/ Linux/UNIX System Programming Training: http://man7.org/training/