Re: [PATCH 13/13] docs: nvme-multipath: Add FC-NVMe marginal state

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Low] reStructuredText syntax errors and typographical omissions in the new documentation section will cause Sphinx build warnings and incorrect rendering.
--

--- Patch [13]: [PATCH 13/13] docs: nvme-multipath: Add FC-NVMe marginal state ---
commit f3dba11cc9add673447a799cef2fefc827b2c2d5
Author: Jesse Taube <[email protected]>

docs: nvme-multipath: Add FC-NVMe marginal state

This commit adds documentation for a new marginal state in NVMe over Fibre
Channel. It explains how to check and reset this state, and describes its
impact on multipath policies.

> diff --git a/Documentation/admin-guide/nvme-multipath.rst b/Documentation/admin-guide/nvme-multipath.rst
> index 97ca1ccef459b..8df4235d4d104 100644
> --- a/Documentation/admin-guide/nvme-multipath.rst
> +++ b/Documentation/admin-guide/nvme-multipath.rst
[ ... ]
> @@ -31,6 +31,23 @@ To set the desired policy (e.g., round-robin), use one of the following methods:
>     1. echo -n "round-robin" > /sys/module/nvme_core/parameters/iopolicy
>     2. or add the "nvme_core.iopolicy=round-robin" to cmdline.
>  
> +FC-NVMe
> +----

[Severity: Low]
This isn't a bug, but the underline is 4 characters long while the title is
7 characters. Could this cause a Sphinx warning about the title underline
being too short when building the kernel documentation?

> +On NVMe over Fibre Channel there is an additional state called `marginal`

[Severity: Low]
This isn't a bug, but it looks like this sentence is missing a terminal
period at the end of the line.

> +All policies will treat this path as offline and will not use it unless
> +all other paths are marginal or unavailable. In that case, the policy will
> +select the best path based on the policy.
> +
> +To see the current path state, use one of the following methods:
> +   1. cat /sys/class/fc_host/host*/device/rport-*/fc_remote_ports/rport-*/port_state
> +   2. cat /sys/devices/virtual/nvme-subsystem/nvme-subsys*/nvme*/state
> +To reset a path to online use:

[Severity: Low]
This isn't a bug, but reStructuredText usually expects a blank line to
terminate a list. Will omitting a blank line before "To reset a path to
online use:" cause formatting issues or incorrect list rendering in the
generated HTML documentation?

> +   1. echo "Online" > /sys/class/fc_host/host*/device/rport-*/fc_remote_ports/rport-*/port_state
[ ... ]

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=13