Bug 1322581

(In reply to Rob Evers from comment #0)

> Suggestions for improvement: 
> 
> rmmod driver-name or modprobe driver-name
> re> remove 'rmmod driver-name or'

No, that is not the intention. 

The purpose of this BZ is to replace the use of this command: 

rmmod driver-name

with this command:

modprobe -r driver-name

The reason to do this is because the Deployment Guide 

https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Deployment_Guide/sec-Unloading_a_Module.html

says 

====

Do not use rmmod directly!
Although the rmmod command can be used to unload kernel modules, it is recommended to use modprobe -r instead. 

====

In the Storage Admin. Guide I'd suggest replacing:

"rmmod driver-name or modprobe driver-name"

with the two lines: 

 modprobe --remove driver-name
 modprobe driver-name"

for clarity. 

The rest of the paragraph in the Storage Admin. Guide is correct and should remain as-is. 

Tom

Hi Rob and Tom,

Thank you very much for the info. This is the latest version of the Scanning Storage Interconnects chapter in the RHEL6 Storage Administration Guide:

http://jenkinscat.gsslab.pnq.redhat.com:8080/job/doc-Red_Hat_Enterprise_Linux-6-Storage_Administration_Guide%20%28html-single%29/lastStableBuild/artifact/tmp/en-US/html-single/index.html#scanning-storage-interconnects

>with the two lines: 
> modprobe --remove driver-name
> modprobe driver-name"

1)
I couldn't create two lines in DocBook, but I specified the commands it the the description, and I think it's clear.

2)
The first paragraph now says "Red Hat recommends using interconnect scanning only when necessary." Could we be more specific? What would the use cases be? We want our docs to be authoritative and provide guidelines to our customers. Any suggestions what to include?

3)
The content of the chapter was written a long time ago, so I've edited the chapter according to our current docs standards and I've simplified the language. I was careful not to change the meaning, but if you could quickly check the rest of the Scanning Storage Interconnects chapter, and let me know if you suggest any changes, I'd appreciate it.

Please let me know what you think, Rob.

Thank you!

(In reply to Milan Navratil from comment #3)
> Hi Rob and Tom,
> 
> Thank you very much for the info. This is the latest version of the Scanning
> Storage Interconnects chapter in the RHEL6 Storage Administration Guide:
> 
> http://jenkinscat.gsslab.pnq.redhat.com:8080/job/doc-
> Red_Hat_Enterprise_Linux-6-Storage_Administration_Guide%20%28html-single%29/
> lastStableBuild/artifact/tmp/en-US/html-single/index.html#scanning-storage-
> interconnects
> 
> >with the two lines: 
> > modprobe --remove driver-name
> > modprobe driver-name"
> 
> 1)
> I couldn't create two lines in DocBook, but I specified the commands it the
> the description, and I think it's clear.

I suggest changing the first sentence in the text:

The modprobe --remove driver-name and modprobe driver-name commands completely re-initizialize the state of all interconnects controlled by the driver.

with:

The command modprobe --remove driver-name followed by the command modprobe driver-name completely re-initializes the state of all interconnects controlled by the driver.

Reason: A naive user could misinterpret that either of the commands will cause the desired affect, as it is worded.

> 
> 2)
> The first paragraph now says "Red Hat recommends using interconnect scanning
> only when necessary." Could we be more specific? What would the use cases
> be? We want our docs to be authoritative and provide guidelines to our
> customers. Any suggestions what to include?

I think this should be left alone.

> 
> 3)
> The content of the chapter was written a long time ago, so I've edited the
> chapter according to our current docs standards and I've simplified the
> language. I was careful not to change the meaning, but if you could quickly
> check the rest of the Scanning Storage Interconnects chapter, and let me
> know if you suggest any changes, I'd appreciate it.
> 
> Please let me know what you think, Rob.

Looks good.  Nice improvements :)

> 
> Thank you!

The update is now available on the Red Hat Customer Portal:

https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/6/html-single/Storage_Administration_Guide/index.html#scanning-storage-interconnects

Closing this BZ.