Red Hat Bugzilla – Bug 1009637
duplicate openstack-config --set /etc/swift/swift.conf line
Last modified: 2014-01-05 23:25:32 EST
Title: Configuring the Object Storage Service Storage Nodes
Describe the issue:
# openstack-config --set /etc/swift/swift.conf swift-hash swift_hash_path_suffix $(openssl rand -hex 10)
Suggestions for improvement:
Only one line?
The two lines are not actually identical. As suggested in the preceding text one sets the value of swift_hash_path_prefix and the other sets the value of swift_hash_path_suffix.
Can the prefix and suffix parts of the commands be emboldened (is that really a word?)
I stared at the two lines multiple times and did not see the difference. If I made this mistake, someone else will also.
Per email we typically don't use <emphasis> in this way. Instead I would suggest:
a) Splitting the two commands into separate steps and associated <screen> boxes.
b) Using one or more continuation characters to split the lines down a little. E.g.:
# openstack-config --set /etc/swift/swift.conf \
$(openssl rand -hex 10)
I imagine in the PDF these lines don't fit on the page anyway so inclusion of the continuations is probably advisable to fix that as well.
In the lead up sentence (or sentences if split into two steps) it may also be worth highlighting which configuration key relates to each item. So for example this:
Use the <command>openstack-config</command> command to add a hash prefix and suffix to your <filename>/etc/swift.conf</filename>.
Use the <command>openstack-config</command> command to add a hash prefix (<literal>swift_hash_path_prefix</literal>) and suffix (<literal>swift_hash_path_suffix</literal>)to your <filename>/etc/swift.conf</filename>.