Date: Thu, 18 Jul 2013 21:31:17 +0000 (UTC) From: Warren Block <wblock@FreeBSD.org> To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r42319 - head/en_US.ISO8859-1/books/fdp-primer/overview Message-ID: <201307182131.r6ILVH1W078640@svn.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: wblock Date: Thu Jul 18 21:31:16 2013 New Revision: 42319 URL: http://svnweb.freebsd.org/changeset/doc/42319 Log: Whitespace-only fixes. Translators, please ignore. Modified: head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml Modified: head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml Thu Jul 18 21:04:22 2013 (r42318) +++ head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml Thu Jul 18 21:31:16 2013 (r42319) @@ -64,8 +64,8 @@ </listitem> <listitem> - <para>Submit changes back for review and inclusion in - the &os; documentation.</para> + <para>Submit changes back for review and inclusion in the &os; + documentation.</para> </listitem> </itemizedlist> @@ -172,12 +172,12 @@ <para>For the fastest download, pick the nearest mirror from the list of <ulink url="&url.books.handbook;/subversion-mirrors.html">Subversion - mirror sites</ulink>.</para> + mirror sites</ulink>.</para> </step> <step> - <para>The editor to be used - should be configured as follows:</para> + <para>The editor to be used should be configured as + follows:</para> <itemizedlist> <listitem> @@ -200,21 +200,18 @@ </step> <step> - <para>Run - <command>svn up</command> to update the local working copy. - Edit the documentation files that need changes. - Before making major - changes to a file, ask for input on the - &a.doc;.</para> - - <para>To learn which tags and entities - are needed to achieve the desired formatting, - compare some text in the + <para>Run <command>svn up</command> to update the local + working copy. Edit the documentation files that need + changes. Before making major changes to a file, ask for + input on the &a.doc;.</para> + + <para>To learn which tags and entities are needed to achieve + the desired formatting, compare some text in the <acronym>HTML</acronym> formatted version of the document - to the text, tags, and entities - in the <acronym>XML</acronym> file. - References to the commonly used tags and entities can be - found in <xref linkend="xhtml-markup"/> and + to the text, tags, and entities in the + <acronym>XML</acronym> file. References to the commonly + used tags and entities can be found in + <xref linkend="xhtml-markup"/> and <xref linkend="docbook-markup"/>.</para> </step> @@ -225,10 +222,9 @@ <screen>&prompt.user; <userinput>igor -R filename.xml | less -RS</userinput></screen> <para>Review the output and edit the file to fix any - problems shown, then - rerun the command to find any remaining - problems. Repeat until all of the errors that are - fixable are resolved. If an error seems unsolvable, + problems shown, then rerun the command to find any + remaining problems. Repeat until all of the errors that + are fixable are resolved. If an error seems unsolvable, ask for assistance on the &a.doc;.</para> </step> @@ -238,16 +234,16 @@ <userinput>make</userinput> in the top-level directory of the type of documentation being edited will generate that documentation in split HTML format. For example, to build - the English version of the Handbook in <acronym>HTML</acronym>, type - <command>make</command> in the - <filename>en_US.ISO8859-1/books/handbook/</filename> - directory. This step is necessary to make sure that - edits do not break the build.</para> + the English version of the Handbook in + <acronym>HTML</acronym>, type <command>make</command> in + the <filename>en_US.ISO8859-1/books/handbook/</filename> + directory. This step is necessary to make sure that edits + do not break the build.</para> </step> <step> - <para>After successfully completing the previous steps, generate - a <quote>diff file</quote> of the changes:</para> + <para>After successfully completing the previous steps, + generate a <quote>diff file</quote> of the changes:</para> <screen>&prompt.user; <userinput>cd /usr/doc</userinput> &prompt.user; <userinput>svn diff > <replaceable>bsdinstall</replaceable>.diff.txt</userinput></screen> @@ -272,14 +268,14 @@ <guibutton>[ Browse... ]</guibutton> button to attach the <literal>.diff.txt</literal>.</para> - <para>Remember that the - <acronym>FDP</acronym> is comprised of volunteers who - review edits in their spare time and who live in different - time zones around the globe. It can take some time to review - changes. If a response is not received in a - reasonable amount of time, send a follow-up email to the - &a.doc; and ask if anyone has had a chance to review the - patch or if additional information is required.</para> + <para>Remember that the <acronym>FDP</acronym> is comprised + of volunteers who review edits in their spare time and who + live in different time zones around the globe. It can + take some time to review changes. If a response is not + received in a reasonable amount of time, send a follow-up + email to the &a.doc; and ask if anyone has had a chance to + review the patch or if additional information is + required.</para> </step> </procedure> </sect1>
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201307182131.r6ILVH1W078640>