Re: Release notes final draft

[Malcolm Tredinnick <malcolm commsecure com au>]

On Sat, Jun 22, 2002 at 06:15:19PM -0600, John Fleck wrote:
> The final draft of the release notes is done:
> http://www.inkstain.net/fleck/rnotes/index.html
> 
> In cvs:
> releng/2.x/g2releasenotes.xml
> 
> Comment soon. It needs to be completed Sunday so the translators can
> have a go at it.

The attached patch fixes a couple of layout problems. I don't think
<cmdsynopsis> and <arg> should be used for user input, since they lay
things out like the synopsis on a man page (and seemed to introduce
random newlines in some cases). This was particularly obvious in the
Python test under requirements and the gconf test on the upgrading page.

Otherwise, nice job, John. Thankyou.

Cheers,
Malcolm

? changes.diff
Index: g2releasenotes.xml
===================================================================
RCS file: /cvs/gnome/releng/2.x/g2releasenotes.xml,v
retrieving revision 1.8
diff -u -r1.8 g2releasenotes.xml
--- g2releasenotes.xml	23 Jun 2002 00:05:57 -0000	1.8
+++ g2releasenotes.xml	23 Jun 2002 01:40:34 -0000
@@ -622,13 +622,10 @@
 				  <para>
 					This means you need to be able to start python, it has
 					to be version 2.0 or greater and <quote>from xml.parsers 
-					  import expat</quote> must work from the Python prompt. 
-		    In other words, running <cmdsynopsis>
-<command>python2</command> 
-					<arg>-c</arg>
-		    </cmdsynopsis> <quote>from xml.parsers import expat</quote> 
-					from a shell prompt and having no error reported is 
-					sufficient.
+					import expat</quote> must work from the Python prompt. 
+					In other words, running <userinput>python2 -c &quot;from
+					xml.parsers import expat&quot;</userinput> from a shell
+					prompt and having no error reported is sufficient.
 				  </para>
 				</note>
 			  </para>
@@ -718,9 +715,9 @@
 				need to be able to start python, it has to be version 2.0 or 
 				greater and <quote>from xml.parsers import expat</quote> must 
 				work from the Python prompt. In other words, running 
-				<cmdsynopsis><command>python2</command> <arg>-c</arg>
-				</cmdsynopsis> <quote>from xml.parsers import expat</quote> 
-				from a shell prompt and having no error reported is sufficient.
+				<userinput>python2 -c &quot;from xml.parsers import
+				expat&quot;</userinput> from a shell prompt and having no
+				error reported is sufficient.
 			  </para></listitem>
 			<listitem><para>openjade</para></listitem>
 			<listitem><para>sgml-common</para></listitem>
@@ -937,7 +934,7 @@
 		It is possible to build all these packages in a different location from
 		the default <filename class="directory"><replaceable>/usr/local
 	  </replaceable></filename> (by passing the <cmdsynopsis>
-<arg>--prefix=
+<arg choice="plain">--prefix=
 		  <replaceable>location</replaceable></arg>
 	</cmdsynopsis> flag to the 
 		<command>configure</command> script in each tarball). If you do that,
@@ -995,17 +992,9 @@
     </para>
     <para>
       Ensure that any existing GNOME 1.x sessions have been exited and check
-      that GConfd has stopped (run 
-      <cmdsynopsis>
-      <command>ps</command> <arg>ax</arg>
-      </cmdsynopsis> | <cmdsynopsis> 
-	  <command>grep</command> <arg>[g]conf</arg>
-      </cmdsynopsis>). If 
-	  <application>gconf</application> is still running, execute the command 
-      <cmdsynopsis>
-	<command>gconftool-1</command> <arg>--shutdown</arg>
-      </cmdsynopsis>
-      to stop it.
+      that GConfd has stopped (run <userinput>ps ax | grep [g]conf</userinput>).
+	  If <application>gconf</application> is still running, execute the command
+	  <userinput>gconftool-1 --shutdown </userinput> to stop it.
     </para>
     <para>
       In order to have anti-aliased fonts in menus and applications, you will