[PATCH v3 13/14] bloblist: Update documentation and header comment

[Ilias Apalodimas]

On Mon, 18 Dec 2023 at 20:20, Raymond Mao <raymond.mao at linaro.org> wrote:
>
> From: Simon Glass <sjg at chromium.org>
>
> Align the documentation with the v0.9 spec.
>
> Signed-off-by: Simon Glass <sjg at chromium.org>
> Signed-off-by: Raymond Mao <raymond.mao at linaro.org>
> ---
>  doc/develop/bloblist.rst | 4 +++-
>  include/bloblist.h       | 1 +
>  2 files changed, 4 insertions(+), 1 deletion(-)
>
> diff --git a/doc/develop/bloblist.rst b/doc/develop/bloblist.rst
> index 81643c7674..28431039ad 100644
> --- a/doc/develop/bloblist.rst
> +++ b/doc/develop/bloblist.rst
> @@ -14,6 +14,8 @@ structure defined by the code that owns it.
>  For the design goals of bloblist, please see the comments at the top of the
>  `bloblist.h` header file.
>
> +Bloblist is an implementation with the `Firmware Handoff`_ protocol.
> +
>  Passing state through the boot process
>  --------------------------------------
>
> @@ -99,7 +101,7 @@ API documentation
>  -----------------
>
>  .. kernel-doc:: include/bloblist.h
> -
> +.. _`Firmware Handoff`: https://github.com/FirmwareHandoff/firmware_handoff
>
>  Simon Glass
>  sjg at chromium.org
> diff --git a/include/bloblist.h b/include/bloblist.h
> index 8f0286fda7..e3c86808b4 100644
> --- a/include/bloblist.h
> +++ b/include/bloblist.h
> @@ -66,6 +66,7 @@
>   *
>   * Copyright 2018 Google, Inc
>   * Written by Simon Glass <sjg at chromium.org>
> + * Adjusted July 2023 to match Firmware handoff specification, Release 0.9
>   */
>
>  #ifndef __BLOBLIST_H
> --
> 2.25.1
>

Reviewed-by: Ilias Apalodimas <ilias.apalodimas at linaro.org>