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 0F050C43334 for ; Sun, 12 Jun 2022 04:20:24 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 7928F84021; Sun, 12 Jun 2022 06:20:15 +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="FuvpY8hQ"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 059E283FF8; Sun, 12 Jun 2022 06:20:07 +0200 (CEST) Received: from mail-qk1-x72d.google.com (mail-qk1-x72d.google.com [IPv6:2607:f8b0:4864:20::72d]) (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 A2E9D842FA for ; Sun, 12 Jun 2022 06:20:03 +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-qk1-x72d.google.com with SMTP id 15so1964961qki.6 for ; Sat, 11 Jun 2022 21:20:03 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=txle9INGtPfKwo6FzPVXWtA4eYYY9lqc8H0atz+O5MI=; b=FuvpY8hQYaF1F6YfY+EQP6VxHFZRnB9kPSszLsXvfs0mNnsGjpbIa+8mU7musQ8ZzL xuXJ0luZq+L36IJuJ6cf9eiXNBivxuu80gE4Ih8swI96opQtnaFr8RNHJUVjL6diS4GF 9K+TQ8JIjDhfoXL1+N2lwjH1zX4mDLNe20wqsvKzgdPcTN/0abOFfok7YBy93FnwOA83 WRGyy0Rj9lJAXpx/LM/nQ4qmzJkDmOGkTegmiteeOcyOdIbtoOT7eCHLCpkgC0OikB1b MrDkNGooxpAldbIAqSJuneTxh+gcYGy3CZV53LpnJIGZTH+9KwsoU/9e+C4/eBHLcRU0 BaWw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=txle9INGtPfKwo6FzPVXWtA4eYYY9lqc8H0atz+O5MI=; b=qCrTyAaaUEd1MTX6xjctwtDcZ4TMo3gYljw9R/b+f0ZWBl8w9fJ1NGARZBEE+GExQP J6gIzexIAHBlIdkCgudmTEQVsbNljBE4fNFbg7L7u/k9MeOQiW9tHylgkuNy8rSi8Vp3 3sR5TBThRwoY/pfvYkyJ9x0tCD7OiZJsn1vRygEXodgnjAYojsiOvlePonA4MsV04Bmf G4Gn2J5yLlj+qjIaxOh/YGmzxR494A1ZvA4Vo4BMWz1OMcwOVIzNvBPOanGV6P3ab1kA G8/WpucvZw/0mbiEZwrzmhO5XplyvKtE+/mUboz6m9tq+eDD3alZWaN8m3x3xq1TE66E H1vw== X-Gm-Message-State: AOAM5305y/w9j5YN1nw9Wk+54ZGxe7MmFo1LNn8J7pyJrcYtT8KeTayf 1telsT4uWOcuwMdD8Vc3EnsGAJ9jDDwAqVBM X-Google-Smtp-Source: ABdhPJy6wZZMLpyhlEEavafaRpwzjAukGybPgxxwxEIDO+VZtiC0bYhilNqY13CdMWzgpu1nivLjiA== X-Received: by 2002:a05:620a:c54:b0:6a3:226b:49f6 with SMTP id u20-20020a05620a0c5400b006a3226b49f6mr34590719qki.396.1655007602119; Sat, 11 Jun 2022 21:20:02 -0700 (PDT) Received: from localhost (pool-173-73-95-180.washdc.fios.verizon.net. [173.73.95.180]) by smtp.gmail.com with UTF8SMTPSA id u21-20020a05620a455500b006a6edbbca84sm2227050qkp.94.2022.06.11.21.20.01 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Sat, 11 Jun 2022 21:20:01 -0700 (PDT) From: Sean Anderson To: u-boot@lists.denx.de, Heinrich Schuchardt Cc: Simon Glass , Sean Anderson Subject: [PATCH 01/12] doc: mkimage: Use standard style for synopsis Date: Sun, 12 Jun 2022 00:19:48 -0400 Message-Id: <20220612041959.1538628-2-seanga2@gmail.com> X-Mailer: git-send-email 2.35.1 In-Reply-To: <20220612041959.1538628-1-seanga2@gmail.com> References: <20220612041959.1538628-1-seanga2@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit 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 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 +.YS -.B mkimage -.RB [\fIoptions\fP] " (legacy mode)" +.SY mkimage +.RI [ option\~ .\|.\|.\&] +.R (legacy mode) +.YS .SH "DESCRIPTION" The -- 2.35.1