From patchwork Mon Sep 28 15:16:47 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alejandro Colomar X-Patchwork-Id: 40527 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 A2FCA394743A; Mon, 28 Sep 2020 15:17:50 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org A2FCA394743A DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1601306270; bh=i2vzKStOPe11VmTL/E8/V1l/l5a0YpLJM75ndmNj8II=; 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=C86H9y0BLTm2zRzabEKyskhjbXl2FiI13riBpjbgjXLm3i+v/8Uku7lKlD0e++IwO fvTcDOcVBmcTziGkC6btjwXVhuJHZsRXonb+xbZct7QiUKaM8MPzs+gzbgkWl7Obw9 EgvCAWWqchHBLFeTQpKuJlwGTRkHk0TnP7DQZFXY= 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 62CA138618E2 for ; Mon, 28 Sep 2020 15:17:47 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org 62CA138618E2 Received: by mail-wr1-x443.google.com with SMTP id z1so1802839wrt.3 for ; Mon, 28 Sep 2020 08:17:47 -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=i2vzKStOPe11VmTL/E8/V1l/l5a0YpLJM75ndmNj8II=; b=Z44L3+fFqMBJh5rZPVxKaHlQG/OMKKQ8lSvz6t/kKxHWYtnCimURd8CgykOwKknsBy 9EJgJtlkCpw/7oHmTTcvnEtStGs2a6QAQ7gac5Hkxg62DCesJCwRvO9S6FK7E4ODicQo kr6nwym6mxYlkiXxm8gEOicUriWoo4nYFdAB+pkZe/EWM8li7odhcDysZc+LCwfC3F8I oUqqhq1JI40K2SEWy7WcQIWWisX4PmIsVaX55cHYHztXMO8MSJuNOVCTVSinXaifRju3 j5N+i9hgFOQPrISYy/P1ONL02tEwkd7XpRBqOntz2M9K39GSRHrDbdA6VWIvMJvhfGup kbmA== X-Gm-Message-State: AOAM5339AkXVc2JkLo2Bw2g3aRAgk10gzCpfxR7qJnxnF7kmkEv/BOFG U33CEw+KnoJ/QfPdg5H4Kjw= X-Google-Smtp-Source: ABdhPJyOlrBLEWKEjvKq1BacO/gXesrdf5MI4U4x2xRtVB1i2o1ixijTYGwWc3n04Dv9/CWiG8+dwQ== X-Received: by 2002:adf:f701:: with SMTP id r1mr2257906wrp.341.1601306266279; Mon, 28 Sep 2020 08:17:46 -0700 (PDT) Received: from localhost.localdomain ([170.253.60.68]) by smtp.googlemail.com with ESMTPSA id u17sm2255509wri.45.2020.09.28.08.17.44 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 28 Sep 2020 08:17:45 -0700 (PDT) To: mtk.manpages@gmail.com, g.branden.robinson@gmail.com, Dave.Martin@arm.com Subject: [RFC] system_data_types.7: wfix + ffix Date: Mon, 28 Sep 2020 17:16:47 +0200 Message-Id: <20200928151646.20271-1-colomar.6.4.3@gmail.com> X-Mailer: git-send-email 2.28.0 In-Reply-To: References: MIME-Version: 1.0 X-Spam-Status: No, score=-9.9 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 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" The previous format/wording for the includes wasn't very clear. Improve it a bit following Branden's proposal. Reported-by: G. Branden Robinson Signed-off-by: Alejandro Colomar --- Hi, What do you think about this? Would you change something? Thanks, Alex man7/system_data_types.7 | 285 ++++++++++++++++----------------------- 1 file changed, 113 insertions(+), 172 deletions(-) diff --git a/man7/system_data_types.7 b/man7/system_data_types.7 index 16930985e..dc4a3bae4 100644 --- a/man7/system_data_types.7 +++ b/man7/system_data_types.7 @@ -33,20 +33,21 @@ system_data_types \- overview of system data types .\" Each entry will have the following parts: .\" * Include .\" The headers will be in the following order: +.\" "Include:" .\" 1) The main header that shall define the type -.\" according to the C Standard, -.\" and -.\" the main header that shall define the type -.\" according to POSIX, -.\" in alphabetical order. -.\" ; -.\" 2) All other headers that shall define the type +.\" according to the C Standard. +.\" ["or"] +.\" 2) The main header that shall define the type +.\" according to POSIX. +.\" [". Alternatively,"] +.\" 3) All other headers that shall define the type .\" as described in the previous header(s) .\" according to the C Standard or POSIX, .\" in alphabetical order. .\" *) All headers that define the type .\" *if* the type is not defined by C nor POSIX, .\" in alphabetical order. +.\" "." .\" .\" * Definition (no "Definition" header) .\" Only struct/union types will have definition; @@ -203,8 +204,8 @@ See also: .RS .br Include: -.IR ; -or +.IR . +Alternatively, .IR . .PP An object type used for streams. @@ -268,19 +269,14 @@ type in this page. .RS .br Include: -.IR ; -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I +.IR . +Alternatively, +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , or .IR . .PP @@ -305,8 +301,8 @@ See also: .RS .br Include: -.IR ; -or +.IR . +Alternatively, .IR . .PP A type used to hold a general identifier. @@ -450,29 +446,19 @@ See also: .RS .br Include -.IR ; -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I +.IR . +Alternatively, +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , or .IR . .PP @@ -602,11 +588,10 @@ types in this page. .RS .br Include: -.IR ; -or -.I -or -.I +.IR . +Alternatively, +.IR , +.IR , or .IR . .PP @@ -651,8 +636,8 @@ structure in this page. .RS .br Include: -.IR ; -or +.IR . +Alternatively, .IR . .PP .EX @@ -687,9 +672,9 @@ See also: .RS .br Include: -.IR ; -or -.I +.IR . +Alternatively, +.IR , or .IR . .PP @@ -750,55 +735,32 @@ in this page. Include: .I or -.IR ; -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I +.IR . +Alternatively, +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , or .IR . .PP @@ -871,21 +833,15 @@ types in this page. .RS .br Include: -.IR ; -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I +.IR . +Alternatively, +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , or .IR . .PP @@ -947,9 +903,9 @@ types in this page. .RS .br Include: -.IR ; -or -.I +.IR . +Alternatively, +.IR , or .IR . .PP @@ -974,23 +930,17 @@ structure in this page. .RS .br Include: -.I -or -.IR ; -or -.I -or -.I -or -.I -or -.I -or -.I -or -.I +.I or -.I +.IR . +Alternatively, +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , +.IR , or .IR . .PP @@ -1017,8 +967,8 @@ See also: .RS .br Include: -.IR ; -or +.IR . +Alternatively, .IR . .PP Used for timer ID returned by @@ -1040,17 +990,13 @@ See also: .RS .br Include: -.IR ; -or -.I -or -.I -or -.I -or -.I -or -.I +.IR . +Alternatively, +.IR , +.IR , +.IR , +.IR , +.IR , or .IR . .PP @@ -1078,11 +1024,10 @@ See also: .RS .br Include: -.IR ; -or -.I -or -.I +.IR . +Alternatively, +.IR , +.IR , or .IR . .PP @@ -1111,17 +1056,13 @@ See also: .RS .br Include: -.IR ; -or -.I -or -.I -or -.I -or -.I -or -.I +.IR . +Alternatively, +.IR , +.IR , +.IR , +.IR , +.IR , or .IR . .PP @@ -1145,9 +1086,9 @@ See also: .RS .br Include: -.IR ; -or -.I +.IR . +Alternatively, +.IR , or .IR . .PP