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 2020DC43334 for ; Sat, 25 Jun 2022 17:13:40 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 01DC384490; Sat, 25 Jun 2022 19:12:48 +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="AideO/AJ"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id ABBDC84392; Sat, 25 Jun 2022 19:12:36 +0200 (CEST) Received: from mail-qk1-x72e.google.com (mail-qk1-x72e.google.com [IPv6:2607:f8b0:4864:20::72e]) (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 039198441B for ; Sat, 25 Jun 2022 19:12:32 +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-x72e.google.com with SMTP id p21so4219425qki.7 for ; Sat, 25 Jun 2022 10:12:31 -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=iGDMGsQisgl7LVfN9WRX1mloGFIYE7eFgkWsPvYhzes=; b=AideO/AJueFF126NMXxmqx6Bliw4pGhsrIr/NvsGsYyosk3seDXBBGmdpqPcwckqUY hnEeXzTH5F9/96LQZyfh2ZvswEYDDvQ3v9aPlWI0l059r3+X3RWjaLvnXtIRCTT9Dzn+ /Xg+VNcYfg1DhwXi06n4WpL3AN7bgzGskNoOtsDB5ehpD9YShZQ1wkSaVyJHUI0psVkz IeuZAv15HPivnKYei82Ua/rAZSVmierFx0DYe16UGtJZUNC8i2w8qmB6VBMXN/Ab4IHU RDrREXNwxsFHhwviTDjyYP6z/qvOvEFO4K4gh9/r6Z+BLQj8d+XXMOFcQOSL6FMLXTLV RgTw== 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=iGDMGsQisgl7LVfN9WRX1mloGFIYE7eFgkWsPvYhzes=; b=J0jM6OJe8h273ODCGtCdjgMdDhieogzIV5OgXltUyBffQcd3dyvTcCe1DMJ5//wbiz sgGlsET7ZvJ269KRTTezqbkwOmzX8qAjoNne8LVexKjbet0p4RHBBtww0EufeREeojx5 Sjz5btvRGRbeJJSfPIw4hSgeMoIdmQTUBSeviwIADktm/7nKvkZyeuHlB2kpesudnD9+ eilHCtRRRBmaFS/CA6/0reVuKvzYx++WHzB2NdTE86YdlhTrVjMYYAqhZPtkKtNpHUwG bvVORPelD2DqQhnAJ/3fW47158bOFQhi3cSGtVFEzu7RzlLGK0xqd0l/6I4R/Myb8XlY HHLA== X-Gm-Message-State: AJIora8svz7YhjwlTX22fGfVZWYStiYq3ge4yM/HqT8Mts2mcj0PC+ix e7bnbubzWdidqtLSVBXd+bfTT9YHIFHQpe5T X-Google-Smtp-Source: AGRyM1uMN3UrZaB2BVVpC1GG6yS/UzRRlWz9ZRYFwrQ3iHcwlVlA7U3POgoEFRNJ6q5qLyXoW+Annw== X-Received: by 2002:a37:9d05:0:b0:6af:902:51ac with SMTP id g5-20020a379d05000000b006af090251acmr3367119qke.254.1656177150429; Sat, 25 Jun 2022 10:12:30 -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 bs42-20020a05620a472a00b006a6dcd92eb3sm4605139qkb.121.2022.06.25.10.12.29 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Sat, 25 Jun 2022 10:12:30 -0700 (PDT) From: Sean Anderson To: u-boot@lists.denx.de, Heinrich Schuchardt Cc: Simon Glass , Sean Anderson Subject: [PATCH v3 06/14] doc: mkimage: Rearrange/remove some options Date: Sat, 25 Jun 2022 13:12:13 -0400 Message-Id: <20220625171221.2391284-7-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 This moves some options which work in any mode to the general options section. -p is moved to after -E/-B since those options are related. This also adds documentation for -h and -V. The -F, -l, and -G options are documented twice. Remove the second documentation in each case. The synopsis for -l also suggests an implied second uimage-file-name parameter. E.g. mkimage [-l uimage-file-name] uimage-file-name This is misleading, so remove it. Wrap a few lines to 80 characters as well. Signed-off-by: Sean Anderson --- (no changes since v2) Changes in v2: - Document -h and -V - Rearrange more options doc/mkimage.1 | 62 ++++++++++++++++++++++++--------------------------- 1 file changed, 29 insertions(+), 33 deletions(-) diff --git a/doc/mkimage.1 b/doc/mkimage.1 index 025ebc0aff..34c0c2050f 100644 --- a/doc/mkimage.1 +++ b/doc/mkimage.1 @@ -55,8 +55,18 @@ supports verified boot. .SS General options . .TP -.BI \-l " uimage-file-name" -mkimage lists the information contained in the header of an existing U-Boot image. +.B \-h +Print a help message and exit. +. +.TP +.B \-l +mkimage lists the information contained in the header of an existing U-Boot +image. +. +.TP +.B \-s +Don't copy in the image data. Depending on the image type, this may create +just the header, everything but the image data, or nothing at all. . .TP .BI \-T " image-type" @@ -66,13 +76,22 @@ Without this option image type is autodetected. . .TP .B \-q -Quiet. Don't print the image header on successful verification. +Quiet. Don't print the image header. +. +.TP +.B \-v +Verbose. Print file names as they are added to the image. +. +.TP +.B \-V +Print version information and exit. . .SS General image-creation options . .TP .BI \-A " architecture" -Set architecture. Pass \-h as the architecture to see the list of supported architectures. +Set architecture. Pass \-h as the architecture to see the list of supported +architectures. . .TP .BI \-O " os" @@ -80,11 +99,6 @@ Set operating system. bootm command of u-boot changes boot method by os type. Pass \-h as the OS to see the list of supported OS. . .TP -.BI \-T " image-type" -Set image type. -Pass \-h as the image to see the list of supported image type. -. -.TP .BI \-C " compression-type" Set compression type. Pass \-h as the compression to see the list of supported compression type. @@ -98,10 +112,6 @@ Set load address with a hex number. Set entry point with a hex number. . .TP -.B \-l -List the contents of an image. -. -.TP .BI \-n " image-name" Set image name to 'image name'. . @@ -142,15 +152,6 @@ Use image data from 'image data file'. .B \-x Set XIP (execute in place) flag. . -.TP -.B \-s -Don't copy in the image data. Depending on the image type, this may create -just the header, everything but the image data, or nothing at all. -. -.TP -.B \-v -Verbose. Print file names as they are added to the image. -. .SS Options for creating FIT images . .TP @@ -183,6 +184,12 @@ The alignment, in hexadecimal, that external data will be aligned to. This option only has an effect when \-E is specified. . .TP +.BI \-p " external-position" +Place external data at a static external position. See \-E. Instead of writing +a 'data-offset' property defining the offset from the end of the FIT, \-p will +use 'data-position' as the absolute position from the base of the FIT. +. +.TP .BI \-f " image-tree-source-file" Image tree source file that describes the structure and contents of the FIT image. @@ -223,11 +230,6 @@ verification. Typically the file here is the device tree binary used by CONFIG_OF_CONTROL in U-Boot. . .TP -.BI \-G " key-file" -Specifies the private key file to use when signing. This option may be used -instead of \-k. -. -.TP .BI \-g " key-name-hint" Sets the key-name-hint property when used with \-f auto. This is the part of the key. The directory part is set by \-k. This option also indicates @@ -240,12 +242,6 @@ Specifies the algorithm to be used for signing a FIT image. The default is taken from the signature node's 'algo' property. . .TP -.BI \-p " external-position" -Place external data at a static external position. See \-E. Instead of writing -a 'data-offset' property defining the offset from the end of the FIT, \-p will -use 'data-position' as the absolute position from the base of the FIT. -. -.TP .B \-r Specifies that keys used to sign the FIT are required. This means that they must be verified for the image to boot. Without this option, the verification -- 2.35.1