Re: [PATCH 1/7] ata: libata: Fix ata_tdev_free() kdoc comment

[Niklas Cassel <cassel@kernel.org>]

On Mon, Aug 26, 2024 at 04:31:00PM +0900, Damien Le Moal wrote:
> Fix the kdoc comment of ata_tdev_free() to correctly describe that this
> function operates on a ATA device and not on a link or PHY.
> 
> Signed-off-by: Damien Le Moal <dlemoal@kernel.org>
> ---
>  drivers/ata/libata-transport.c | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/drivers/ata/libata-transport.c b/drivers/ata/libata-transport.c
> index 48800cd0e75d..474816a9efa1 100644
> --- a/drivers/ata/libata-transport.c
> +++ b/drivers/ata/libata-transport.c
> @@ -660,14 +660,14 @@ static int ata_tdev_match(struct attribute_container *cont,
>  }
>  
>  /**
> - * ata_tdev_free  --  free a ATA LINK
> - * @dev:	ATA PHY to free
> + * ata_tdev_free  --  free a ATA device
> + * @dev:	ATA device to free
>   *
> - * Frees the specified ATA PHY.
> + * Free the specified ATA device.

Perhaps: "Frees the sysfs entry for the specified ATA device."

Perhaps do similar changes to the other ata_tdev_ functions.

E.g. for ata_tdev_delete() - "Remove the sysfs entry for the specified ATA device".


>   *
>   * Note:
> - *   This function must only be called on a PHY that has not
> - *   successfully been added using ata_tdev_add().
> + *   This function must only be called on a device that has not successfully
> + *   been added using ata_tdev_add().
>   */
>  static void ata_tdev_free(struct ata_device *dev)
>  {
> -- 
> 2.46.0
>