doc: fix return value description for nvme_scan_topology

igaw · igaw · commit 7e26cf903853 · 2025-06-26T16:35:53.000+02:00
The current implementation returns 0 on success, update the
documentation accordingly.

Signed-off-by: Daniel Wagner &lt;wagi@kernel.org&gt;
diff --git a/src/nvme/tree.h b/src/nvme/tree.h
@@ -1404,7 +1404,7 @@ const char *nvme_subsystem_get_fw_rev(nvme_subsystem_t s);
  * Scans the NVMe topology and filters out the resulting elements
  * by applying @f.
  *
- * Return: Number of elements scanned
+ * Returns: 0 on success, -1 on failure with errno set.
  */
 int nvme_scan_topology(nvme_root_t r, nvme_scan_filter_t f, void *f_args);
 

Original file line number	Diff line number	Diff line change
`@@ -1404,7 +1404,7 @@ const char *nvme_subsystem_get_fw_rev(nvme_subsystem_t s);`
`1404`	`1404`	`* Scans the NVMe topology and filters out the resulting elements`
`1405`	`1405`	`* by applying @f.`
`1406`	`1406`	`*`
`1407`		`- * Return: Number of elements scanned`
	`1407`	`+ * Returns: 0 on success, -1 on failure with errno set.`
`1408`	`1408`	`*/`
`1409`	`1409`	`int nvme_scan_topology(nvme_root_t r, nvme_scan_filter_t f, void *f_args);`
`1410`	`1410`