These patches are based the man page content found in
git://git.kernel.org/pub/scm/docs/man-pages/man-pages.git
The Linux man page smartpqi.4 is out-of-date with the man page provided
by our out-of-box driver. This patch series brings the Linux man page up
to date.
The changes are:
smarpqi-update-copyright-and-email-addresses
The copyright, email, and URLs have changed to Microchip.
smartpqi-update-module-parameter-descriptions
We changed some descriptions of some of our module parameters.
Clarifies what their default values are.
smartpqi-add-module-parameter_disable_managed_interrupts
We added a new module parameter to allow users to disable how
interrupts are managed allowing them to change affinity.
smartpqi-add-module-parameter_ctrl_ready_timeout
We added a new module parameter to allow users to change how
long the driver waits for the controller becomes ready. The
default is 180 seconds and can be changed from 30-1800 seconds.
The longer wait times are useful for large configurations.
smartpqi-update_FILES_section
Minor change to the FILES section. The word "Logical" was changed to
"Disk" since HBA disks are also supported.
smartpqi-update-host-attribute-descriptions
Updated the descriptions of existing host attributes accessed through
sysfs.
smartpqi-update-device-attribute-descriptions
Updated the descriptions of existing device attributes accessed through
sysfs.
smartpqi-add-host-attributes
We added some new host attributes:
enable_stream_detection: For RAID5/6 sequential write operations, this
can help increase IOPS. Reduces Read/Modify/Write operations.
This is for AIO capable devices. (Volumes consisting of non-rotating
media).
enable_r5_writes: Send down RAID 5 write operations down the AIO path.
enable_r6_writes: Send down RAID 6 write operations down the AIO path.
smartpqi-add-device-attributes
We added some new device attributes:
lunid - SCSI LUN ID
unique_id - 16-byte ID that uniquely identifies the device within the controller.
path_info - Host:Bus:Target:Lun (h:b:t:l), device type, Active/Inactive
raid_bypass_cnt - Count of the number of request sent down the AIO path.
sas_ncq_prio_enable - Enables SATA NCQ priority support.
smartpqi-add-sg-entry-to-see_also
Simple addition of the sg(4) driver to the SEE ALSO section.
Changes since V7:
Three patches left from the original series.
smartpqi-update-host-attribute-descriptions
smartpqi-remove-sysfs-entry-for-version
smartpqi-add-device-attributes
The changes since V6 are:
smartpqi-update-host-attribute-descriptions
I had removed some patch context, but did not update the patch
description to reflect the updated patch.
Alejandro Colomar <alx@xxxxxxxxxx>
Link: https://marc.info/?l=linux-man&m=169732291731554&w=2
smartpqi: add device attributes
Changed the sysfs path entry for each device attribute from ".I" to ".IR".
Alejandro Colomar <alx@xxxxxxxxxx>
Link: https://marc.info/?l=linux-man&m=169732400031940&w=2
Thanks Alejandro for your review and suggestions.
Changes since V6:
patch "(smartpqi-add-module-parameter_ctrl_ready_timeout)" was
applied.
patch "(smartpqi-update_FILES_section)" was applied.
Some minor updates requested by Alejandro Colomar <alx@xxxxxxxxxx>
Thanks Alejandro for your review and suggestions.
The V7 updates include the following patches:
smartpqi-update-host-attribute-descriptions
Moved the sysfs entry removal description for "version"
smartpqi-remove-sysfs-entry-for-version
New patch for removal of sysfs entry for "version".
Added HISTORY section.
Alejandro Colomar <alx@xxxxxxxxxx>
Link: https://marc.info/?l=linux-man&m=169680471921234&w=2
Changes since V5:
smartpqi: add module parameter ctrl_ready_timeout
Forgot to change the range of values for ctrl_ready_timeout.
Changed 0 or 30,1800 to 0 or [30,1800]
Alejandro Colomar <alx@xxxxxxxxxx>
Link: https://lore.kernel.org/linux-man/ZRtfS8DIxlqNN-XH@debian/
Sorry about that. Thanks for your review.
Changes since V4:
Added patch smartpqi-add-HISTORY-section
Added HISTORY section to explain that the sysfs entry for 'version'
was replaced by two new sysfs entries: driver_version, and firmware_version.
Suggested-by: Alejandro Colomar <alx@xxxxxxxxxx>
Link: https://lore.kernel.org/linux-man/ZRtgG396-1Cj4gn2@debian/
smartpqi: add module parameter ctrl_ready_timeout
Minor update to parameter description due to suggestion by:
Alejandro Colomar <alx@xxxxxxxxxx>
Link: https://lore.kernel.org/linux-man/ZRtfS8DIxlqNN-XH@debian/
Changes since V3:
Updated content for the following pages due to reviews by:
Alejandro Colomar <alx@xxxxxxxxxx>
smartpqi: add module parameter ctrl_ready_timeout
Link: https://lore.kernel.org/linux-man/axwssorupkp6fv3b7zqgjyd243exvhlw7rle2ftyy43jxhm4yf@woxzbz4hm766/
smartpqi: update FILES section
Link: https://lore.kernel.org/linux-man/fwpvmbussvf2zzug5bsqhrd7mvwcvdllvna6a4ngke3hw6w5am@b4icgpgirck4/
smartpqi: update host attribute descriptions
Link: https://lore.kernel.org/linux-man/ss7k5ooeoi7y56j6otvdpwhgd5yltzk6nt5l6ujiiupxzpmrdx@zrcvhw364ejx/
smartpqi: add host attributes
Link: https://lore.kernel.org/linux-man/nbt3jt7busx6akj7ykaxs7df6vlbbxtvcdy4ckvlp7saol3djl@rb6ckz3lzzot/
smartpqi: add device attributes
Link: https://lore.kernel.org/linux-man/ytcsqleu53iwpn5gsjmmuoqz2cy5oegvvafwlwxn422bcn3a5e@ne3khvixxzuq/
The other patches have already been applied and were removed from the
remaining patch set after a rebase.
Thanks for your attention and reviews for these patches.
Changes since V2:
Resending due to bad e-mail address for maintainer.
Changes since V1:
Broke up the large patch into multiple smaller patches due to review by:
Alejandro Colomar <alx@xxxxxxxxxx>
Link: https://lore.kernel.org/all/096ed4d5-945f-5ac9-eba3-c9be5d32cfe8@xxxxxxxxxx/
---
Don Brace (3):
smartpqi: update host attribute descriptions
smartpqi: remove sysfs entry for version
smartpqi: add device attributes
man4/smartpqi.4 | 124 ++++++++++++++++++++++++++++++++++++++++--------
1 file changed, 104 insertions(+), 20 deletions(-)
--
2.42.0.357.g59167d7d09
