Re: [PATCH v4 1/5] smartpqi: add module parameter ctrl_ready_timeout

[Alejandro Colomar <alx@kernel.org>]

[-- Attachment #1: Type: text/plain, Size: 2467 bytes --]

Hi Don,

On Mon, Oct 02, 2023 at 02:54:00PM -0500, Don Brace wrote:
> Allow user to change the length of time that the driver
> will wait for the controller to become ready.
> 
> Reviewed-by: Scott Benesh <scott.benesh@microchip.com>
> Reviewed-by: Scott Teel <scott.teel@microchip.com>
> Reviewed-by: Mike McGowen <mike.mcgowen@microchip.com>
> Reviewed-by: Kevin Barnett <kevin.barnett@microchip.com>
> Signed-off-by: Don Brace <don.brace@microchip.com>
> ---
>  man4/smartpqi.4 | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/man4/smartpqi.4 b/man4/smartpqi.4
> index 32f9240e37f2..5ccbbe1c4ef1 100644
> --- a/man4/smartpqi.4
> +++ b/man4/smartpqi.4
> @@ -17,6 +17,7 @@ smartpqi \- Microchip Smart Storage SCSI driver
>  .RB [ expose_ld_first= { 0 | 1 }]
>  .RB [ hide_vsep= { 0 | 1 }]
>  .RB [ disable_managed_interrupts= { 0 | 1 }]
> +.RB [ ctrl_ready_timeout= { 0 | 30-1800 }]
>  .YS
>  .SH DESCRIPTION
>  .B smartpqi
> @@ -107,6 +108,11 @@ Disables driver utilization of Linux kernel managed interrupts for controllers.
>  The managed interrupts feature automatically distributes interrupts
>  to all available CPUs and assigns SMP affinity.
>  The default value is 0 (managed interrupts enabled).
> +.TP
> +.BR ctrl_ready_timeout= { 0 | 30-1800 }
> +This option specifies the timeout in seconds for the driver to wait
> +for controller ready. The valid range is 0 or 30-1800. The default value

How about "for the controller to be ready"?

Also, please break lines after period (per "semantic newlines"
guidelines in man-pages(7)).

$ MANWIDTH=72 man man-pages | sed -n '/Use semantic newlines/,/^$/p'
   Use semantic newlines
       In the source of a manual page, new sentences should be started
       on  new  lines,  long  sentences  should be split into lines at
       clause breaks (commas, semicolons, colons, and so on), and long
       clauses should be split at phrase boundaries.  This convention,
       sometimes known as "semantic newlines", makes it easier to  see
       the  effect of patches, which often operate at the level of in‐
       dividual sentences, clauses, or phrases.


Regarding ranges, please say 0 or [30, 1800], to use standard syntax.

Thanks,
Alex

> +is 0, which causes the driver to use a timeout of 180 seconds.
>  .SH FILES
>  .SS Device nodes
>  Logical drives are accessed via the SCSI disk driver
> -- 
> 2.42.0.296.g493f462273
> 

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]