Re: [PATCH v17 08/20] libtasn1: Add the documentation

[Daniel Kiper]

On Fri, Jun 14, 2024 at 02:45:41PM +0800, Gary Lin wrote:
> Document libtasn1 in docs/grub-dev.texi and add the upgrade steps.
> Also add the patches to make libtasn1 compatible with grub code.
>
> Signed-off-by: Gary Lin <glin@suse.com>
> Reviewed-by: Vladimir Serbinenko <phcoder@gmail.com>
> ---
>  docs/grub-dev.texi | 33 +++++++++++++++++++++++++++++++++
>  1 file changed, 33 insertions(+)
>
> diff --git a/docs/grub-dev.texi b/docs/grub-dev.texi
> index 1276c5930..62856f0f1 100644
> --- a/docs/grub-dev.texi
> +++ b/docs/grub-dev.texi
> @@ -506,6 +506,7 @@ to update it.
>  * Gnulib::
>  * jsmn::
>  * minilzo::
> +* libtasn1::
>  @end menu
>
>  @node Gnulib
> @@ -596,6 +597,38 @@ cp minilzo-2.10/*.[hc] grub-core/lib/minilzo
>  rm -r minilzo-2.10*
>  @end example
>
> +@node libtasn1
> +@section libtasn1
> +
> +libtasn1 is a library providing Abstract Syntax Notation One (ASN.1, as
> +specified by the X.680 ITU-T recommendation) parsing and structures 
> management,
> +and Distinguished Encoding Rules (DER, as per X.690) encoding and decoding
> +functions.
> +
> +To upgrade to a new version of the libtasn1 library, download the release
> +tarball and copy the files into the target directory:
> +
> +@example
> +curl -L -O https://ftp.gnu.org/gnu/libtasn1/libtasn1-4.19.0.tar.gz
> +tar xf libtasn1-4.19.0.tar.gz
> +rm -rf grub-core/lib/libtasn1/
> +mkdir -p grub-core/lib/libtasn1/lib/
> +cp libtasn1-4.19.0/@lbracechar{}README.md,COPYING@rbracechar{} 
> grub-core/lib/libtasn1/
> +cp 
> libtasn1-4.19.0/lib/@lbracechar{}coding.c,decoding.c,element.c,element.h,errors.c,gstr.c,gstr.h,int.h,parser_aux.c,parser_aux.h,structure.c,structure.h@rbracechar{}
>  grub-core/lib/libtasn1/lib/
> +cp libtasn1-4.19.0/lib/includes/libtasn1.h grub-core/lib/libtasn1/
> +rm -rf libtasn1-4.19.0*

Please add commands for copying libtasn1 test files here too.

> +@end example
> +
> +After upgrading the library, it may be necessary to apply the patches in
> +@file{grub-core/lib/libtasn1-patches/} to adjust the code to be compatible 
> with
> +grub. These patches were needed to use the current version of libtasn1. The

s/grub/GRUB/

> +existing patches may not apply cleanly, apply at all, or even be needed for a
> +newer version of the library, and other patches maybe needed due to changes 
> in

s/maybe/may be/

> +the newer version. If existing patches need to be refreshed to apply cleanly,
> +please include updated patches as part of the a patch set sent to the list.
> +If new patches are needed or existing patches are not needed, also please 
> send
> +additions or removals as part of any patch set upgrading libtasn1.

Daniel