openstack/openstack-manuals
Code Issues Proposed changes

Reducing install guide build warnings

Browse Source 
Limiting the number of words per line in the install
guide and common content to reduce install
guide build  warnings concerning overflow from about 22 to 16

Change-Id: Iac4c5d429e2e35148e98885c180990f90cf9ca15
backport: juno
Closes-bug: #1273143
This commit is contained in:
Joseph Robinson
2014-11-12 12:13:31 +10:00
parent 3ba6b2aaf4
commit e9fd400193
6 changed files with 173 additions and 157 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
doc/common/section_conventions.xml
View File

@@ -14,7 +14,8 @@
<para>Something you must be aware of before proceeding.</para>
</important>
<warning>
<para>Critical information about the risk of data loss or security issues.</para>
<para>Critical information about the risk of data loss or security
issues.</para>
</warning>
</simplesect>
<simplesect xml:id="conventions-prompts">
@@ -23,16 +24,19 @@
<varlistentry>
<term><emphasis role="bold"><prompt>$</prompt> prompt</emphasis></term>
<listitem>
<para>Any user, including the <literal>root</literal> user, can run commands that are
prefixed with the <prompt>$</prompt> prompt.</para>
<para>Any user, including the <literal>root</literal> user,
can run commands that are
prefixed with the <prompt>$</prompt> prompt.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><emphasis role="bold"><prompt>#</prompt> prompt</emphasis></term>
<listitem>
<para>The <literal>root</literal> user must run commands that are prefixed with the
<prompt>#</prompt> prompt. You can also prefix these commands with the
<command>sudo</command> command, if available, to run them.</para>
<para>The <literal>root</literal> user must run commands
that are prefixed with the <prompt>#</prompt> prompt.
You can also prefix these commands with the
<command>sudo</command> command, if available,
to run them.</para>
</listitem>
</varlistentry>
</variablelist>