From patchwork Thu Oct 22 12:38:19 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alejandro Colomar X-Patchwork-Id: 40819 Return-Path: X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 1F3123985467; Thu, 22 Oct 2020 12:39:02 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 1F3123985467 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1603370342; bh=z7DcKQj8jwUawLT2cwqp0IYBY0Cpolmw6d7FFGtyY0w=; h=To:Subject:Date:In-Reply-To:References:List-Id:List-Unsubscribe: List-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:Cc: From; b=g33x4xxn5G0cu8W+8pAdMnL6cQnBIpUToLTFLseoUuRZqo3JZSiuKG78SEgPn8zoH r/uP4BkpabL5kJVo2k30UQ/hNc7W/fEv5s3hEAtlRmf3G3AoCAMSTS7uGE4K+trRvQ WAh+TNXr3OLGaQDqUIS1qfcmWPeq0U29pjyrduFI= X-Original-To: libc-alpha@sourceware.org Delivered-To: libc-alpha@sourceware.org Received: from mail-wm1-x344.google.com (mail-wm1-x344.google.com [IPv6:2a00:1450:4864:20::344]) by sourceware.org (Postfix) with ESMTPS id 07F173857005 for ; Thu, 22 Oct 2020 12:38:59 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org 07F173857005 Received: by mail-wm1-x344.google.com with SMTP id q5so2040200wmq.0 for ; Thu, 22 Oct 2020 05:38:58 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=z7DcKQj8jwUawLT2cwqp0IYBY0Cpolmw6d7FFGtyY0w=; b=YRKRCZcvW2nkehxqupc4wkBjHapnbia5xVORK/prHbDRn23+j7bVpXkyKNUmYmPKZJ lkI1wN8fm8PqQp46sTZvHdceOKmeS1jbh0fU15GgI/tS7LtLiyns3/6ayOzX6QbVKOIu UZ/EVPq50bnWhfdqhNXCVT90wFbZffK0qQVRyqJNCX05RFSOSQpNM8w3TdxjSgOeWqrm /kYb7WFEeEZ46Gzg/BMXwKcb5qyCwd7GjEPXDVQ4KaYDUMfELl/2iX39lgtpVrDck5od FuTgoFuRuB4AxA/EKwADL9Jrp9lDOq/aCWhbZFIjyp/G/NiLP1b2PG92DWa3cssZG+kv 83/A== X-Gm-Message-State: AOAM532yFZWHu3yGcisok57jhLf9bGyyWsIyMspiRiHaZCa4DU8ht5Pd BveYiSeKEGlsKlRjOoSteyAn+mhcdUs= X-Google-Smtp-Source: ABdhPJwpE0QG3nrjxNpmVitDR3L+xv/qRg1li7y8yoWFoiCxHRBi4KvlFaTCppkkdRiknnzU+TdjFg== X-Received: by 2002:a1c:59c3:: with SMTP id n186mr2370558wmb.32.1603370338089; Thu, 22 Oct 2020 05:38:58 -0700 (PDT) Received: from debian-VLC.home ([170.253.60.68]) by smtp.googlemail.com with ESMTPSA id m1sm3573883wme.48.2020.10.22.05.38.57 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 22 Oct 2020 05:38:57 -0700 (PDT) To: mtk.manpages@gmail.com Subject: [PATCH 07/10] slist.3: ffix: Use man markup Date: Thu, 22 Oct 2020 14:38:19 +0200 Message-Id: <20201022123821.22602-8-colomar.6.4.3@gmail.com> X-Mailer: git-send-email 2.28.0 In-Reply-To: <20201022123821.22602-1-colomar.6.4.3@gmail.com> References: <20201022123821.22602-1-colomar.6.4.3@gmail.com> MIME-Version: 1.0 X-Spam-Status: No, score=-11.3 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, FREEMAIL_ENVFROM_END_DIGIT, FREEMAIL_FROM, GIT_PATCH_0, RCVD_IN_DNSWL_NONE, SPF_HELO_NONE, SPF_PASS, TXREP, UPPERCASE_50_75 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-Patchwork-Original-From: Alejandro Colomar via Libc-alpha From: Alejandro Colomar Reply-To: Alejandro Colomar Cc: Alejandro Colomar , linux-man@vger.kernel.org, libc-alpha@sourceware.org Errors-To: libc-alpha-bounces@sourceware.org Sender: "Libc-alpha" Signed-off-by: Alejandro Colomar --- man3/slist.3 | 260 +++++++++++++++++++++++++++------------------------ 1 file changed, 140 insertions(+), 120 deletions(-) diff --git a/man3/slist.3 b/man3/slist.3 index 0dab80cee..d97b745a0 100644 --- a/man3/slist.3 +++ b/man3/slist.3 @@ -31,60 +31,77 @@ .\" .TH SLIST 3 2020-10-21 "GNU" "Linux Programmer's Manual" .SH NAME -.Nm SLIST_EMPTY , -.Nm SLIST_ENTRY , -.Nm SLIST_FIRST , -.Nm SLIST_FOREACH , -.\" .Nm SLIST_FOREACH_FROM , -.\" .Nm SLIST_FOREACH_FROM_SAFE , -.\" .Nm SLIST_FOREACH_SAFE , -.Nm SLIST_HEAD , -.Nm SLIST_HEAD_INITIALIZER , -.Nm SLIST_INIT , -.Nm SLIST_INSERT_AFTER , -.Nm SLIST_INSERT_HEAD , -.Nm SLIST_NEXT , -.Nm SLIST_REMOVE , -.\" .Nm SLIST_REMOVE_AFTER , -.Nm SLIST_REMOVE_HEAD , -.\" .Nm SLIST_SWAP , +SLIST_EMPTY, +SLIST_ENTRY, +SLIST_FIRST, +SLIST_FOREACH, +.\"SLIST_FOREACH_FROM, +.\"SLIST_FOREACH_FROM_SAFE, +.\"SLIST_FOREACH_SAFE, +SLIST_HEAD, +SLIST_HEAD_INITIALIZER, +SLIST_INIT, +SLIST_INSERT_AFTER, +SLIST_INSERT_HEAD, +SLIST_NEXT, +SLIST_REMOVE, +.\"SLIST_REMOVE_AFTER, +SLIST_REMOVE_HEAD +.\"SLIST_SWAP .SH SYNOPSIS -.In sys/queue.h -.\" -.Fn SLIST_EMPTY "SLIST_HEAD *head" -.Fn SLIST_ENTRY "TYPE" -.Fn SLIST_FIRST "SLIST_HEAD *head" -.Fn SLIST_FOREACH "TYPE *var" "SLIST_HEAD *head" "SLIST_ENTRY NAME" -.\" .Fn SLIST_FOREACH_FROM "TYPE *var" "SLIST_HEAD *head" "SLIST_ENTRY NAME" -.\" .Fn SLIST_FOREACH_FROM_SAFE "TYPE *var" "SLIST_HEAD *head" "SLIST_ENTRY NAME" "TYPE *temp_var" -.\" .Fn SLIST_FOREACH_SAFE "TYPE *var" "SLIST_HEAD *head" "SLIST_ENTRY NAME" "TYPE *temp_var" -.Fn SLIST_HEAD "HEADNAME" "TYPE" -.Fn SLIST_HEAD_INITIALIZER "SLIST_HEAD head" -.Fn SLIST_INIT "SLIST_HEAD *head" -.Fn SLIST_INSERT_AFTER "TYPE *listelm" "TYPE *elm" "SLIST_ENTRY NAME" -.Fn SLIST_INSERT_HEAD "SLIST_HEAD *head" "TYPE *elm" "SLIST_ENTRY NAME" -.Fn SLIST_NEXT "TYPE *elm" "SLIST_ENTRY NAME" -.Fn SLIST_REMOVE "SLIST_HEAD *head" "TYPE *elm" "TYPE" "SLIST_ENTRY NAME" -.\" .Fn SLIST_REMOVE_AFTER "TYPE *elm" "SLIST_ENTRY NAME" -.Fn SLIST_REMOVE_HEAD "SLIST_HEAD *head" "SLIST_ENTRY NAME" -.\" .Fn SLIST_SWAP "SLIST_HEAD *head1" "SLIST_HEAD *head2" "SLIST_ENTRY NAME" -.\" +.nf +.B #include +.PP +.BI "int SLIST_EMPTY(SLIST_HEAD *" head ");" +.PP +.B SLIST_ENTRY(TYPE); +.PP +.BI "SLIST_ENTRY *SLIST_FIRST(SLIST_HEAD *" head ");" +.PP +.BI "SLIST_FOREACH(TYPE *" var ", SLIST_HEAD *" head ", SLIST_ENTRY " NAME ");" +.\".PP +.\".BI "SLIST_FOREACH_FROM(TYPE *" var ", SLIST_HEAD *" head ", SLIST_ENTRY " NAME ");" +.\".PP +.\".BI "SLIST_FOREACH_FROM_SAFE(TYPE *" var ", SLIST_HEAD *" head ", SLIST_ENTRY " NAME ", TYPE *" temp_var ");" +.\".PP +.\".BI "SLIST_FOREACH_SAFE(TYPE *" var ", SLIST_HEAD *" head ", SLIST_ENTRY " NAME ", TYPE *" temp_var ");" +.PP +.B SLIST_HEAD(HEADNAME, TYPE); +.PP +.BI "SLIST_HEAD SLIST_HEAD_INITIALIZER(SLIST_HEAD " head ");" +.PP +.BI "void SLIST_INIT(SLIST_HEAD *" head ");" +.PP +.BI "void SLIST_INSERT_AFTER(TYPE *" listelm ", TYPE *" elm ", SLIST_ENTRY " NAME ");" +.PP +.BI "void SLIST_INSERT_HEAD(SLIST_HEAD *" head ", TYPE *" elm ", SLIST_ENTRY " NAME ");" +.PP +.BI "SLIST_ENTRY *SLIST_NEXT(TYPE *" elm ", SLIST_ENTRY " NAME ");" +.PP +.BI "void SLIST_REMOVE(SLIST_HEAD *" head ", TYPE *" elm ", SLIST_ENTRY " NAME ");" +.\".PP +.\".BI "void SLIST_REMOVE_AFTER(TYPE *" elm ", SLIST_ENTRY " NAME ");" +.PP +.BI "void SLIST_REMOVE_HEAD(SLIST_HEAD *" head ", SLIST_ENTRY " NAME ");" +.\".PP +.\".BI "void SLIST_SWAP(SLIST_HEAD *" head1 ", SLIST_HEAD *" head2 ", SLIST_ENTRY " NAME ");" +.fi .SH DESCRIPTION In the macro definitions, -.Fa TYPE +.I TYPE is the name of a user-defined structure, that must contain a field of type -.Li SLIST_ENTRY , +.IR SLIST_ENTRY , named -.Fa NAME . +.IR NAME . The argument -.Fa HEADNAME +.IR HEADNAME is the name of a user defined structure that must be declared using the macro -.Li SLIST_HEAD . -.Ss Singly-linked lists +.BR SLIST_HEAD (). +.PP A singly-linked list is headed by a structure defined by the -.Nm SLIST_HEAD +.BR SLIST_HEAD () macro. This structure contains a single pointer to the first element on the list. @@ -93,159 +110,162 @@ overhead at the expense of O(n) removal for arbitrary elements. New elements can be added to the list after an existing element or at the head of the list. An -.Fa SLIST_HEAD +.I SLIST_HEAD structure is declared as follows: -.Bd -literal -offset indent +.PP +.in +4 +.EX SLIST_HEAD(HEADNAME, TYPE) head; -.Ed -.Pp +.EE +.in +.PP where -.Fa HEADNAME +.I HEADNAME is the name of the structure to be defined, and -.Fa TYPE +.I TYPE is the type of the elements to be linked into the list. A pointer to the head of the list can later be declared as: -.Bd -literal -offset indent +.PP +.in +4 +.EX struct HEADNAME *headp; -.Ed -.Pp +.EE +.in +.PP (The names -.Li head +.I head and -.Li headp +.I headp are user selectable.) -.Pp +.PP The macro -.Nm SLIST_HEAD_INITIALIZER +.BR SLIST_HEAD_INITIALIZER () evaluates to an initializer for the list -.Fa head . -.Pp +.IR head . +.PP The macro -.Nm SLIST_EMPTY +.BR SLIST_EMPTY () evaluates to true if there are no elements in the list. -.Pp +.PP The macro -.Nm SLIST_ENTRY +.BR SLIST_ENTRY () declares a structure that connects the elements in the list. -.Pp +.PP The macro -.Nm SLIST_FIRST +.BR SLIST_FIRST () returns the first element in the list or NULL if the list is empty. -.Pp +.PP The macro -.Nm SLIST_FOREACH +.BR SLIST_FOREACH () traverses the list referenced by -.Fa head +.I head in the forward direction, assigning each element in turn to -.Fa var . -.\" .Pp +.IR var . +.\" .PP .\" The macro -.\" .Nm SLIST_FOREACH_FROM +.\" .BR SLIST_FOREACH_FROM () .\" behaves identically to -.\" .Nm SLIST_FOREACH +.\" .BR SLIST_FOREACH () .\" when -.\" .Fa var +.\" .I var .\" is NULL, else it treats -.\" .Fa var +.\" .I var .\" as a previously found SLIST element and begins the loop at -.\" .Fa var +.\" .I var .\" instead of the first element in the SLIST referenced by -.\" .Fa head . +.\" .IR head . .\" .Pp .\" The macro -.\" .Nm SLIST_FOREACH_SAFE +.\" .BR SLIST_FOREACH_SAFE () .\" traverses the list referenced by -.\" .Fa head +.\" .I head .\" in the forward direction, assigning each element in .\" turn to -.\" .Fa var . +.\" .IR var . .\" However, unlike -.\" .Fn SLIST_FOREACH +.\" .BR SLIST_FOREACH () .\" here it is permitted to both remove -.\" .Fa var +.\" .I var .\" as well as free it from within the loop safely without interfering with the .\" traversal. -.\" .Pp +.\" .PP .\" The macro -.\" .Nm SLIST_FOREACH_FROM_SAFE +.\" .BR SLIST_FOREACH_FROM_SAFE () .\" behaves identically to -.\" .Nm SLIST_FOREACH_SAFE +.\" .BR SLIST_FOREACH_SAFE () .\" when -.\" .Fa var +.\" .I var .\" is NULL, else it treats -.\" .Fa var +.\" .I var .\" as a previously found SLIST element and begins the loop at -.\" .Fa var +.\" .I var .\" instead of the first element in the SLIST referenced by -.\" .Fa head . -.Pp +.\" .IR head . +.PP The macro -.Nm SLIST_INIT +.BR SLIST_INIT () initializes the list referenced by -.Fa head . -.Pp +.IR head . +.PP The macro -.Nm SLIST_INSERT_HEAD +.BR SLIST_INSERT_HEAD () inserts the new element -.Fa elm +.I elm at the head of the list. -.Pp +.PP The macro -.Nm SLIST_INSERT_AFTER +.BR SLIST_INSERT_AFTER () inserts the new element -.Fa elm +.I elm after the element -.Fa listelm . -.Pp +.IR listelm . +.PP The macro -.Nm SLIST_NEXT +.BR SLIST_NEXT () returns the next element in the list. -.\" .Pp +.\" .PP .\" The macro -.\" .Nm SLIST_REMOVE_AFTER +.\" .BR SLIST_REMOVE_AFTER () .\" removes the element after -.\" .Fa elm +.\" .I elm .\" from the list. .\" Unlike -.\" .Fa SLIST_REMOVE , +.\" .IR SLIST_REMOVE , .\" this macro does not traverse the entire list. -.Pp +.PP The macro -.Nm SLIST_REMOVE_HEAD +.BR SLIST_REMOVE_HEAD () removes the element -.Fa elm +.I elm from the head of the list. For optimum efficiency, elements being removed from the head of the list should explicitly use this macro instead of the generic -.Fa SLIST_REMOVE +.I SLIST_REMOVE macro. -.Pp +.PP The macro -.Nm SLIST_REMOVE +.BR SLIST_REMOVE () removes the element -.Fa elm +.I elm from the list. -.\" .Pp +.\" .PP .\" The macro -.\" .Nm SLIST_SWAP +.\" .BR SLIST_SWAP () .\" swaps the contents of -.\" .Fa head1 +.\" .I head1 .\" and -.\" .Fa head2 . +.\" .IR head2 . .SH RETURN VALUE .SH CONFORMING TO Not in POSIX.1, POSIX.1-2001 or POSIX.1-2008. Present on the BSDs -(SLIST macros first appeared in -.Bx 4.4 ). +(SLIST macros first appeared in 4.4BSD). .SH BUGS .SH EXAMPLES -.Ss Singly-linked list example -.Bd -literal - +.EX #include #include #include @@ -299,5 +319,5 @@ main(void) exit(EXIT_SUCCESS); } -.Ed +.EE .SH SEE ALSO