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 AE838C433EF for ; Sat, 25 Jun 2022 17:12:31 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id E60DB83FF6; Sat, 25 Jun 2022 19:12:28 +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="aFAOSEs1"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id D8F3083C97; Sat, 25 Jun 2022 19:12:27 +0200 (CEST) Received: from mail-qv1-xf2b.google.com (mail-qv1-xf2b.google.com [IPv6:2607:f8b0:4864:20::f2b]) (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 7154C83C97 for ; Sat, 25 Jun 2022 19:12:25 +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-xf2b.google.com with SMTP id 88so9095361qva.9 for ; Sat, 25 Jun 2022 10:12:25 -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:mime-version :content-transfer-encoding; bh=zE4ciZX9YmzKymxKDHkn0M/ARtrviR/ur/DCDfAMjKI=; b=aFAOSEs1y0caK0pY5mhsXcQ/iI/llWsWjPvWTEzHcQsjPMaWtpbFiE2BWG9MfR5H3v qdY1JycmsNMauaW1I2rv52KI249gWCWYDPBkrzMBgVROk6XDh7ZFKrynvO1Nlik9pr3e eOQVkfXTGbw001t1Y245vvVHI5zaobMqvBicRmYpAG5fgziKdfISSvi25hUd8dO17SPR VZs+cdFs1L4Z9IlMVjeXQkVHO39ga6gIaFBd+yZCfHgHX/9tAHGzio30ZUROycG4w9O+ xxMPgoSfD9SLFxIUXLtF/liOQhdFSy04FFp5uKeDbD5sjMYur32TOjYM21Iu95OZqyJ8 EgoA== 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:mime-version :content-transfer-encoding; bh=zE4ciZX9YmzKymxKDHkn0M/ARtrviR/ur/DCDfAMjKI=; b=RdXZOCzMEpitF7/AmMcJyIv04xUjO+r1LZ2zCZE1ljv+l/seJhNJj2yJhpzYSWfhDk 7sPQHZy/AoxXEKEt+8PNk/9GAcOEeW0dOxlexM82hDKUqBMIOXYwdgqJQO8YZbo4Dxw9 xnSQNmaJteT173M2cffXuqsaNl24h69K8JzVd3CpNfo3n6wltNakQZtg3YeA2D0KD0CH iIs+B0xpCbhxQw4OiZrlRLQp9wmCgVA7QBD2VF4xEA71IvQrwdtLpOR3eq7sX4r6FHrZ W4SLgJH2l2APRsvz43ioUQSRIl3xAB3sgFtj9qOwhGTRnGkWH5ZRZWiuK1RInPKsfSmc azJA== X-Gm-Message-State: AJIora/bTBeqyQsfoyBJCh1Whr8tbzkmoktcBaLOYkJJEWdSlLofiDAW se7Ul6QXzbx+5Dv6LG019sc/n8BbztaaAP/t X-Google-Smtp-Source: AGRyM1sRLDLGBvRRhR22IAeBWkF1xlD95fPR+s7wc4ANGThK0u7AR0pTXk/BLhUg1meDVP56l3CgDQ== X-Received: by 2002:a05:6214:20a7:b0:46e:eb13:c8fd with SMTP id 7-20020a05621420a700b0046eeb13c8fdmr3657896qvd.61.1656177144008; 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 l14-20020ac8148e000000b002f9399ccefasm3562822qtj.34.2022.06.25.10.12.23 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Sat, 25 Jun 2022 10:12:23 -0700 (PDT) From: Sean Anderson To: u-boot@lists.denx.de, Heinrich Schuchardt Cc: Simon Glass , Sean Anderson Subject: [PATCH v3 00/14] doc: mkimage: Rework and refactor the man page; add long options Date: Sat, 25 Jun 2022 13:12:07 -0400 Message-Id: <20220625171221.2391284-1-seanga2@gmail.com> X-Mailer: git-send-email 2.35.1 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 This gives a facelift for the mkimage man page, bringing it in line with the style perscribed by man-pages(7) and groff_man_style(7). I have tried to remove typographical and grammatical errors and inconsistencies wherever possible. The man page now both looks and feels closer to other Linux man pages. As a bonus, I also added a man page for dumpimage in the same style. To address the impending exhaustion of short options, this also adds long options for each short option. Changes in v3: - Clarify intent in commit message - Document option defaults - Document the various content changes in the commit message - Fix typo in commit message - Note that "legacy" images are only legacy for U-Boot. In particular, mkimage supports many other image formats using the same syntax which are decidedly not "legacy." - Remove "legacy" wording from synopsis - Remove usage of "legacy" in section headings - Reorder "legacy" synopsis first - Use multiple .BRs for the -f auto option list Changes in v2: - Add long options - Better document multi images - Document -h and -V - Ensure comments are requests - Escape minus signs in examples - Fix -B not being bolded in the description for -R - Fix extra quote in -E synopsis - Fix spacing for -F - Further document -o and -R - Indent things more robustly - Italicize parameter for -d - Make lists of valid algos bold - Rearrange more options - Remove spaces around pipes - Rename first subsection to "General options" - Use escape-sequences for options width all three of B/I/R. This renders better with mandoc. - Use paired quotation marks Sean Anderson (14): doc: mkimage: Use standard style for synopsis doc: mkimage: Use empty request instead of blank lines doc: mkimage: Reformat examples doc: mkimage: Regularize option documentation doc: mkimage: Use subsection macro doc: mkimage: Rearrange/remove some options doc: mkimage: Use correct capitalization for NAME doc: mkimage: Edit options for style and consistency doc: mkimage: Add BUGS section doc: mkimage: Add SEE ALSO section doc: mkimage: Remove AUTHORS section mkimage: Add long options doc: mkimage: Further document -o and -R doc: Add man page for dumpimage doc/dumpimage.1 | 103 +++++ doc/mkimage.1 | 977 +++++++++++++++++++++++++++++++++++------------- tools/mkimage.c | 45 ++- 3 files changed, 854 insertions(+), 271 deletions(-) create mode 100644 doc/dumpimage.1 -- 2.35.1