From mboxrd@z Thu Jan 1 00:00:00 1970 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 C104FC433F5 for ; Thu, 6 Jan 2022 10:25:29 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id D6AAE8312A; Thu, 6 Jan 2022 11:25:26 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=linaro.org 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=linaro.org header.i=@linaro.org header.b="y5TNpzWH"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 319E483420; Thu, 6 Jan 2022 11:25:25 +0100 (CET) Received: from mail-pj1-x102c.google.com (mail-pj1-x102c.google.com [IPv6:2607:f8b0:4864:20::102c]) (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 2170E800AA for ; Thu, 6 Jan 2022 11:25:21 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=linaro.org Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=takahiro.akashi@linaro.org Received: by mail-pj1-x102c.google.com with SMTP id a11-20020a17090a854b00b001b11aae38d6so2699842pjw.2 for ; Thu, 06 Jan 2022 02:25:21 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=date:from:to:cc:subject:message-id:mail-followup-to:references :mime-version:content-disposition:in-reply-to; bh=l5GNTyv/m8ypuWFyGbIYJx1BN4QWy19/sIPRl+IIj7M=; b=y5TNpzWHPyuPMwvwFWMiFac/pAzYRR2f0dgwXKZV2Yq7/jI7yoUo/Zb4d73b2oKDK9 xgWXJc9qZpiNx0dAd/jotr3sf1viozJ0fJaUQ3BYGRqc6sFwk0P7tQY8BfN/Ymnyz4cs IzLEahRupGY66nCuPSDSSMwgVsIm7+gYm9o0RJ0xUC6dNpbSYpU3uH2pHE4lhHh3LGWL RrxrGkPEi/1uO6f8hll4pLH2qnLjG6kQE+zAT+gFzHcMqgeVDGf1UbkR5qkYaSMwdKNO Jd7f+Nnd/nr9YvRjT4jYem1+kKMCImML0+bebLgMEXWnE85OB1sVtWK3aXw9L2KqQ+R/ pmPQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:date:from:to:cc:subject:message-id :mail-followup-to:references:mime-version:content-disposition :in-reply-to; bh=l5GNTyv/m8ypuWFyGbIYJx1BN4QWy19/sIPRl+IIj7M=; b=39i+Fjy9zRjxZp12qd1ol4BJlXqD4710+1K7tWDsombfzibquO0gVt77vZFKdpkNFt tsktpeVLmoZlBDFRf/AefqgeE6kWX0QDAT5odThejb6RGqMUSJ8vfjb338LTLsQ3ro15 LnLxmnG467QVHXZ4gN+k2EAUzOGQqaDfBG4TShRdn3Dw4ikmlK0NkQcgMMEtbPMnS2Fc hKN951sT8Kz5EKZynWuG+CfjNWDRJZvU5qdxT55AGB1QLQkFKauAHNpmGDma7AHYmzPp RGsO84kU+O99F5mKv6qryFNL79GKfVdf0/NetOoZtTttu0KlrkGSEdBxWVLtNy046x6s AMtQ== X-Gm-Message-State: AOAM5328r3VlkNg+uYteZhKgFEELCLsZpJC9xX/QiG5Jopmk90TuGBkL UmPWBSgs6j2lXSHuTuJCRrgDig== X-Google-Smtp-Source: ABdhPJzToscb0EvJatBKlpGWe5bPOn62GNUOwB+/aYY+A5sUbQBhdWCb1ZmcsiOPBZ784bUT91ntaw== X-Received: by 2002:a17:902:7d81:b0:149:c926:7c2e with SMTP id a1-20020a1709027d8100b00149c9267c2emr8379912plm.27.1641464719284; Thu, 06 Jan 2022 02:25:19 -0800 (PST) Received: from laputa ([2400:4050:c3e1:100:9127:7a05:487c:d781]) by smtp.gmail.com with ESMTPSA id w8sm2146599pfu.162.2022.01.06.02.25.16 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 06 Jan 2022 02:25:18 -0800 (PST) Date: Thu, 6 Jan 2022 19:25:14 +0900 From: AKASHI Takahiro To: Heinrich Schuchardt Cc: agraf@csgraf.de, sjg@chromium.org, ilias.apalodimas@linaro.org, sughosh.ganu@linaro.org, masami.hiramatsu@linaro.org, mark.kettenis@xs4all.nl, u-boot@lists.denx.de Subject: Re: [PATCH v8 04/12] tools: mkeficapsule: add man page Message-ID: <20220106102514.GH45004@laputa> Mail-Followup-To: AKASHI Takahiro , Heinrich Schuchardt , agraf@csgraf.de, sjg@chromium.org, ilias.apalodimas@linaro.org, sughosh.ganu@linaro.org, masami.hiramatsu@linaro.org, mark.kettenis@xs4all.nl, u-boot@lists.denx.de References: <20211220050253.31163-1-takahiro.akashi@linaro.org> <20211220050253.31163-5-takahiro.akashi@linaro.org> <3c1c16af-71c4-24ab-a189-002afc94821c@gmx.de> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <3c1c16af-71c4-24ab-a189-002afc94821c@gmx.de> X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.38 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.2 at phobos.denx.de X-Virus-Status: Clean Heinrich, On Sat, Jan 01, 2022 at 11:02:52PM +0100, Heinrich Schuchardt wrote: > On 12/20/21 06:02, AKASHI Takahiro wrote: > > Add a man page for mkeficapsule command. > > > > Signed-off-by: AKASHI Takahiro > > Reviewed-by: Simon Glass > > Acked-by: Ilias Apalodimas > > --- > > MAINTAINERS | 1 + > > doc/mkeficapsule.1 | 95 ++++++++++++++++++++++++++++++++++++++++++++++ > > 2 files changed, 96 insertions(+) > > create mode 100644 doc/mkeficapsule.1 > > > > diff --git a/MAINTAINERS b/MAINTAINERS > > index e718ad213553..93ef5e297acc 100644 > > --- a/MAINTAINERS > > +++ b/MAINTAINERS > > @@ -723,6 +723,7 @@ S: Maintained > > T: git https://source.denx.de/u-boot/custodians/u-boot-efi.git > > F: doc/api/efi.rst > > F: doc/develop/uefi/* > > +F: doc/mkeficapsule.1 > > F: doc/usage/bootefi.rst > > F: drivers/rtc/emul_rtc.c > > F: include/capitalization.h > > diff --git a/doc/mkeficapsule.1 b/doc/mkeficapsule.1 > > new file mode 100644 > > index 000000000000..837e09ab451e > > --- /dev/null > > +++ b/doc/mkeficapsule.1 > > @@ -0,0 +1,95 @@ > > Please, provide copyright information. Cf. > https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/man7/fanotify.7. OK > > +.TH MAEFICAPSULE 1 "May 2021" > > + > > +.SH NAME > > +mkeficapsule \- Generate EFI capsule file for U-Boot > > + > > +.SH SYNOPSIS > > +.B mkeficapsule > > +.RB [\fIoptions\fP] " \fIcapsule-file\fP" > > .RI [ options ] " capsule-file I don't have any strong preference for those notations, but I simply followed the existing format used in doc/kwboot.1 and doc/mkimage.1 which are the only two instances of man pages in the U-Boot source. So I'd like to see guidelines/rules for U-Boot first. > > + > > +.SH "DESCRIPTION" > > +The > > +\fBmkeficapsule\fP > > .B mkeficapsule ditto I can find a use of "\fB" (and others) also in your reference: > https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/man7/fanotify.7. > > +command is used to create an EFI capsule file for use with the U-Boot > > +EFI capsule update. > > +A capsule file may contain various type of firmware blobs which > > +are to be applied to the system and must be placed in the specific > > +directory on the UEFI system partition. An update will be automatically > > +executed at next reboot. > > + > > +Optionally, a capsule file can be signed with a given private key. > > +In this case, the update will be authenticated by verifying the signature > > +before applying. > > + > > +\fBmkeficapsule\fP supports two different format of image files: > > .B mkeficapsule > supports two different format of image files: > > > +.TP > > +.I raw image > > +format is a single binary blob of any type of firmware. > > + > > +.TP > > +.I FIT (Flattened Image Tree) image > > +format > > +is the same as used in the new \fIuImage\fP format and allows for > > is the same as used in the new > .I uImage > format and allows for > > But why would you use italics for uImage? It is neither a command nor a > parameter. I don't know, but will drop the decoration here. > Please, rework the man page to avoid escape sequences. > > Best regards > > Heinrich > > > +multiple binary blobs in a single capsule file. > > +This type of image file can be generated by \fBmkimage\fP. > > + > > +.SH "OPTIONS" > > +One of \fB--fit\fP or \fB--raw\fP option must be specified. > > + > > +.TP > > +.BI "-f, --fit \fIfit-image-file\fP" > > +Specify a FIT image file > > + > > +.TP > > +.BI "-r, --raw \fIraw-image-file\fP" > > +Specify a raw image file > > + > > +.TP > > +.BI "-i, --index \fIindex\fP" > > +Specify an image index > > + > > +.TP > > +.BI "-I, --instance \fIinstance\fP" > > +Specify a hardware instance > > + > > +.TP > > +.BI "-h, --help" > > +Print a help message > > + > > +.TP 0 > > +.B With signing: > > + > > +\fB--private-key\fP, \fB--certificate\fP and \fB--monotonic-count\fP are > > +all mandatory. > > + > > +.TP > > +.BI "-p, --private-key \fIprivate-key-file\fP" > > +Specify signer's private key file in PEM > > + > > +.TP > > +.BI "-c, --certificate \fIcertificate-file\fP" > > +Specify signer's certificate file in EFI certificate list format > > + > > +.TP > > +.BI "-m, --monotonic-count \fIcount\fP" > > +Specify a monotonic count which is set to be monotonically incremented > > +at every firmware update. > > + > > +.TP > > +.BI "-d, --dump_sig" > > +Dump signature data into *.p7 file > > + > > +.PP > > +.SH FILES > > +.TP > > +.BI "\fI/EFI/UpdateCapsule\fP" > > +The directory in which all capsule files be placed > > + > > +.SH SEE ALSO > > +.B mkimage > > + > > +.SH AUTHORS > > +Written by AKASHI Takahiro > > man man-pages discourages using an AUTHORS paragraph. ditto I see AUTHORS sections in doc/kwboot.1 and doc/mkimage.1. > Please, put the information into copyright header. > > Best regards > > Heinrich > > > + > > +.SH HOMEPAGE > > +http://www.denx.de/wiki/U-Boot/WebHome For instance, no reference to "HOMEPAGE" in "man man-pages" but doc/mkimage.1 has one. -Takahiro Akashi > > > >