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 996C1C43334 for ; Sat, 25 Jun 2022 17:12:44 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 67CDF84449; Sat, 25 Jun 2022 19:12:33 +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="Yd/2p/VD"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id E339683E65; Sat, 25 Jun 2022 19:12:28 +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 5831483FF6 for ; Sat, 25 Jun 2022 19:12:26 +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 u14so6479066qvv.2 for ; Sat, 25 Jun 2022 10:12:26 -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=mx78RSbSr1+H+Ox6hYMew4AxQf0UXLG7QppGUvmOY6w=; b=Yd/2p/VDVkoGat7+DVgopDT15Tdpv7nQDzwJLMD6OAEOa0cCJm0Y+vH8U3evT9TzKi U+f/gKEwGhYyGhozUJX+0o5MOjqlDxeERW3xvCmZx3oRCXoxrdL5bv7IlVMynOctzfxk xw6TlacmCf0hWeEjT50AjYtiAscO95OnzvCVYZ4yMrc+w+JGJdDTAENt+hzQlxrmqw9/ K1DSM5+iV+UBzgnLEGT7Tzqi4et7HpqNJUEFP+ZRYnsx6ZnBcEoph/uicd3M5xAT5Bc/ WVyKvQ87JrWw3sd9v9UaiLTvweuoUBq/rUhrsfYC2tvudEU3GtjaR6I25CQZUUtPP2YA 6b2Q== 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=mx78RSbSr1+H+Ox6hYMew4AxQf0UXLG7QppGUvmOY6w=; b=dPLNPT8uFn+Fnw+gdFYC4hKUUjY5nPg2y++PusV9AehzsTRZ74aw6GuGbdZQTPY8Sq VgCuCm4gWhk93nr6Hp2ixB4BdnJ0MhqRwiqAS7IYNn09rXP1G1C2PRhoX9YRGn5xRzhh wGp7cHdi04su8YcdHl9QN5zB9XdoBwEM72OKWAqpQTOpw0Pk6DjIxsIEORRyp4KF4ZoM b3FvT0RHGC8KGLMbFImZXsOPiZ4NZyesE5GsyuwbOIxcztipNYCt6eJl9WfEf8egrhu3 6pjPq1vOMRK+Z26jVJiMAbKzX9KcBC1f1oM48xoQiOxQQfPwX2zExCQjN1aa/VA2wmW3 iDgw== X-Gm-Message-State: AJIora/dwCdlwnLgoTXIL97WT7FolJXPjS9T5c3rL0EaZ9intFA8LfPl vCicaVP8YcWkOsGAGLTtxR3s5hTobinBCkaK X-Google-Smtp-Source: AGRyM1snSJypU6dILUTdUXbGTNXpz8Frq8XPTg9X0W0Tdy4nWGqi4/aVEaxEarcatdoL3CshLsyH+g== X-Received: by 2002:ac8:5a53:0:b0:305:12:fc8f with SMTP id o19-20020ac85a53000000b003050012fc8fmr3810125qta.446.1656177144951; Sat, 25 Jun 2022 10:12:24 -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 ez11-20020a05622a4c8b00b00317790341dbsm3496141qtb.56.2022.06.25.10.12.24 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Sat, 25 Jun 2022 10:12:24 -0700 (PDT) From: Sean Anderson To: u-boot@lists.denx.de, Heinrich Schuchardt Cc: Simon Glass , Sean Anderson Subject: [PATCH v3 01/14] doc: mkimage: Use standard style for synopsis Date: Sat, 25 Jun 2022 13:12:08 -0400 Message-Id: <20220625171221.2391284-2-seanga2@gmail.com> X-Mailer: git-send-email 2.35.1 In-Reply-To: <20220625171221.2391284-1-seanga2@gmail.com> References: <20220625171221.2391284-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.6 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 formatting 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. In addition to the above style changes, this also makes some changes to content. The use of the term "legacy" has been removed, since this simply refers to any non-FIT image type. Additionally, wording like "uimage file name" has been replaced with "image-file-name" to better reflect that images may or may not be uImages. Lastly, the "auto" value for -f is documented in the synopsis. Signed-off-by: Sean Anderson --- Changes in v3: - Document the various content changes in the commit message - Fix typo in commit message - Remove "legacy" wording from synopsis - Reorder "legacy" synopsis first Changes in v2: - Fix spacing for -F doc/mkimage.1 | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/doc/mkimage.1 b/doc/mkimage.1 index 759dc2d12f..7e025d092c 100644 --- a/doc/mkimage.1 +++ b/doc/mkimage.1 @@ -3,17 +3,28 @@ .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\~ .\|.\|.\&] +.OP \-T type +.I image-file-name +.YS -.B mkimage -.RB [\fIoptions\fP] " \-F [" "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] " (legacy mode)" +.SY mkimage +.RI [ option\~ .\|.\|.\&] +.BI \-F\~ image-file-name +.YS .SH "DESCRIPTION" The -- 2.35.1