[PATCH v2 6/8] Update NVRAM documentation

[Peter Krempa]

On Fri, Apr 08, 2022 at 10:48:49 -0700, Rohit Kumar wrote:
> Updating the doc as now NVRAM can be remote as well.
> 
> Signed-off-by: Prerna Saxena <prerna.saxena at nutanix.com>
> Signed-off-by: Florian Schmidt <flosch at nutanix.com>
> Signed-off-by: Rohit Kumar <rohit.kumar3 at nutanix.com>
> ---
>  docs/formatdomain.rst | 43 +++++++++++++++++++++++++++++++++++--------
>  1 file changed, 35 insertions(+), 8 deletions(-)
> 
> diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
> index 24fbfd8670..53361c7996 100644
> --- a/docs/formatdomain.rst
> +++ b/docs/formatdomain.rst

[....]

> @@ -222,14 +247,16 @@ harddisk, cdrom, network) determining where to obtain/find the boot image.
>     :since:`Since 2.1.0`
>  ``nvram``
>     Some UEFI firmwares may want to use a non-volatile memory to store some
> -   variables. In the host, this is represented as a file and the absolute path
> -   to the file is stored in this element. Moreover, when the domain is started
> -   up libvirt copies so called master NVRAM store file defined in ``qemu.conf``.
> -   If needed, the ``template`` attribute can be used to per domain override map
> -   of master NVRAM stores from the config file. Note, that for transient domains
> -   if the NVRAM file has been created by libvirt it is left behind and it is
> -   management application's responsibility to save and remove file (if needed to
> -   be persistent). :since:`Since 1.2.8`
> +   variables. They can be present on host or on some network storage.

Missing ':since:' annotation of when that was introduced.

> +   In the host, this is represented as a file and the absolute path
> +   to the file is stored in this element. On network storage,
> +   this can be accessed by providing network path.

There's no such thing as 'network path'. You'll need to refer back to
the disk configuration section.

> Moreover, when the domain
> +   is started up libvirt copies so called master NVRAM store file defined
> +   in ``qemu.conf``. If needed, the ``template`` attribute can be used to per
> +   domain override map of master NVRAM stores from the config file. Note, that
> +   for transient domains if the NVRAM file has been created by libvirt
> +   it is left behind and it is management application's responsibility to
> +   save and remove file (if needed to be persistent). :since:`Since 1.2.8`
>  ``boot``
>     The ``dev`` attribute takes one of the values "fd", "hd", "cdrom" or
>     "network" and is used to specify the next boot device to consider. The

This can be also theoretically merged into one commit which is adding
the schema. We do it like that usually.