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 B7583C43334 for ; Sun, 12 Jun 2022 22:14:35 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id F0DCD84439; Mon, 13 Jun 2022 00:14:23 +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="agzoUZGb"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 7A4E88442C; Mon, 13 Jun 2022 00:14:19 +0200 (CEST) Received: from mail-qv1-xf34.google.com (mail-qv1-xf34.google.com [IPv6:2607:f8b0:4864:20::f34]) (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 E4D0584411 for ; Mon, 13 Jun 2022 00:14:16 +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-xf34.google.com with SMTP id 89so3332072qvc.0 for ; Sun, 12 Jun 2022 15:14:16 -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=WAK1pvp0Tke3CsG/dDtfnFgmIZF29HonlI0hYZuS+tg=; b=agzoUZGbrLJhsEZLzPyrxti0CsMB1XWNk0MRWtcEufIiYA05VU55xIdNsc6ZlSkthq 2C9tGDOy0jrCAmPmZKlM/zu/aX0oY57mjRYyLptyd5bFLKUJwhvnYqUfrOdX2Y1M8cw9 kDH35cN8t9zKpOUsM0vZ5sDJL9elpp2nGeiDBX9eihy7ZGrnGqotH0DHKdeNR/QOTlfH DGsN4PLV7+9DLiyd+YVsSg+vo354/K2DYPnj3bqWKIgwuwnCUDtOsdbCiNveYBvurWV1 LdfFJ0fnnD8WPB/DeQSjz3GHWg9rwkYHgmQTrRI079Sl/QIMThanv9yXC0PpcctoGA8V a/2A== 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=WAK1pvp0Tke3CsG/dDtfnFgmIZF29HonlI0hYZuS+tg=; b=SPCS9yfVAgpbEoDkxM8klHp9Vu2iW+UUpLbdNRcqq3i1zqi8NvW8cAh23PjIbWbqIO U8hfNmIQ8BwEnjLfrqfN+NsRYyZSD1c4Gaf6uhm5xi0VZLduELqWnQGo/aXuZd6nzpek AQwC++Ed7AddrZPlW/DzU4R/J0+xc/T5MklM2T7JrNA02Xbj9OIJjNku6oMKAo711BSt o/VRypIeAydOD0wmuB7cO8FuV0Havo55vlMHeDz2I6gs0KgYpGzz4tybK6sBYQXecviS IT/IMSU0gPoJ7qKGUPtjNzYH6HJvIojUFzKZWlRrd68625I6xfZn6PMvdBNjAu0Mdry4 Al6A== X-Gm-Message-State: AOAM5312EcC8R9tXZdBXw1EzsXdfvtwqSXxdzTrxjbBAWkInwM/L2RRd kO0B0z91VTZLHg7NVKwglGB0RgjclvmgGsPs X-Google-Smtp-Source: ABdhPJz0fSE58gP7Hrwq174DNeM+Rmd0l5BrbXp2BmySeLmapSuU6Kq1GKjDt0KoxDKHbMiGinL/6g== X-Received: by 2002:a05:6214:21c6:b0:464:47ca:fafa with SMTP id d6-20020a05621421c600b0046447cafafamr57954945qvh.130.1655072055517; Sun, 12 Jun 2022 15:14:15 -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 u18-20020a05622a199200b0030503a897b1sm3798552qtc.42.2022.06.12.15.14.15 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Sun, 12 Jun 2022 15:14:15 -0700 (PDT) From: Sean Anderson To: u-boot@lists.denx.de, Heinrich Schuchardt Cc: Simon Glass , Sean Anderson Subject: [PATCH v2 01/14] doc: mkimage: Use standard style for synopsis Date: Sun, 12 Jun 2022 18:13:58 -0400 Message-Id: <20220612221411.1608406-2-seanga2@gmail.com> X-Mailer: git-send-email 2.35.1 In-Reply-To: <20220612221411.1608406-1-seanga2@gmail.com> References: <20220612221411.1608406-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 --- Changes in v2: - Fix spacing for -F doc/mkimage.1 | 26 ++++++++++++++++++-------- 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/doc/mkimage.1 b/doc/mkimage.1 index 759dc2d12f..dc597272d4 100644 --- a/doc/mkimage.1 +++ b/doc/mkimage.1 @@ -3,17 +3,27 @@ .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\c +.RB | auto +.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