Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-12.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id E31F0C4727E for ; Mon, 28 Sep 2020 15:18:00 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id A70922184D for ; Mon, 28 Sep 2020 15:18:00 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="oRD69xCR" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726801AbgI1PR7 (ORCPT ); Mon, 28 Sep 2020 11:17:59 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:47500 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726685AbgI1PRs (ORCPT ); Mon, 28 Sep 2020 11:17:48 -0400 Received: from mail-wr1-x444.google.com (mail-wr1-x444.google.com [IPv6:2a00:1450:4864:20::444]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D64ABC061755 for ; Mon, 28 Sep 2020 08:17:47 -0700 (PDT) Received: by mail-wr1-x444.google.com with SMTP id e16so1809309wrm.2 for ; Mon, 28 Sep 2020 08:17:47 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=i2vzKStOPe11VmTL/E8/V1l/l5a0YpLJM75ndmNj8II=; b=oRD69xCRMgoVdd780USRaLW2GIMEi5cQZdvA2o0D+69YdLTT3ulrgzKLXr0oAUuYhC oWg6mT80YuNHXPqaOZ0rg9l70XsvbaLex7PPsOSmaxwnczvPr5yEcfJjcwaJX2/DkaP6 piggY/48X8JIPvdBaFXTd3EeQVp3DSqU4Z74+Oq3cNjErbRiWF6+S3jJXRbvjBL9+yMP rdzEn0JafFOPwNiFCltF0kFw/Voc3OdKGnffKliWU3oWLIcHOvgUVuI3rk5NAwJEGnbU stoYG4aOdzS3XMIoo9kOAjDChyJI04x9q8xpR/noBdlQMaHp7DhbLYBCO9WQBmXz5YQk 7HyA== 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=TTNRf4fpjDhSjK/vbKd02kQWjQ/RJJAqZtlOCJi6MzzrJwRHltnhqnhneKWzMO4KPM T8YqA2WV0tl1OGE+9Fg5+8X2fHQYhsMFOVfmFCraEbufYwBMFYrglXbj/zcokKrMBUeg 8MngOPa7iWI8HBOyks6QHJc6Kr8mQ3fPiZbJ3xKwbI7zX1VLUAA3G0x3a7CM+OXyngrb BPQtBCK/QjR86+CcC8jE5MEax784XxhJXBPligDJp7tjcL75etNV47RXuzcOo6P9Xp70 gBCgDt4A+pv0qCnwMLQ33x3G7uaQPvRjhzxBJ6oISDAXeV3iSrpHlsUmHLzYxWebGMHA emfA== X-Gm-Message-State: AOAM531UwJf6mcYVUGKVX1Ck/fEAUA7daKAcWvta5pp8KKUNYUzfADMf XI5EMobOtVLnZv/GOcWG2Las3JcHaiY= 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) From: Alejandro Colomar To: mtk.manpages@gmail.com, g.branden.robinson@gmail.com, Dave.Martin@arm.com Cc: Alejandro Colomar , linux-man@vger.kernel.org, libc-alpha@sourceware.org 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 Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: X-Mailing-List: linux-man@vger.kernel.org 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 -- 2.28.0