Libguestfs - Apr 2022 - [PATCH 1/2] api: Note that drive "name" field is no longer used

Before commit 3a00c4d179 ("Remove inspection from the C library and
switch to daemon/OCaml implementation") in 2017 the name parameter
passed to add_drive was used by inspection to override the device name
that is determined from fstab.  None of our tools ever actually used
this parameter, and when the inspection code was moved inside the
daemon we stopped using this hint field at all.

So it's no longer used, and likely hasn't been used ever.  Therefore
document that the field does nothing.
---
 generator/actions_core.ml | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/generator/actions_core.ml b/generator/actions_core.ml
index 23a2eabef8..ce9ee39cca 100644
--- a/generator/actions_core.ml
+++ b/generator/actions_core.ml
@@ -263,9 +263,8 @@ deprecated C<guestfs_add_drive_with_if> call (q.v.)
 
 =item C<name>
 
-The name the drive had in the original guest, e.g. F</dev/sdb>.
-This is used as a hint to the guest inspection process if
-it is available.
+This field used to be passed as a hint for guest inspection, but
+it is no longer used.
 
 =item C<label>
 
-- 
2.35.1

On 04/28/22 13:37, Richard W.M. Jones wrote:
> Before commit 3a00c4d179 ("Remove inspection from the C library and
> switch to daemon/OCaml implementation") in 2017 the name parameter
> passed to add_drive was used by inspection to override the device name
> that is determined from fstab.  None of our tools ever actually used
> this parameter, and when the inspection code was moved inside the
> daemon we stopped using this hint field at all.
> 
> So it's no longer used, and likely hasn't been used ever. 
Therefore
> document that the field does nothing.
> ---
>  generator/actions_core.ml | 5 ++---
>  1 file changed, 2 insertions(+), 3 deletions(-)
> 
> diff --git a/generator/actions_core.ml b/generator/actions_core.ml
> index 23a2eabef8..ce9ee39cca 100644
> --- a/generator/actions_core.ml
> +++ b/generator/actions_core.ml
> @@ -263,9 +263,8 @@ deprecated C<guestfs_add_drive_with_if> call
(q.v.)
>  
>  =item C<name>
>  
> -The name the drive had in the original guest, e.g. F</dev/sdb>.
> -This is used as a hint to the guest inspection process if
> -it is available.
> +This field used to be passed as a hint for guest inspection, but
> +it is no longer used.
>  
>  =item C<label>
>  
> 
Reviewed-by: Laszlo Ersek <lersek at redhat.com>