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.

Reviewed-by: Laszlo Ersek <lersek@redhat.com>
This commit is contained in:
Richard W.M. Jones
2022-04-28 12:02:19 +01:00
parent bf8b876b68
commit b4081d0275

View File

@@ -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>