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 98F07C433FE for ; Fri, 7 Jan 2022 02:32:10 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 16D15834A3; Fri, 7 Jan 2022 03:32:08 +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="H5gIrnEw"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 640E4834DE; Fri, 7 Jan 2022 03:32:06 +0100 (CET) Received: from mail-pj1-x102b.google.com (mail-pj1-x102b.google.com [IPv6:2607:f8b0:4864:20::102b]) (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 D3F2A83065 for ; Fri, 7 Jan 2022 03:32:01 +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-x102b.google.com with SMTP id m13so3994594pji.3 for ; Thu, 06 Jan 2022 18:32:01 -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=W2HlIe7qv3Q/jdamGiEfOX8zejm2Rc0FZ/4eDGjJ79Q=; b=H5gIrnEwxHyBSbgf82mKIVEYa4MqbDglpGhn4cN3x6bM6tjFh1XqtZpdR4wTPKP5P3 HnY9nZapqmQllk1nJchVwBhyCYjODXAOSktlEXz+uYE+LgYs2Dd+bkeNHuLhofxLppSY Ih2lKDl41oW0fvmutvp5f9hPO3g06oob9Q8QA2D2XCerYWTxtja59+HeHNbRXbUJOuWL 3q4xnSbf+aJChwmYszizjcG229bMF973S4Moap4zsvigQU2ZLETRbkhORRzzrLueMSYG Obzn9TprbW3+dVcYgvMvc1KDRHkPPoMDiy0l7SXdnwgZ/fDEkdB4YCIN9zD9tKsaqj7Z rR2w== 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=W2HlIe7qv3Q/jdamGiEfOX8zejm2Rc0FZ/4eDGjJ79Q=; b=e+Rin6sooy4Ry1LYCfBFArt38tAjThEMFmpUBOIdeh6weFjr6GZ+klN3TB4sZ95JuR 8DmOyLJasYy2dDIJFJY/8tMGf5gWqzJZHFHNca7IJqqq/BvUv5jymoc/l+kr6HYCi3rz HH5OozpCJpWFrWtocoVWRvzrKF3PNkGAQn4nPfrAOZJXb9Chh7PdCCYEqECXWfk0G5Dg Ae5bXdOh9NpekjjUQPfqTkuF0dAY8xKJXJaq1XJGsvY4MnN00xJnsKU3N1pIgZdjncpT IEvQecIToVvQQHNrjonLWOffO+qDnGttpIBe99t0hmFlJIDu5+2L/LhWgi7dlV8ljAlT xamA== X-Gm-Message-State: AOAM533c64lPWXWZpEIiVXX+IxihEzfCIX1klX90OUQ3AAKsM5UQQybX YCtlVai+NWHJV/AyEKIs9zHI5Q== X-Google-Smtp-Source: ABdhPJzCN/4Zxxt3KAjSxIvPDpGLZDa15zX9LE4Jw7RcwIGbp5rzz4vfs0OruX/T4F12YS578IVgCQ== X-Received: by 2002:a17:903:32c9:b0:149:7d71:c235 with SMTP id i9-20020a17090332c900b001497d71c235mr50925225plr.58.1641522719975; Thu, 06 Jan 2022 18:31:59 -0800 (PST) Received: from laputa ([2400:4050:c3e1:100:3d0f:e67a:8677:2ac8]) by smtp.gmail.com with ESMTPSA id gk13sm7157477pjb.43.2022.01.06.18.31.57 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 06 Jan 2022 18:31:59 -0800 (PST) Date: Fri, 7 Jan 2022 11:31:55 +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: <20220107023155.GB11812@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> <20220106102514.GH45004@laputa> <5a4447ea-0bc7-1446-d0d1-8e4e5b94fd88@gmx.de> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <5a4447ea-0bc7-1446-d0d1-8e4e5b94fd88@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 On Thu, Jan 06, 2022 at 08:26:03PM +0100, Heinrich Schuchardt wrote: > On 1/6/22 11:25, AKASHI Takahiro wrote: > > 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. > > See man 7 man-pages: > > "The preferred way to write this in the source file is: > > .BR fcntl () > > (Using this format, rather than the use of "\fB...\fP()" makes it > easier to write tools that parse man page source files.)" Well, the sentence that you cited here has a precedent one: Any reference to the subject of the current manual page should be writ- ten with the name in bold followed by a pair of parentheses in Roman (normal) font. I doubt it is a general requirement. > > > > > > + > > > > +.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. > > Starting sentences in new lines makes future edits easier. ? I don't know what you are referring to here. > > > > + > > > > +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. > > See man 7 man-pages: > > "AUTHORS [Discouraged]" > > Your name can be placed in the copyright message. My point is: > > ditto > > I see AUTHORS sections in doc/kwboot.1 and doc/mkimage.1. and so > > So I'd like to see guidelines/rules for U-Boot first. -Takahiro Akashi > Best regards > > Heinrich > > > > > > > > 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 > > > > > > > > > > > > > > >