From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id AC982C43334 for ; Sun, 12 Jun 2022 04:41:31 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 30F95840B6; Sun, 12 Jun 2022 06:41:29 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.b="DWRnn/h0"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 5FE53839BD; Sun, 12 Jun 2022 06:41:27 +0200 (CEST) Received: from mail-qv1-xf2c.google.com (mail-qv1-xf2c.google.com [IPv6:2607:f8b0:4864:20::f2c]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id F1447839BD for ; Sun, 12 Jun 2022 06:41:24 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=seanga2@gmail.com Received: by mail-qv1-xf2c.google.com with SMTP id i19so2291568qvu.13 for ; Sat, 11 Jun 2022 21:41:24 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=subject:to:cc:references:from:message-id:date:user-agent :mime-version:in-reply-to:content-language:content-transfer-encoding; bh=ugcwyc4V3O2e/gaEIQTQKkW0GnkJWrC4ffYmuI7bvrs=; b=DWRnn/h0usIHQN5RNrmdFhCuPlJyHI/RMO13RXk2D2naSppNMjWM6jlZBZI2WEyCsO 5HhI6bo/j4XUg0JYFJ4HM1RBNKXCW9DRYeS/4J/0snXKbeV/2sfxpBWKpbzoYpOWnXTC TLynDkhP2a5KErkOPrMp8K3YBowcm5GGskIlWunq5/n0PIioGZghfycfberKLZP5Vx90 j2LrFEcGUZX1S6wHkP9jCRoaJ5J5sFWjjWj6Ux0KQX60ZWrAKf/jb3zE/XZji8RLeDHh qN+GiSd8XK6+p73Xm211ZPtg/5bgeq+qu8mDNauv93Z6w1LEYhMENiUkok4DTXpEU1Lm 09iA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:subject:to:cc:references:from:message-id:date :user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=ugcwyc4V3O2e/gaEIQTQKkW0GnkJWrC4ffYmuI7bvrs=; b=glpfWpYF/orQRfvSe2q2B0ZfBdUAcbGzZEr3sVKnwUHkCc0jZZeEXT5vzI6KJ0rdx2 XOThuBrxiGInJcbdE0mBYDYgGsxvBLcqPTKIlsa+7wHfCc32pNS73+LTLwDYqcpuwnYL RIvZeVS92fQrWck12wAzZkKbbu0Uq/uRJygDVjeekbXMrkVtutiY9iAUwpCiFGq4Uc1u sPBKjS5QyYU6f6TL1PojYTBDrsSD/bpYDuYvSporF2X1v5hx0sBufTmxoriiaDy0e44W FQ3gBiAGxxHpWBK17hOvuv0bUXjyNJ7CEdeIyb8acjuUng0+GXosrKeK4joFv4xq+OJL 9fWA== X-Gm-Message-State: AOAM530NspskYN06VaiuqRt7JXA+YcrvED3sme61ni0sb6GR5egmdZYX C+K0LSHvKzuDtqLmqq8Dt8U= X-Google-Smtp-Source: ABdhPJznyPqvNJjHBa6OvIsCJ32qQWKVl6H7k8fcXlqIvB3qqyMQkeKe+diOpmM92xRsUH8Aj/nT+w== X-Received: by 2002:a05:6214:f6e:b0:467:d324:1486 with SMTP id iy14-20020a0562140f6e00b00467d3241486mr37558387qvb.119.1655008883856; Sat, 11 Jun 2022 21:41:23 -0700 (PDT) Received: from [192.168.1.201] (pool-173-73-95-180.washdc.fios.verizon.net. [173.73.95.180]) by smtp.gmail.com with ESMTPSA id bl35-20020a05620a1aa300b006a6c552736asm3298162qkb.119.2022.06.11.21.41.23 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Sat, 11 Jun 2022 21:41:23 -0700 (PDT) Subject: Re: [PATCH 01/12] doc: mkimage: Use standard style for synopsis To: u-boot@lists.denx.de, Heinrich Schuchardt Cc: Simon Glass References: <20220612041959.1538628-1-seanga2@gmail.com> <20220612041959.1538628-2-seanga2@gmail.com> From: Sean Anderson Message-ID: <02cc4b48-db84-1e7e-9a2a-3992ebd35d3f@gmail.com> Date: Sun, 12 Jun 2022 00:41:22 -0400 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.12.0 MIME-Version: 1.0 In-Reply-To: <20220612041959.1538628-2-seanga2@gmail.com> Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.39 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" X-Virus-Scanned: clamav-milter 0.103.5 at phobos.denx.de X-Virus-Status: Clean On 6/12/22 12:19 AM, Sean Anderson wrote: > The synopsis section is a bit messy. As an example, "uimage file name" is > printed in italics, bold, and roman (depending on the line). This cleans > things up and converts the synopsis section to use standard style. The > .SY/.YS macros set up appropriate fomatting for command synopsis sections > (such as disabling hyphenation and setting a hanging indent). All parts of > the synopsis now use the following style: > > - Bold for parts of the command which should be typed in by the user (such > as the program name and flags) > - Italic for parts which should be replaced (such as uimage-file-name) > - Roman for parts which should not be typed at all (such as brackets) > > Multi-word variables now use hyphens to connect their words instead of > spaces. This makes it clearer that all the words are part of the same > variable. Additionally, "option ..." is used to denote where other options > may be specified, as this appears to be standard style. > > Signed-off-by: Sean Anderson > --- > > doc/mkimage.1 | 25 +++++++++++++++++-------- > 1 file changed, 17 insertions(+), 8 deletions(-) > > diff --git a/doc/mkimage.1 b/doc/mkimage.1 > index 759dc2d12f..2765c74410 100644 > --- a/doc/mkimage.1 > +++ b/doc/mkimage.1 > @@ -3,17 +3,26 @@ > .SH NAME > mkimage \- Generate image for U-Boot > .SH SYNOPSIS > -.B mkimage > -.RB [ \-T " \fItype\fP] " \-l " [\fIuimage file name\fP]" > +.SY mkimage > +.OP \-T type > +.BI \-l\~ image-file-name > +.YS > > -.B mkimage > -.RB [\fIoptions\fP] " \-f [" "image tree source file" "]" " [" "uimage file name" "]" > +.SY mkimage > +.RI [ option\~ .\|.\|.\&] > +.BI \-f\~ image-tree-source-file > +.I image-file-name > +.YS > > -.B mkimage > -.RB [\fIoptions\fP] " \-F [" "uimage file name" "]" > +.SY mkimage > +.RI [ option\~ .\|.\|.\&] > +.BI \-F image-file-name This is missing a \~ Will be fixed in v2 > +.YS > > -.B mkimage > -.RB [\fIoptions\fP] " (legacy mode)" > +.SY mkimage > +.RI [ option\~ .\|.\|.\&] > +.R (legacy mode) > +.YS > > .SH "DESCRIPTION" > The >