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 22D47C433EF for ; Sun, 12 Jun 2022 22:14:21 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 8573984411; Mon, 13 Jun 2022 00:14:19 +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="jLjuXXP3"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 842AA84429; Mon, 13 Jun 2022 00:14:18 +0200 (CEST) Received: from mail-qv1-xf2d.google.com (mail-qv1-xf2d.google.com [IPv6:2607:f8b0:4864:20::f2d]) (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 044F383E73 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-xf2d.google.com with SMTP id o43so3296538qvo.4 for ; Sun, 12 Jun 2022 15:14:15 -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=VtcV0DPStZN6oXj0O4rG3opiJXRO01EYyTdCY65q2Wk=; b=jLjuXXP3FuaHPaSuApTVq6Nsk8THkYC8R2BQKhYgn23jCNdSkd0ByGe14BGFkweC00 0t3n2KVpZbT6EuxycDQFEmnMomfA4XJ3DcS4t/egdYgHA4FML3EkNODKzGUzmjSZFr+i IAsXMXos7f3l9mnohzFpdOXaiFOjZ93IBAxisEnYdwRWhsr+f4/fp0jTDRlAoxglzE6I akh2E5Bi5Yz4Ruyo4lJ2KnK8Wf3/PnJTNxSMiAN8KA8EbCLVnL3iUsdh633ooRY4XjeO zPJvj3oErYAIign1/W+/WdsaXdQFIMC2pnnPNJgy5CYNkvNA1PrcJrR2kkpJouAQZtag T1Tg== 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=VtcV0DPStZN6oXj0O4rG3opiJXRO01EYyTdCY65q2Wk=; b=G4NpJfzD/zcsu2NeVysWnzuh8JZOfvER+eF9SolBZjBabtZzdBMcnb3kde88EFSDYX CgjITA59n72mNSZytLHioeVmmau+ismvePTV7aNZHWJopR+OOn3zbCbmJFt9o2p2dlgg wBcNIm6E2iic50E53QZ5EQzvDoSTimglI3I3PgbHu5x94S1k5SRqVQlsGQSZUAHjGGAK P1qv1Bq4MrFYYSA63c56Uo6BxLHWflgbeA6Me9AGRsUJTSFg7yvOl0GDbWyAUgJaAAHm xNLPh64Ikcxemm6VLVGYKrTBhGoR7Ak5/QEs9gc4otU1Q3Kl9eh6pu6V65c2vzdUUHu9 vLmg== X-Gm-Message-State: AOAM533s+mQCnLSbRqBYPj9Mh5R6qb0mF0FNkm8fz5pCly2BgFwNM060 bHv5npylhHuI8x62d6ntvIgH5CYh1Njh38+m X-Google-Smtp-Source: ABdhPJwGR8lFygdSmMEBZL9bUP83h9jwOlpzLVNMh5ahjCDXy73Y4W81IKD/cu6lD4INTaRKeF5gEQ== X-Received: by 2002:a05:6214:250d:b0:464:69ea:7725 with SMTP id gf13-20020a056214250d00b0046469ea7725mr46204452qvb.51.1655072054465; Sun, 12 Jun 2022 15:14:14 -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 u8-20020a05620a430800b006a6b374d8bbsm5051345qko.69.2022.06.12.15.14.13 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Sun, 12 Jun 2022 15:14:14 -0700 (PDT) From: Sean Anderson To: u-boot@lists.denx.de, Heinrich Schuchardt Cc: Simon Glass , Sean Anderson Subject: [PATCH v2 00/14] doc: mkimage: Rework and refactor the man page; add long options Date: Sun, 12 Jun 2022 18:13:57 -0400 Message-Id: <20220612221411.1608406-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.5 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 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 | 933 ++++++++++++++++++++++++++++++++++-------------- tools/mkimage.c | 45 ++- 3 files changed, 811 insertions(+), 270 deletions(-) create mode 100644 doc/dumpimage.1 -- 2.35.1