docs: dma-api: clean up documentation of dma_map_sg()
authorPetr Tesarik <ptesarik@suse.com>
Fri, 27 Jun 2025 10:10:15 +0000 (12:10 +0200)
committerJonathan Corbet <corbet@lwn.net>
Tue, 1 Jul 2025 19:56:05 +0000 (13:56 -0600)
commitf304c25980ae6d101faa62a9dcc1ddeed260bd38
treec0cf3e3b69e88589a50b16b5070380eafdd8a93f
parent0ebbc69ebccf7e47eb150e8d1046e62d00ad781a
docs: dma-api: clean up documentation of dma_map_sg()

Describe in one sentence what the function does.

Do not repeat example situations when the returned number is lower than
the number of segments on input.

Signed-off-by: Petr Tesarik <ptesarik@suse.com>
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Marek Szyprowski <m.szyprowski@samsung.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20250627101015.1600042-9-ptesarik@suse.com
Documentation/core-api/dma-api.rst