[docs] winedev: Use proper entity escaping for '&','<' and '>'

Frédéric Delanoy frederic.delanoy at gmail.com
Thu Jul 18 15:33:58 CDT 2013


---
 en/winedev-architecture.sgml  |  6 +++---
 en/winedev-debugger.sgml      | 18 +++++++++---------
 en/winedev-debugging.sgml     | 14 +++++++-------
 en/winedev-documentation.sgml |  4 ++--
 en/winedev-kernel.sgml        |  4 ++--
 en/winedev-multimedia.sgml    | 10 +++++-----
 en/winedev-otherdebug.sgml    | 12 ++++++------
 en/winedev-testing.sgml       |  4 ++--
 8 files changed, 36 insertions(+), 36 deletions(-)

diff --git a/en/winedev-architecture.sgml b/en/winedev-architecture.sgml
index 88bd9b8..71007be 100644
--- a/en/winedev-architecture.sgml
+++ b/en/winedev-architecture.sgml
@@ -238,7 +238,7 @@
 +---------------------+        /
 
 +---------+ +---------+        \
-| Windows | | Windows |         \ application & system DLLs
+| Windows | | Windows |         \ application & system DLLs
 |   DLL   | |   DLL   |         /
 +---------+ +---------+        /
 
@@ -278,7 +278,7 @@
 +---------------------+                      /
 
 +---------+ +---------+                      \
-| Windows | | Windows |                       \ application & system DLLs
+| Windows | | Windows |                       \ application & system DLLs
 |   DLL   | |   DLL   |                       /
 +---------+ +---------+                      /
 
@@ -350,7 +350,7 @@
 +---------------------+                                  /
 
 +---------+ +---------+                                  \
-| Windows | | Windows |                                   \ application & system DLLs
+| Windows | | Windows |                                   \ application & system DLLs
 |   DLL   | |   DLL   |                                   /
 +---------+ +---------+                                  /
 
diff --git a/en/winedev-debugger.sgml b/en/winedev-debugger.sgml
index 012d6f1..830ebe0 100644
--- a/en/winedev-debugger.sgml
+++ b/en/winedev-debugger.sgml
@@ -450,7 +450,7 @@ ELF	f774a000-f774b000	Deferred        [vdso].so
 Threads:
 process  tid      prio (all id:s are in hex)
 00000008 (D) C:\Perfect World Entertainment\Perfect World International\element\elementclient.exe
-	00000031    0 <==
+	00000031    0 <==
 	00000035   15
 	00000012    0
 	00000021    0
@@ -634,7 +634,7 @@ process  tid      prio (all id:s are in hex)
         </para>
         <para>
           You can also run wine using <command>WINEDEBUG=+relay wine
-            program.exe 2>&1 | less -i</command> and in
+            program.exe 2>&1 | less -i</command> and in
           <command>less</command> search for <quote>MessageBox</quote>.
         </para>
       </sect2>
@@ -874,7 +874,7 @@ winedbg winfile.exe
               functions executed before <function>MessageBox()</function>.
               That's why you should re-run the program with e.g.
               <programlisting>
-WINEDEBUG=+relay wine <program name> &>relmsg
+WINEDEBUG=+relay wine <program name> &>relmsg
               </programlisting>
               Then do a <command>more relmsg</command> and search for the
               last occurrence of a call to the string "MESSAGEBOX".  This is a line like
@@ -1392,7 +1392,7 @@ set $BreakAllThreadsStartup = 1
           to a file on disk:
         </para>
         <programlisting>
-          WINEDEBUG=+relay wine <appname.exe> &>relay.log
+          WINEDEBUG=+relay wine <appname.exe> &>relay.log
         </programlisting>
         <para>
           Then run this command to see which calls are performed the most:
@@ -1640,7 +1640,7 @@ set $BreakAllThreadsStartup = 1
 
 	<para>
 	  <table>
-	    <title>WineDbg break & watch points</title>
+	    <title>WineDbg break & watch points</title>
 	    <tgroup cols="2" align="left">
 	      <tbody>
 		<row>
@@ -1806,11 +1806,11 @@ set $BreakAllThreadsStartup = 1
       </sect2>
 
       <sect2>
-        <title>Directory & source file manipulation</title>
+        <title>Directory & source file manipulation</title>
 
 	<para>
 	  <table>
-	    <title>WineDbg directory & source file manipulation</title>
+	    <title>WineDbg directory & source file manipulation</title>
 	    <tgroup cols="2" align="left">
 	      <tbody>
 		<row>
@@ -2237,7 +2237,7 @@ set $BreakAllThreadsStartup = 1
 		</row>
 		<row>
 		  <entry>
-		    <command>info map <N&gt</command>
+		    <command>info map <N></command>
 		  </entry>
 		  <entry>
 		    lists all virtual mappings used by the program of
@@ -2246,7 +2246,7 @@ set $BreakAllThreadsStartup = 1
 		</row>
 		<row>
 		  <entry>
-		    <command>info wnd <N&gt</command>
+		    <command>info wnd <N></command>
 		  </entry>
 		  <entry>
 		    prints information of Window of handle <N>
diff --git a/en/winedev-debugging.sgml b/en/winedev-debugging.sgml
index 5a13f59..7da3916 100644
--- a/en/winedev-debugging.sgml
+++ b/en/winedev-debugging.sgml
@@ -250,7 +250,7 @@ HANDLE32 WINAPI YourFunc(LPCSTR s)
 	  and then to run wine like that:
 	</para>
 	<screen>
-	<prompt>$</prompt> <userinput>WINEDEBUG=+relay,+snoop wine setup.exe &>/tmp/debug_pipe</userinput>
+	<prompt>$</prompt> <userinput>WINEDEBUG=+relay,+snoop wine setup.exe &>/tmp/debug_pipe</userinput>
 	</screen>
 
 	<para>
@@ -436,9 +436,9 @@ FIXME("(%x, %d, ...): stub\n", par1, par2, ...);
               <programlisting>
 char buffer[128] = "";
 
-if (flags & FLAG_A) strcat(buffer, "FLAG_A ");
-if (flags & FLAG_B) strcat(buffer, "FLAG_B ");
-if (flags & FLAG_C) strcat(buffer, "FLAG_C ");
+if (flags & FLAG_A) strcat(buffer, "FLAG_A ");
+if (flags & FLAG_B) strcat(buffer, "FLAG_B ");
+if (flags & FLAG_C) strcat(buffer, "FLAG_C ");
 TRACE("flags = %s\n", buffer);
               </programlisting>
               Most of the time however, it is better to create a helper
@@ -448,9 +448,9 @@ static const char *dbgstr_flags(int flags)
 {
     char buffer[128] = "";
 
-    if (flags & FLAG_A) strcat(buffer, "FLAG_A ");
-    if (flags & FLAG_B) strcat(buffer, "FLAG_B ");
-    if (flags & FLAG_C) strcat(buffer, "FLAG_C ");
+    if (flags & FLAG_A) strcat(buffer, "FLAG_A ");
+    if (flags & FLAG_B) strcat(buffer, "FLAG_B ");
+    if (flags & FLAG_C) strcat(buffer, "FLAG_C ");
     return wine_dbg_sprintf("flags = %s\n\n", buffer);
 }
 
diff --git a/en/winedev-documentation.sgml b/en/winedev-documentation.sgml
index 09e9cba..46c99a9 100644
--- a/en/winedev-documentation.sgml
+++ b/en/winedev-documentation.sgml
@@ -929,7 +929,7 @@
             Generally, you will declare which DTD you want to use as
             the first line of your SGML document.  In the case of
             DocBook, you will use something like this:
-            <programlisting>&lt!doctype book PUBLIC "-//OASIS//DTD
+            <programlisting><!doctype book PUBLIC "-//OASIS//DTD
             DocBook V3.1//EN" []> <book> ...
             </book></programlisting>
           </para>
@@ -937,7 +937,7 @@
             Note that you must specify your toplevel element inside
             the doctype declaration.  If you were writing an article
             rather than a book, you might use this declaration instead:
-            <programlisting>&lt!doctype article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" []>
+            <programlisting><!doctype article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" []>
 <article>
 ...
 </article></programlisting>
diff --git a/en/winedev-kernel.sgml b/en/winedev-kernel.sgml
index 7b88396..8e30896 100644
--- a/en/winedev-kernel.sgml
+++ b/en/winedev-kernel.sgml
@@ -1711,7 +1711,7 @@ if (res != ERROR_SUCCESS) return res;
 	  </sect4>
 	</sect3>
 	<sect3>
-	  <title>Devices & volume management</title>
+	  <title>Devices & volume management</title>
 	  <para>
 	    We've covered so far the ways file names are mapped into Unix
 	    paths.  There's still need to cover it for devices.  As a regular
@@ -1848,7 +1848,7 @@ if (res != ERROR_SUCCESS) return res;
 	    be read / write, IO control (and even others).
 	  </para>
 	  <para>
-	    Read and write operations are supported on real disks & CDROM
+	    Read and write operations are supported on real disks & CDROM
 	    devices, under several conditions:
 	    <itemizedlist>
 	      <listitem>
diff --git a/en/winedev-multimedia.sgml b/en/winedev-multimedia.sgml
index dc99ab1..7bc17c7 100644
--- a/en/winedev-multimedia.sgml
+++ b/en/winedev-multimedia.sgml
@@ -52,7 +52,7 @@
       <sect2>
 	<title>Windows 95 multimedia architecture</title>
 
-	<screen>
+    <screen><![CDATA[
              |
 Kernel space |                    Client applications
              |
@@ -93,7 +93,7 @@ Kernel space |                    Client applications
              |  |                               |<16
              |  +-------------------------------+
              |
-	</screen>
+    ]]></screen>
 
 	<para>
 	  The important points to notice are:
@@ -151,7 +151,7 @@ Kernel space |                    Client applications
       <sect2>
 	<title>Wine multimedia architecture</title>
 
-	<screen>
+    <screen><![CDATA[
              |
 Kernel space |                    Client applications
              |
@@ -187,7 +187,7 @@ Kernel space |                    Client applications
              |  |                               |<32/16
              |  +-------------------------------+
              |
-	</screen>
+    ]]></screen>
 
 	<para>
 	  From the previous drawings, the most noticeable differences are:
@@ -759,7 +759,7 @@ HKLM\Software\Microsoft\Windows NT\CurrentVersion
 	      <entry>Yes</entry>
 	    </row>
 	    <row>
-	      <entry>ACM and VIDC drivers (audio & video codecs)</entry>
+	      <entry>ACM and VIDC drivers (audio & video codecs)</entry>
 	      <entry>No</entry>
 	      <entry>Yes</entry>
 	      <entry>Yes</entry>
diff --git a/en/winedev-otherdebug.sgml b/en/winedev-otherdebug.sgml
index 0543e4e..8b208d5 100644
--- a/en/winedev-otherdebug.sgml
+++ b/en/winedev-otherdebug.sgml
@@ -82,7 +82,7 @@
 	<literal>0xc2 ll hh</literal> in memory. It is a reasonable
 	assumption that few, if any, functions take more than 16 arguments; 
 	therefore, simply searching for 
-	<literal>hh == 0 && ll < 0x40</literal>  starting from the 
+	<literal>hh == 0 && ll < 0x40</literal> starting from the
 	address of a function yields the correct number of arguments most 
 	of the time.
       </para>
@@ -167,7 +167,7 @@ git bisect bad wine-1.1.44
             it will automatically "position" your source tree to the middle.
             So all you need to do is build the source:
 	    <screen>
-./configure && make clean && make depend && make
+./configure && make clean && make depend && make
 ./wine 'c:\test.exe'
 	    </screen>
             If the version of Wine that Git picked still has the bug, run:
@@ -255,7 +255,7 @@ git bisect reset
         function <function>RegSetValueW</function> had the following
         lines in it:
         <screen>
-if (name && name[0])  /* need to create the subkey */
+if (name && name[0])  /* need to create the subkey */
 {
     if ((ret = RegCreateKeyW( hkey, name, &subkey )) != ERROR_SUCCESS) return ret;
 }
@@ -267,7 +267,7 @@ if (name && name[0])  /* need to create the subkey */
         by running gcov on the file. To do this, do the following:
         <screen>
 cd dlls/advapi32
-make clean && make EXTRACFLAGS=--coverage LDFLAGS=--coverage
+make clean && make EXTRACFLAGS=--coverage LDFLAGS=--coverage
 cd tests
 make test
 cd ..
@@ -277,7 +277,7 @@ less registry.c.gcov
         The interesting code part looks like this
         in <filename>registry.c.gcov</filename>:
         <screen>
-        4: 1273:    if (name && name[0])  /* need to create the subkey */
+        4: 1273:    if (name && name[0])  /* need to create the subkey */
         -: 1274:    {
     #####: 1275:        if ((ret = RegCreateKeyW( hkey, name, &subkey )) != ERROR_SUCCESS) return ret;
         -: 1276:    }
@@ -321,7 +321,7 @@ less registry.c.gcov
         <filename>registry.c.gcov</filename>:
       </para>
       <screen>
-        5: 1273:    if (name && name[0])  /* need to create the subkey */
+        5: 1273:    if (name && name[0])  /* need to create the subkey */
         -: 1274:    {
         1: 1275:        if ((ret = RegCreateKeyW( hkey, name, &subkey )) != ERROR_SUCCESS) return ret;
         -: 1276:    }
diff --git a/en/winedev-testing.sgml b/en/winedev-testing.sgml
index 940ae49..e626113 100644
--- a/en/winedev-testing.sgml
+++ b/en/winedev-testing.sgml
@@ -507,7 +507,7 @@ thread.c:123: Test failed: GetThreadPriorityBoost Failed
     BOOL rc;
 ...
     rc=GetThreadPriorityBoost(curthread,&disabled);
-    ok(rc!=0 && disabled==0,"rc=%d error=%ld disabled=%d\n",
+    ok(rc!=0 && disabled==0,"rc=%d error=%ld disabled=%d\n",
        rc,GetLastError(),disabled);
 </screen>
         This will yield:
@@ -568,7 +568,7 @@ thread.c:123: Test failed: rc=0 error=120 disabled=0
 <screen>
 todo_wine {
     SetLastError( 0xdeadbeef );
-    ok( GlobalAddAtomA(0) == 0 && GetLastError() == 0xdeadbeef, "failed to add atom 0\n" );
+    ok( GlobalAddAtomA(0) == 0 && GetLastError() == 0xdeadbeef, "failed to add atom 0\n" );
 }
 </screen>
         On Windows the above check would be performed normally, but on Wine it
-- 
1.8.3.2




More information about the wine-patches mailing list