ata: libata-core: Fix the ata_host_register() kdoc

ata_host_register() does not start the ports of the host, it requires
them to have been started already:

	/* host must have been started */
	if (!(host->flags & ATA_HOST_STARTED)) {
		dev_err(host->dev, "BUG: trying to register unstarted host\n");
		WARN_ON(1);
		return -EINVAL;
	}

Fix the kdoc accordingly, and fix the grammar of the last sentence while
at it.

Reviewed-by: Damien Le Moal <dlemoal@kernel.org>
Link: https://lore.kernel.org/r/20260915084127.692494-14-cassel@kernel.org
Signed-off-by: Niklas Cassel <cassel@kernel.org>
This commit is contained in:
Niklas Cassel 2026-09-15 10:41:32 +02:00
parent d2f977008c
commit 52d19459ca

View File

@ -6237,9 +6237,9 @@ static void async_port_probe(void *data, async_cookie_t cookie)
* @sht: template for SCSI host
*
* Register initialized ATA host. @host is allocated using
* ata_host_alloc() and fully initialized by LLD. This function
* starts ports, registers @host with ATA and SCSI layers and
* probe registered devices.
* ata_host_alloc(), fully initialized by the LLD and started using
* ata_host_start(). This function registers @host with the ATA and
* SCSI layers and probes the registered devices.
*
* On failure, the host remains started, i.e. the devres action
* registered by ata_host_start() is kept, so ->host_stop() is called by