From patchwork Thu Oct 22 12:38:18 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alejandro Colomar X-Patchwork-Id: 40818 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 20254398401C; Thu, 22 Oct 2020 12:39:01 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org 20254398401C DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1603370341; bh=nBy8ZMQa+Ck6w2dw7HG7HQ9BsYxuio913IYeaWV9YY4=; 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=GPSZ8wsr3qqOraH9vT/wLREL2auOfA/3tVosdkDYEEdmtIV8kfGXg7mxN1vTNzfnv VSiO6jzinqzvM5u5u6Dzhf6UIMP8Iko+HBA4yEDxTX8Ah0PyXoc4rWrL2slo/4b/T0 gIwAktRON5klEpEdNVavSjD69PBm93nX2sL6hDrY= X-Original-To: libc-alpha@sourceware.org Delivered-To: libc-alpha@sourceware.org Received: from mail-wr1-x443.google.com (mail-wr1-x443.google.com [IPv6:2a00:1450:4864:20::443]) by sourceware.org (Postfix) with ESMTPS id E0E3F3985405 for ; Thu, 22 Oct 2020 12:38:57 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org E0E3F3985405 Received: by mail-wr1-x443.google.com with SMTP id s9so2184513wro.8 for ; Thu, 22 Oct 2020 05:38:57 -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=nBy8ZMQa+Ck6w2dw7HG7HQ9BsYxuio913IYeaWV9YY4=; b=SdBp59pNHSRwoPPND3ODd2fzY1QANsNRijKaGFWA9qwrLQ+94b0UX267M6kJyWM1Jx cD2Ddd0dUdeuj21uVagGSRylWJmbdGZOMTvCK2Gvkm59Tc3U+qrHgx3tRoi+00b0XIXL n3gel64S8ATPfXxz2QwbgwxZO0DK1wT67UetoGZwB1aq2PNctE1D6bJRj6p6eC8n8L9S B/WJHR09gi9NbojPe+uz7AnxDKXx+JmjUiMx5irTryTJ5XIcq/gtJdOYrhilaGvOLz6+ uoTU2IKYongJgLPQJ7q2lHIwz4jclyQKrsFj8jaEzZhdinlz9VEvuwy7D9mNfqkdMhgC Xejw== X-Gm-Message-State: AOAM531xYTVvh52J+oaPYnuqMcAAnN61kh4+bXlErMPNOAvyrpVxHdMx 8n8yQ6szS6Ubk6B7Yf8a+U8= X-Google-Smtp-Source: ABdhPJyR10dj/cyF00122sILlkaSpa6ST4gBLyBEQZTcpwzFVqgW2cqqhIvyO8ItUy++sn7MJF/dZA== X-Received: by 2002:a5d:480b:: with SMTP id l11mr2545460wrq.225.1603370337034; Thu, 22 Oct 2020 05:38:57 -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.55 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 22 Oct 2020 05:38:56 -0700 (PDT) To: mtk.manpages@gmail.com Subject: [PATCH 06/10] slist.3: Copy and adapt code from queue.3 Date: Thu, 22 Oct 2020 14:38:18 +0200 Message-Id: <20201022123821.22602-7-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.1 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, KAM_NUMSUBJECT, 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" A few fixes to note: - Sorted alphabetically some macros - ffix: remove alignment spaces in example (as in list.3) Signed-off-by: Alejandro Colomar --- man3/slist.3 | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/man3/slist.3 b/man3/slist.3 index 291c8753b..0dab80cee 100644 --- a/man3/slist.3 +++ b/man3/slist.3 @@ -36,38 +36,52 @@ .Nm SLIST_FIRST , .Nm SLIST_FOREACH , .\" .Nm SLIST_FOREACH_FROM , -.\" .Nm SLIST_FOREACH_SAFE , .\" .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_REMOVE , .\" .Nm 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_SAFE "TYPE *var" "SLIST_HEAD *head" "SLIST_ENTRY NAME" "TYPE *temp_var" .\" .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_REMOVE "SLIST_HEAD *head" "TYPE *elm" "TYPE" "SLIST_ENTRY NAME" .\" .Fn SLIST_SWAP "SLIST_HEAD *head1" "SLIST_HEAD *head2" "SLIST_ENTRY NAME" .\" .SH DESCRIPTION +In the macro definitions, +.Fa TYPE +is the name of a user-defined structure, +that must contain a field of type +.Li SLIST_ENTRY , +named +.Fa NAME . +The argument +.Fa HEADNAME +is the name of a user defined structure that must be declared +using the macro +.Li SLIST_HEAD . .Ss Singly-linked lists A singly-linked list is headed by a structure defined by the .Nm SLIST_HEAD @@ -221,10 +235,12 @@ from the list. .\" .Fa head1 .\" and .\" .Fa head2 . -.Pp -See the EXAMPLES section below for an example program using a singly-linked list. .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 ). .SH BUGS .SH EXAMPLES .Ss Singly-linked list example @@ -245,7 +261,7 @@ SLIST_HEAD(slisthead, entry); int main(void) { - struct entry *n1, *n2, *n3, *np; + struct entry *n1, *n2, *n3, *np; struct slisthead head; /* Singly-linked List head. */