[3/3] [docs] winedev: Use 'replaceable' tags for data placeholders
Frédéric Delanoy
frederic.delanoy at gmail.com
Sat Aug 17 02:28:41 CDT 2013
---
en/winedev-coding.sgml | 25 +--
en/winedev-debugger.sgml | 407 ++++++++++++++++++++----------------------
en/winedev-debugging.sgml | 34 ++--
en/winedev-documentation.sgml | 4 +-
en/winedev-kernel.sgml | 99 +++++-----
en/winedev-multimedia.sgml | 10 +-
en/winedev-ole.sgml | 14 +-
en/winedev-otherdebug.sgml | 34 ++--
en/winedev-testing.sgml | 2 +-
9 files changed, 302 insertions(+), 327 deletions(-)
diff --git a/en/winedev-coding.sgml b/en/winedev-coding.sgml
index 8c9b0b7..7ff5f27 100644
--- a/en/winedev-coding.sgml
+++ b/en/winedev-coding.sgml
@@ -232,7 +232,7 @@ code
<sect2>
<title>
- Why <symbol>ifdef MyOS</symbol> is probably a mistake.
+ Why <userinput>ifdef <replaceable>MyOS</replaceable></userinput> is probably a mistake.
</title>
<para>
@@ -245,7 +245,7 @@ code
</para>
<para>
Furthermore, operating systems change names or <quote>fork</quote> into
- several ones. An <symbol>#ifdef MyOs</symbol> will break
+ several ones. An <symbol>#ifdef <replaceable>MyOS</replaceable></symbol> will break
over time.
</para>
<para>
@@ -287,7 +287,7 @@ code
</para>
<para>
There <emphasis>are</emphasis> exceptions to the <quote>avoid
- #ifdef MyOS</quote> rule. Wine, for example, needs
+ #ifdef <replaceable>MyOS</replaceable></quote> rule. Wine, for example, needs
the internals of the signal stack -- that cannot easily be
described in terms of features. Moreover, you cannot use
<filename>autoconf</filename> <symbol>HAVE_*</symbol>
@@ -303,7 +303,7 @@ code
<sect2>
<title>
- MyOS doesn't have the <filename>foo.h</filename> header!
+ <replaceable>MyOS</replaceable> doesn't have the <filename>foo.h</filename> header!
</title>
<para>
@@ -354,7 +354,7 @@ AC_CHECK_HEADER(foo.h, AC_DEFINE(HAVE_FOO_H))
<sect2>
<title>
- MyOS doesn't have the <function>bar</function> function!
+ <replaceable>MyOS</replaceable> doesn't have the <function>bar</function> function!
</title>
<para>
@@ -449,12 +449,12 @@ AC_CHECK_HEADER(foo.h, AC_DEFINE(HAVE_FOO_H))
</para>
<para>
- Language dependent resources reside in files
- named <filename>somefile_Xx.rc</filename> or
- <filename>Xx.rc</filename>, where <literal>Xx</literal>
+ Language dependent resources reside in files named
+ <filename><replaceable>somefile</replaceable>_<replaceable>Xx</replaceable>.rc</filename> or
+ <filename><replaceable>Xx</replaceable>.rc</filename>, where <replaceable>Xx</replaceable>
is your language abbreviation (look for it in
<filename>include/winnls.h</filename>). These are included
- in a master file named <filename>somefile.rc</filename> or
+ in a master file named <filename><replaceable>somefile</replaceable>.rc</filename> or
<filename>rsrc.rc</filename>, located in the same
directory as the language files.
</para>
@@ -462,9 +462,10 @@ AC_CHECK_HEADER(foo.h, AC_DEFINE(HAVE_FOO_H))
<para>
To add a new language to one of these resources you
need to make a copy of the English resource (located
- in the <filename>somefile_En.rc</filename> file) over to
- your <filename>somefile_Xx.rc</filename> file, include this
- file in the master <filename>somefile.rc</filename> file,
+ in the <filename><replaceable>somefile</replaceable>_En.rc</filename> file) over to your
+ <filename><replaceable>somefile</replaceable>_<replaceable>Xx</replaceable>.rc</filename>
+ file, include this file in the master
+ <filename><replaceable>somefile</replaceable>.rc</filename> file,
and edit the new file to translate the English text.
You may also need to rearrange some of the controls
to better fit the newly translated strings. Test your changes
diff --git a/en/winedev-debugger.sgml b/en/winedev-debugger.sgml
index b8cf880..ce72570 100644
--- a/en/winedev-debugger.sgml
+++ b/en/winedev-debugger.sgml
@@ -533,19 +533,20 @@ process tid prio (all id:s are in hex)
<para>
If you have found a misbehaving Wine function, try to find out
why it misbehaves. Find the function in the source code.
- Try to make sense of the arguments passed. Usually there is
- a <function>WINE_DEFAULT_DEBUG_CHANNEL(<channel>);</function>
+ Try to make sense of the arguments passed. Usually there is a
+ <function>WINE_DEFAULT_DEBUG_CHANNEL(<parameter><replaceable>channel</replaceable></parameter>);</function>
at the beginning of the source file. Rerun wine with the
<parameter>WINEDEBUG=+xyz,+relay</parameter> environment variable set.
</para>
<para>
Occasionally there are additional debug channels defined at the
beginning of the source file in the form
- <function>WINE_DECLARE_DEBUG_CHANNEL(<channel>);</function>
- If so the offending function may also uses one of these alternate
- channels. Look through the the function for
- <function>TRACE_(<channel>)(" ... /n");</function> and add any
- additional channels to the command line.
+ <function>WINE_DECLARE_DEBUG_CHANNEL(<parameter><replaceable>channel</replaceable></parameter>);</function>
+ if so the offending function may also use one of these alternate
+ channels. Look through the the function for
+ <function>TRACE_(<parameter><replaceable>channel</replaceable></parameter>)("
+<parameter><replaceable>...</replaceable></parameter> /n");</function> and add any
+ additional channels to the command line.
</para>
</listitem>
<listitem>
@@ -849,7 +850,7 @@ Wine-dbg>
use the Wine debugger normally, but Wine already executes the program's
start code, then you may use a special trick. You should do a
<programlisting>
-WINEDEBUG=+relay wine program
+WINEDEBUG=+relay wine <replaceable>program</replaceable>
</programlisting>
to get a listing of the functions the program calls in its start function.
Now you do a
@@ -874,7 +875,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 <replaceable>program_name</replaceable> &>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
@@ -984,10 +985,10 @@ winedbg myprog.exe
info reg (to see registers)
info stack (to see hex values in the stack)
info local (to see local variables)
- list <line number> (to list source code)
- x <variable name> (to examine a variable; only works if code
+ list <replaceable>line number</replaceable> (to list source code)
+ x <replaceable>variable name</replaceable> (to examine a variable; only works if code
is not compiled with optimization)
- x 0x4269978 (to examine a memory location)
+ x <replaceable>0x4269978</replaceable> (to examine a memory location)
? (help)
q (quit)
</screen>
@@ -1106,7 +1107,8 @@ winedbg myprog.exe
<listitem>
<para>
These are the <quote>normal</quote> Win16 addresses, called SEGPTR.
- They have a segment:offset notation, e.g. 0x01d7:0x0012.
+ They have a <replaceable>segment</replaceable>:<replaceable>offset</replaceable>
+ notation, e.g. 0x01d7:0x0012.
The segment part usually is a <quote>selector</quote>, which
<emphasis>always</emphasis>
has the lowest 3 bits set. Some sample selectors are
@@ -1136,15 +1138,16 @@ winedbg myprog.exe
</term>
<listitem>
<para>
- They, too, have a segment:offset notation. But they are
- completely different from <quote>normal</quote> Win16 addresses, as
- they just represent at most 1MB of memory: The segment
+ They, too, have a <replaceable>segment</replaceable>:<replaceable>offset</replaceable>
+ notation. But they are completely different from <quote>normal</quote> Win16
+ addresses, as they just represent at most 1MB of memory: the segment
part can be anything from 0 to 0xffff, and it's the same
with the offset part.
</para>
<para>
Now the strange thing is the calculation that's behind
- these addresses: just calculate segment*16 + offset in
+ these addresses: just calculate <replaceable>segment</replaceable>*16 +
+ <replaceable>offset</replaceable> in
order to get a <quote>linear DOS</quote> address. So
e.g. 0x0f04:0x3628 results in 0xf040 + 0x3628 = 0x12668.
And the highest address you can get is 0xfffff (1MB), of
@@ -1386,7 +1389,7 @@ set $BreakAllThreadsStartup = 1
to a file on disk:
</para>
<programlisting>
- WINEDEBUG=+relay wine <appname.exe> &>relay.log
+ WINEDEBUG=+relay wine <replaceable>appname.exe</replaceable> &>relay.log
</programlisting>
<para>
Then run this command to see which calls are performed the most:
@@ -1460,7 +1463,7 @@ set $BreakAllThreadsStartup = 1
</listitem>
</varlistentry>
<varlistentry>
- <term><registers></term>
+ <term><replaceable>registers</replaceable></term>
<listitem>
<para>
All CPU registers are also available, using '$' as a
@@ -1499,11 +1502,12 @@ set $BreakAllThreadsStartup = 1
<entry>exits the debugger</entry>
</row>
<row>
- <entry><command>attach N</command></entry>
- <entry>
- attach to a W-process (N is its ID, numeric
- or hexadecimal (0xN)). IDs can be obtained using
- the info process command. Note the info process
+ <entry><command>attach</command> <replaceable>N</replaceable></entry>
+ <entry>
+ attach to a W-process (<replaceable>N</replaceable> is its
+ ID, numeric or hexadecimal (<literal>0x</literal><replaceable>N</replaceable>)).
+ IDs can be obtained using the <command>info process</command>
+ command. Note the <command>info process</command>
command returns hexadecimal values.
</entry>
</row>
@@ -1623,9 +1627,10 @@ set $BreakAllThreadsStartup = 1
</para>
<para>
<command>cont</command>, <command>step</command>,
- <command>next</command>, <command>stepi</command>,
- <command>nexti</command> can be postfixed by a number (N),
- meaning that the command must be executed N times.
+ <command>next</command>, <command>stepi</command>,
+ <command>nexti</command> can be postfixed by a number
+ (<replaceable>N</replaceable>), meaning that the command must be
+ executed <replaceable>N</replaceable> times.
</para>
</sect2>
@@ -1638,56 +1643,65 @@ set $BreakAllThreadsStartup = 1
<tgroup cols="2" align="left">
<tbody>
<row>
- <entry><command>enable N</command></entry>
- <entry>enables (break|watch)point #N</entry>
+ <entry><command>enable</command> <replaceable>N</replaceable></entry>
+ <entry>enables (break|watch)point <replaceable>N</replaceable></entry>
</row>
<row>
- <entry><command>disable N</command></entry>
- <entry>disables (break|watch)point #N</entry>
+ <entry><command>disable</command> <replaceable>N</replaceable></entry>
+ <entry>disables (break|watch)point <replaceable>N</replaceable></entry>
</row>
<row>
- <entry><command>delete N</command></entry>
- <entry>deletes (break|watch)point #N</entry>
+ <entry><command>delete</command> <replaceable>N</replaceable></entry>
+ <entry>deletes (break|watch)point <replaceable>N</replaceable></entry>
</row>
<row>
- <entry><command>cond N</command></entry>
+ <entry><command>cond</command> <replaceable>N</replaceable>
+ </entry>
<entry>
- removes any existing condition to
- (break|watch)point N
+ removes any existing condition to (break|watch)point
+ <replaceable>N</replaceable>
</entry>
</row>
<row>
<entry>
- <command>cond N <expr></command>
+ <command>cond</command> <replaceable>N</replaceable>
+ <replaceable>expr</replaceable>
</entry>
<entry>
- adds condition <expr> to (break|watch)point
- N. <expr> will be evaluated each time the
- breakpoint is hit. If the result is a zero value,
- the breakpoint isn't triggered
+ adds condition <replaceable>expr</replaceable> to
+ (break|watch)point <replaceable>N</replaceable>.
+ <replaceable>expr</replaceable> will be evaluated each
+ time the breakpoint is hit. If the result is a zero value,
+ the breakpoint isn't triggered.
</entry>
</row>
<row>
- <entry><command>break * N</command></entry>
- <entry>adds a breakpoint at address N</entry>
+ <entry>
+ <command>break *</command> <replaceable>N</replaceable>
+ </entry>
+ <entry>adds a breakpoint at address <replaceable>N</replaceable></entry>
</row>
<row>
- <entry><command>break <id></command></entry>
- <entry>
- adds a breakpoint at the address of symbol
- <id>
- </entry>
+ <entry><command>break</command> <replaceable>id</replaceable></entry>
+ <entry>
+ adds a breakpoint at the address of symbol
+ <replaceable>id</replaceable>
+ </entry>
</row>
<row>
- <entry><command>break <id> N</command></entry>
+ <entry>
+ <command>break</command> <replaceable>id</replaceable>
+ <replaceable>N</replaceable>
+ </entry>
<entry>
- adds a breakpoint at line N inside symbol <id>
+ adds a breakpoint at line <replaceable>N</replaceable> inside symbol
+ <replaceable>id</replaceable>
</entry>
</row>
<row>
- <entry><command>break N</command></entry>
+ <entry><command>break</command> <replaceable>N</replaceable></entry>
<entry>
- adds a breakpoint at line N of current source file
+ adds a breakpoint at line <replaceable>N</replaceable> of current source file
</entry>
</row>
<row>
@@ -1697,17 +1711,19 @@ set $BreakAllThreadsStartup = 1
</entry>
</row>
<row>
- <entry><command>watch * N</command></entry>
+ <entry>
+ <command>watch *</command> <replaceable>N</replaceable>
+ </entry>
<entry>
- adds a watch command (on write) at address N (on 4
- bytes)
+ adds a watch command (on write) at address
+ <replaceable>N</replaceable> (on 4 bytes)
</entry>
</row>
<row>
- <entry><command>watch <id></command></entry>
+ <entry><command>watch</command> <replaceable>id</replaceable></entry>
<entry>
- adds a watch command (on write) at the address of
- symbol <id>
+ adds a watch command (on write) at the address of symbol
+ <replaceable>id</replaceable>
</entry>
</row>
<row>
@@ -1725,7 +1741,7 @@ set $BreakAllThreadsStartup = 1
the entry point of the Dll.
</para>
<para>
- When setting a break/watch-point by <id>, if the
+ When setting a break/watch-point by <replaceable>id</replaceable>, if the
symbol cannot be found (for example, the symbol is contained
in a not yet loaded module), winedbg will recall the name of
the symbol and will try to set the breakpoint each time a
@@ -1746,9 +1762,10 @@ set $BreakAllThreadsStartup = 1
<entry>print calling stack of current thread</entry>
</row>
<row>
- <entry><command>bt N</command></entry>
+ <entry><command>bt</command> <replaceable>N</replaceable></entry>
<entry>
- print calling stack of thread of ID N (note: this
+ print calling stack of thread of ID
+ <replaceable>N</replaceable> (note: this
doesn't change the position of the current frame
as manipulated by the <command>up</command> and
<command>dn</command> commands)
@@ -1761,10 +1778,11 @@ set $BreakAllThreadsStartup = 1
</entry>
</row>
<row>
- <entry><command>up N</command></entry>
- <entry>
- goes up N frames in current thread's stack
- </entry>
+ <entry><command>up</command> <replaceable>N</replaceable></entry>
+ <entry>
+ goes up <replaceable>N</replaceable> frames in current
+ thread's stack
+ </entry>
</row>
<row>
<entry><command>dn</command></entry>
@@ -1773,16 +1791,17 @@ set $BreakAllThreadsStartup = 1
</entry>
</row>
<row>
- <entry><command>dn N</command></entry>
- <entry>
- goes down N frames in current thread's stack
- </entry>
+ <entry><command>dn</command> <replaceable>N</replaceable></entry>
+ <entry>
+ goes down <replaceable>N</replaceable> frames in current
+ thread's stack
+ </entry>
</row>
<row>
- <entry><command>frame N</command></entry>
+ <entry><command>frame</command> <replaceable>N</replaceable></entry>
<entry>
- set N as the current frame for current thread's
- stack
+ set <replaceable>N</replaceable> as the current frame for
+ current thread's stack
</entry>
</row>
<row>
@@ -1814,11 +1833,9 @@ set $BreakAllThreadsStartup = 1
</entry>
</row>
<row>
+ <entry><command>dir</command> <replaceable>pathname</replaceable></entry>
<entry>
- <command>dir <pathname></command>
- </entry>
- <entry>
- adds <pathname> to the list of dirs
+ adds <replaceable>pathname</replaceable> to the list of dirs
where to look for source files
</entry>
</row>
@@ -1830,22 +1847,18 @@ set $BreakAllThreadsStartup = 1
</entry>
</row>
<row>
- <entry>
- <command>
- symbolfile <pathname>
- </command>
- </entry>
+ <entry><command>symbolfile</command> <replaceable>pathname</replaceable></entry>
<entry>loads external symbol definition</entry>
</row>
<row>
<entry>
- <command>
- symbolfile <pathname> N
- </command>
+ <command>symbolfile</command>
+ <replaceable>pathname</replaceable>
+ <replaceable>N</replaceable>
</entry>
<entry>
loads external symbol definition (applying an
- offset of N to addresses)
+ offset of <replaceable>N</replaceable> to addresses)
</entry>
</row>
<row>
@@ -1863,29 +1876,29 @@ set $BreakAllThreadsStartup = 1
</entry>
</row>
<row>
- <entry><command>list N</command></entry>
+ <entry><command>list</command> <replaceable>N</replaceable></entry>
<entry>
- lists 10 source lines from line N in current file
+ lists 10 source lines from line <replaceable>N</replaceable>
+ in current file
</entry>
</row>
<row>
<entry>
- <command>list <path>:N</command>
+ <command>list</command>
+ <replaceable>path</replaceable><command>:</command><replaceable>N</replaceable>
</entry>
<entry>
- lists 10 source lines from line N in file
- <path>
+ lists 10 source lines from line <replaceable>N</replaceable>
+ in file <replaceable>path</replaceable>
</entry>
</row>
<row>
- <entry><command>list <id></command></entry>
- <entry>
- lists 10 source lines of function <id>
- </entry>
+ <entry><command>list</command> <replaceable>id</replaceable></entry>
+ <entry>lists 10 source lines of function <replaceable>id</replaceable></entry>
</row>
<row>
- <entry><command>list * N</command></entry>
- <entry>lists 10 source lines from address N</entry>
+ <entry><command>list *</command> <replaceable>N</replaceable></entry>
+ <entry>lists 10 source lines from address <replaceable>N</replaceable></entry>
</row>
</tbody>
</tgroup>
@@ -1955,22 +1968,18 @@ set $BreakAllThreadsStartup = 1
</entry>
</row>
<row>
- <entry>
- <command>display <expr></command>
- </entry>
- <entry>
- adds a display for expression <expr>
- </entry>
+ <entry><command>display</command> <replaceable>expr</replaceable></entry>
+ <entry>adds a display for expression <replaceable>expr</replaceable></entry>
</row>
<row>
<entry>
- <command>
- display /fmt <expr>
- </command>
+ <command>display /</command><replaceable>fmt</replaceable>
+ <replaceable>expr</replaceable>
</entry>
<entry>
adds a display for expression
- <expr>. Printing evaluated <expr> is
+ <replaceable>expr</replaceable>. Printing evaluated
+ <replaceable>expr</replaceable> is
done using the given format (see
<command>print</command> command for more on
formats)
@@ -1981,15 +1990,17 @@ set $BreakAllThreadsStartup = 1
<msgtext>
<simplelist type="inline">
<member>
- <command>del display N</command>
+ <command>del display</command>
+ <replaceable>N</replaceable>
</member>
<member>
- <command>undisplay N</command>
+ <command>undisplay</command>
+ <replaceable>N</replaceable>
</member>
</simplelist>
</msgtext>
</entry>
- <entry>deletes display #N</entry>
+ <entry>deletes display <replaceable>N</replaceable></entry>
</row>
</tbody>
</tgroup>
@@ -2010,22 +2021,17 @@ set $BreakAllThreadsStartup = 1
<entry>disassemble from current position</entry>
</row>
<row>
- <entry>
- <command>disas <expr></command>
- </entry>
- <entry>
- disassemble from address <expr>
- </entry>
+ <entry><command>disas</command> <replaceable>expr</replaceable></entry>
+ <entry>disassemble from address <replaceable>expr</replaceable></entry>
</row>
<row>
<entry>
- <command>
- disas <expr>,<expr>
- </command>
+ <command>disas</command> <replaceable>expr</replaceable>,
+ <replaceable>expr</replaceable>
</entry>
<entry>
disassembles code between addresses specified by
- the two <expr>
+ the two <replaceable>expr</replaceable>s
</entry>
</row>
</tbody>
@@ -2043,64 +2049,49 @@ set $BreakAllThreadsStartup = 1
<tgroup cols="2" align="left">
<tbody>
<row>
- <entry>
- <command>x <expr></command>
- </entry>
- <entry>
- examines memory at <expr> address
- </entry>
+ <entry><command>x</command> <replaceable>expr</replaceable></entry>
+ <entry>examines memory at <replaceable>expr</replaceable> address</entry>
</row>
<row>
+ <entry>
+ <command>x /</command><replaceable>fmt</replaceable>
+ <replaceable>expr</replaceable>
+ </entry>
<entry>
- <command>
- x /fmt <expr>
- </command>
- </entry>
- <entry>
- examines memory at <expr> address using
- format /fmt
+ examines memory at <replaceable>expr</replaceable> address
+ using format <replaceable>fmt</replaceable>
</entry>
</row>
<row>
+ <entry><command>print</command> <replaceable>expr</replaceable></entry>
<entry>
- <command>
- print <expr>
- </command>
- </entry>
- <entry>
- prints the value of <expr> (possibly using
- its type)
+ prints the value of <replaceable>expr</replaceable> (possibly
+ using its type)
</entry>
</row>
<row>
<entry>
- <command>
- print /fmt <expr>
- </command>
+ <command>print /</command><replaceable>fmt</replaceable>
+ <replaceable>expr</replaceable>
</entry>
- <entry>prints the value of <expr> (possibly
- using its type)
+ <entry>
+ prints the value of <replaceable>expr</replaceable>
+ using format <replaceable>fmt</replaceable>
</entry>
</row>
<row>
<entry>
- <command>
- set <lval> = <expr>
- </command>
+ <command>set</command>
+ <replaceable>lval</replaceable><command>=</command><replaceable>expr</replaceable>
</entry>
<entry>
- writes the value of <expr> in <lval>
+ writes the value of <replaceable>expr</replaceable> in
+ <replaceable>lval</replaceable>
</entry>
</row>
<row>
- <entry>
- <command>
- whatis <expr>
- </command>
- </entry>
- <entry>
- prints the C type of expression <expr>
- </entry>
+ <entry><command>whatis</command> <replaceable>expr</replaceable></entry>
+ <entry>prints the C type of expression <replaceable>expr</replaceable></entry>
</row>
<row>
<entry>
@@ -2128,8 +2119,10 @@ set $BreakAllThreadsStartup = 1
</table>
</para>
<para>
- <filename>/fmt</filename> is either <filename>/<letter></filename> or
- <filename>/<count><letter></filename> letter can be
+ <replaceable>fmt</replaceable> is either <replaceable>letter</replaceable> or
+ <replaceable>count</replaceable> <replaceable>letter</replaceable> (without a space
+ between <replaceable>count</replaceable> and <replaceable>letter</replaceable>), where
+ <replaceable>letter</replaceable> can be
<simplelist type="horiz" columns="2">
<member>s</member><member>an ASCII string</member>
<member>u</member><member>an Unicode UTF16 string</member>
@@ -2159,14 +2152,8 @@ set $BreakAllThreadsStartup = 1
</entry>
</row>
<row>
- <entry>
- <command>
- info class <id>
- </command>
- </entry>
- <entry>
- prints information on Windows class <id>
- </entry>
+ <entry><command>info class</command> <replaceable>id</replaceable></entry>
+ <entry>prints information on Windows class <replaceable>id</replaceable></entry>
</row>
<row>
<entry><command>info share</command></entry>
@@ -2177,14 +2164,11 @@ set $BreakAllThreadsStartup = 1
</entry>
</row>
<row>
- <entry>
- <command>
- info share <N>
- </command>
- </entry>
- <entry>
- prints information on module at address <N>
- </entry>
+ <entry><command>info share</command> <replaceable>N</replaceable></entry>
+ <entry>
+ prints information on module at address
+ <replaceable>N</replaceable>
+ </entry>
</row>
<row>
<entry><command>info regs</command></entry>
@@ -2199,13 +2183,11 @@ set $BreakAllThreadsStartup = 1
</entry>
</row>
<row>
- <entry>
- <command>info segment <N></command>
- </entry>
- <entry>
- prints information on segment <N> (i386
- only)
- </entry>
+ <entry><command>info segment</command> <replaceable>N</replaceable></entry>
+ <entry>
+ prints information on segment <replaceable>N</replaceable>
+ (i386 only)
+ </entry>
</row>
<row>
<entry>
@@ -2229,21 +2211,15 @@ set $BreakAllThreadsStartup = 1
</entry>
</row>
<row>
- <entry>
- <command>info map <N></command>
- </entry>
+ <entry><command>info map</command> <replaceable>N</replaceable></entry>
<entry>
lists all virtual mappings used by the program of
- pid <N>
+ pid <replaceable>N</replaceable>
</entry>
</row>
<row>
- <entry>
- <command>info wnd <N></command>
- </entry>
- <entry>
- prints information of Window of handle <N>
- </entry>
+ <entry><command>info wnd</command> <replaceable>N</replaceable></entry>
+ <entry>prints information of Window of handle <replaceable>N</replaceable></entry>
</row>
<row>
<entry><command>info wnd</command></entry>
@@ -2291,26 +2267,25 @@ set $BreakAllThreadsStartup = 1
<tgroup cols="2" align="left">
<tbody>
<row>
- <entry>
- <command>set + warn win</command>
- </entry>
- <entry>turn on warn on 'win' channel</entry>
+ <entry>
+ <command>set + warn</command>
+ <replaceable>channel</replaceable>
+ </entry>
+ <entry>turn on warn on <replaceable>channel</replaceable></entry>
</row>
<row>
- <entry>
- <command>set + win</command>
- </entry>
- <entry>
- turn on warn/fixme/err/trace on 'win' channel
- </entry>
+ <entry><command>set +</command> <replaceable>channel</replaceable></entry>
+ <entry>turn on warn/fixme/err/trace on <replaceable>channel</replaceable></entry>
</row>
<row>
- <entry>
- <command>set - win</command>
- </entry>
- <entry>
- turn off warn/fixme/err/trace on 'win' channel
- </entry>
+ <entry>
+ <command>set -</command>
+ <replaceable>channel</replaceable>
+ </entry>
+ <entry>
+ turn off warn/fixme/err/trace on
+ <replaceable>channel</replaceable>
+ </entry>
</row>
<row>
<entry>
@@ -2408,7 +2383,7 @@ set $BreakAllThreadsStartup = 1
<para>
Start the Wine debugger with a command line like:
<screen>
- winedbg --gdb --no-start <name_of_exe_to_debug.exe>
+ winedbg --gdb --no-start <replaceable>name_of_exe_to_debug.exe</replaceable> <optional><replaceable>optional parameters</replaceable></optional>
</screen>
</para>
</listitem>
@@ -2434,9 +2409,7 @@ set $BreakAllThreadsStartup = 1
</para>
</listitem>
</orderedlist>
- The program should now be loaded and up and running. If
- you want, you can also add in 1/ after the name of the
- exec all the needed parameters
+ The program should now be loaded and up and running.
</para>
</sect3>
<sect3>
@@ -2449,7 +2422,7 @@ set $BreakAllThreadsStartup = 1
<para>
Start the Wine debugger with a command line like:
<screen>
- winedbg --gdb --no-start <name_of_exe_to_debug.exe>
+ winedbg --gdb --no-start <replaceable>name_of_exe_to_debug.exe</replaceable> <optional><replaceable>optional parameters</replaceable></optional>
</screen>
</para>
</listitem>
@@ -2469,9 +2442,7 @@ kdbg -r localhost:32878 wine
</para>
</listitem>
</orderedlist>
- The program should now be loaded and up and running. If
- you want, you can also add in 1/ after the name of the
- exec all the needed parameters
+ The program should now be loaded and up and running.
</para>
</sect3>
</sect2>
@@ -2541,10 +2512,10 @@ $ gdb wine
<command>gdb</command>, repeat for all Wine processes:
</para>
<screen>
-(gdb) attach <userinput>PID</userinput>
+(gdb) attach <replaceable>PID</replaceable>
</screen>
<para>
- with <userinput>PID</userinput> being the process ID of one of
+ with <replaceable>PID</replaceable> being the process ID of one of
the Wine processes. Use
</para>
<screen>
@@ -2563,7 +2534,7 @@ $ gdb wine
or maybe even
</para>
<screen>
-(gdb) b <userinput>SomeFunction</userinput>
+(gdb) b <replaceable>SomeFunction</replaceable>
</screen>
<para>
and
diff --git a/en/winedev-debugging.sgml b/en/winedev-debugging.sgml
index 01b270e..eabec07 100644
--- a/en/winedev-debugging.sgml
+++ b/en/winedev-debugging.sgml
@@ -279,22 +279,22 @@ HANDLE32 WINAPI YourFunc(LPCSTR s)
The <parameter>WINEDEBUG</parameter> environment variable
controls the output of the debug messages.
It has the following syntax:
- <parameter>WINEDEBUG= [yyy]#xxx[,[yyy1]#xxx1]*</parameter>
+ <parameter>WINEDEBUG=
+ <optional><replaceable>yyy</replaceable></optional><replaceable>#</replaceable><replaceable>xxx</replaceable><optional>,<optional><replaceable>yyy1</replaceable></optional><replaceable>#</replaceable><replaceable>xxx1</replaceable></optional>*</parameter>
</para>
<itemizedlist>
<listitem>
<para>
- where
- <literal>#</literal> is either <literal>+</literal> or
+ where <replaceable>#</replaceable> is either <literal>+</literal> or
<literal>-</literal>
</para>
</listitem>
<listitem>
<para>
- when the optional class argument (<literal>yyy</literal>)
+ when the optional class argument (<replaceable>yyy</replaceable>)
is not present, then the statement will
enable(<literal>+</literal>)/disable(<literal>-</literal>)
- all messages for the given channel (<literal>xxx</literal>)
+ all messages for the given channel (<replaceable>xxx</replaceable>)
on all classes. For example:
</para>
<programlisting>
@@ -331,10 +331,8 @@ WINEDEBUG=trace+reg,warn-file
<screen>
WINEDEBUG=+all -- enables all debug messages
WINEDEBUG=-all -- disables all debug messages
- WINEDEBUG=yyy+all -- enables debug messages for class yyy on all
- channels.
- WINEDEBUG=yyy-all -- disables debug messages for class yyy on all
- channels.
+ WINEDEBUG=<replaceable>yyy</replaceable>+all -- enables debug messages for class <replaceable>yyy</replaceable> on all channels.
+ WINEDEBUG=<replaceable>yyy</replaceable>-all -- disables debug messages for class <replaceable>yyy</replaceable> on all channels.
</screen>
<para>
So, for example:
@@ -374,16 +372,16 @@ WINEDEBUG=trace+reg,warn-file
output format is the following:
</para>
<screen>
-yyy:xxx:fff <message>
+<replaceable>yyy</replaceable>:<replaceable>xxx</replaceable>:<replaceable>fff</replaceable> <replaceable>message</replaceable>
where:
- yyy = the class (fixme, err, warn, trace)
- xxx = the channel (atom, win, font, etc)
- fff = the function name
+ <replaceable>yyy</replaceable> = the class (<literal>fixme</literal>, <literal>err</literal>, <literal>warn</literal>, <literal>trace</literal>)
+ <replaceable>xxx</replaceable> = the channel (<literal>atom</literal>, <literal>win</literal>, <literal>font</literal>, <literal>etc</literal>)
+ <replaceable>fff</replaceable> = the function name
</screen>
<para>
- these fields are output automatically. All you have to
- provide is the <message> part.
+ These fields are output automatically. All you have to
+ provide is the <replaceable>message</replaceable> part.
</para>
<para>
So here are some ideas:
@@ -401,7 +399,7 @@ where:
it as the first thing and include them in parentheses,
like this:
<programlisting>
-TRACE("(%d, %p, ...)\n", par1, par2, ...);
+TRACE("(%d, %p, ...)\n", <replaceable>par1</replaceable>, <parameter>par2</parameter>, ...);
</programlisting>
</para>
</listitem>
@@ -409,7 +407,7 @@ TRACE("(%d, %p, ...)\n", par1, par2, ...);
<para>
if you want to name a parameter, use <literal>=</literal> :
<programlisting>
-TRACE("(fd=%d, file=%s): stub\n", fd, name);
+TRACE("(fd=%d, file=%s): stub\n", <replaceable>fd</replaceable>, <replaceable>name</replaceable>);
</programlisting>
</para>
</listitem>
@@ -418,7 +416,7 @@ TRACE("(fd=%d, file=%s): stub\n", fd, name);
for stubs, you should output a <literal>FIXME</literal>
message. I suggest this style:
<programlisting>
-FIXME("(%x, %d, ...): stub\n", par1, par2, ...);
+FIXME("(%x, %d, ...): stub\n", <replaceable>par1</replaceable>, <replaceable>par2</replaceable>, ...);
</programlisting>
</para>
</listitem>
diff --git a/en/winedev-documentation.sgml b/en/winedev-documentation.sgml
index 1fc4a98..f88ecee 100644
--- a/en/winedev-documentation.sgml
+++ b/en/winedev-documentation.sgml
@@ -559,7 +559,7 @@
<command>make install</command> will install them for you. By default they are
installed in section 3w of the manual, so they don't conflict with any existing
man page names. So, to read the man page you should use
- <command>man -S 3w {name}</command>. Alternately you can edit
+ <command>man -S 3w <replaceable>name</replaceable></command>. Alternately you can edit
<filename>/etc/man.config</filename> and add 3w to the list of search paths
given in the variable <emphasis>MANSECT</emphasis>.
</para>
@@ -1135,7 +1135,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><sgmltag class="starttag">sect?</sgmltag></term>
+ <term><sgmltag class="starttag">sect<replaceable>N</replaceable></sgmltag></term>
<listitem>
<para>
DocBook has many section elements to divide the
diff --git a/en/winedev-kernel.sgml b/en/winedev-kernel.sgml
index d01c36b..864a225 100644
--- a/en/winedev-kernel.sgml
+++ b/en/winedev-kernel.sgml
@@ -29,8 +29,9 @@
exist on the periphery such as MSI, the widget library (in
<filename>USER</filename> and <filename>COMCTL32</filename>) etc. The
purpose of this section is to document and explain how Wine starts up
- from the moment the user runs "<command>wine myprogram.exe</command>" to
- the point at which <filename>myprogram</filename> gets control.
+ from the moment the user runs <command>wine
+ <replaceable>myprogram.exe</replaceable></command> to the point at which
+ <replaceable>myprogram</replaceable> gets control.
</para>
<sect2>
@@ -988,10 +989,10 @@ if (res != ERROR_SUCCESS) return res;
<listitem>
<para>
Network shares are also accessible through a symbol link.
- However in this case, a symbol link is created from
- <filename>\Global??\UNC\host\share\</filename> for the share
- <filename>share</filename> on the machine
- <filename>host</filename>) to what's called a network
+ However in this case, a symbol link is created from
+ <filename>\Global??\UNC\<replaceable>host</replaceable>\<replaceable>share</replaceable>\</filename>
+ for the share <replaceable>share</replaceable> on the machine
+ <replaceable>host</replaceable>) to what's called a network
redirector, and which will take care of 1/ the connection to
the remote share, 2/ handling with that remote share the rest
of the path (after the name of the server, and the name of the
@@ -1108,19 +1109,20 @@ if (res != ERROR_SUCCESS) return res;
</listitem>
<listitem>
<para>
- <filename>\\host\share</filename> is <firstterm>UNC</firstterm>
- (Universal Naming Convention) path, i.e. represents a file on a
- remote share.
+ <filename>\\<replaceable>host</replaceable>\<replaceable>share</replaceable></filename>
+ is <firstterm>UNC</firstterm> (Universal Naming Convention) path, i.e. represents
+ a file on a remote share.
</para>
</listitem>
<listitem>
<para>
- <filename>\\.\device</filename> denotes a physical device
- installed in the system (as seen from the Win32 subsystem). A
+ <filename>\\.\<replaceable>device</replaceable></filename> denotes a physical
+ device installed in the system (as seen from the Win32 subsystem). A
standard NT system will map it to the
- <filename>\??\device</filename> NT path. Then, as a standard
- configuration, <filename>\??\device</filename> is likely to be
- a link to in a physical device described and hooked into the
+ <filename>\??\<replaceable>device</replaceable></filename> NT path. Then, as a
+ standard configuration,
+ <filename>\??\<replaceable>device</replaceable></filename> is likely to be a
+ link to in a physical device described and hooked into the
<filename>\Device\</filename> tree. For example,
<filename>COM1</filename> is a link to
<filename>\Device\Serial0</filename>.
@@ -1174,12 +1176,13 @@ if (res != ERROR_SUCCESS) return res;
<entry><filename>gee\bar.txt</filename></entry>
<entry>
<filename>
- \Global??\J:\mydir\mysubdir\gee\bar.txt
+ \Global??\J:\<replaceable>mydir</replaceable>\<replaceable>mysubdir</replaceable>\gee\bar.txt
</filename>
</entry>
<entry>
Simple concatenation using the default directory
- (here <filename class="directory">J:\mydir\mysubdir</filename>)
+ (here <filename
+ class="directory">J:\<replaceable>mydir</replaceable>\<replaceable>mysubdir</replaceable></filename>)
</entry>
</row>
<row>
@@ -1240,9 +1243,9 @@ if (res != ERROR_SUCCESS) return res;
</row>
<row>
<entry>UNC (Uniform Naming Convention) path</entry>
- <entry><filename>\\host\share\foo\bar.txt</filename></entry>
+ <entry><filename>\\<replaceable>host</replaceable>\<replaceable>share</replaceable>\foo\bar.txt</filename></entry>
<entry>
- <filename>\Global??\UNC\host\share\foo\bar.txt</filename>
+ <filename>\Global??\UNC\<replaceable>host</replaceable>\<replaceable>share</replaceable>\foo\bar.txt</filename>
</entry>
<entry>
Simple concatenation.
@@ -1250,8 +1253,8 @@ if (res != ERROR_SUCCESS) return res;
</row>
<row>
<entry>Device path</entry>
- <entry><filename>\\.\device</filename></entry>
- <entry><filename>\Global??\device</filename></entry>
+ <entry><filename>\\.\<replaceable>device</replaceable></filename></entry>
+ <entry><filename>\Global??\<replaceable>device</replaceable></filename></entry>
<entry>Simple concatenation</entry>
</row>
<row>
@@ -1332,13 +1335,13 @@ if (res != ERROR_SUCCESS) return res;
</itemizedlist>
</para>
<para>
- This scheme is also used to implement UNC path names. For example,
- Wine maps <filename>\\host\share\foo\bar\MyRemoteFile.txt</filename>
- into
- <filename>$(WINEPREFIX)/dosdevices/unc/host/share/foo/bar/MyRemoteFile.txt</filename>.
- It's then up to the user to decide where
- <filename>$(WINEPREFIX)/dosdevices/unc/host/share</filename> shall
- point to (or be). For example, it can either be a symbolic link to a
+ This scheme is also used to implement UNC path names. For example, Wine maps
+<filename>\\<replaceable>host</replaceable>\<replaceable>share</replaceable>\foo\bar\MyRemoteFile.txt</filename>
+ into
+ <filename>$(WINEPREFIX)/dosdevices/unc/<replaceable>host</replaceable>/<replaceable>share</replaceable>/foo/bar/MyRemoteFile.txt</filename>.
+ It's then up to the user to decide where
+<filename>$(WINEPREFIX)/dosdevices/unc/<replaceable>host</replaceable>/<replaceable>share</replaceable></filename>
+ shall point to (or be). For example, it can either be a symbolic link to a
directory inside the local machine (just for emulation purpose), or
a symbolic link to the mount point of a remote disk (done through
Samba or NFS), or even the real mount point. Wine will not do any
@@ -1725,13 +1728,13 @@ if (res != ERROR_SUCCESS) return res;
<para>
Firstly, Wine implements the Win32 to NT mapping as described above,
hence every device path (in NT sense) is of the following form:
- <filename>/??/devicename</filename> (or
- <filename>/DosDevices/devicename</filename>). As Windows device
- names are case insensitive, Wine also converts them to lower case
+ <filename>/??/<replaceable>devicename</replaceable></filename> (or
+ <filename>/DosDevices/<replaceable>devicename</replaceable></filename>). As Windows
+ device names are case insensitive, Wine also converts them to lower case
before any operation. Then, the first operation Wine tries is to
check whether
- <filename>$(WINEPREFIX)/dosdevices/devicename</filename> exists. If
- so, it's used as the final Unix path for the device. The
+ <filename>$(WINEPREFIX)/dosdevices/<replaceable>devicename</replaceable></filename>
+ exists. If so, it's used as the final Unix path for the device. The
configuration process is in charge of creating for example, a
symbolic link between
<filename>$(WINEPREFIX)/dosdevices/PhysicalDrive0</filename> and
@@ -1782,39 +1785,39 @@ if (res != ERROR_SUCCESS) return res;
</thead>
<tbody>
<row>
- <entry><filename><any_path>AUX</filename></entry>
+ <entry><filename><replaceable>any_path</replaceable>AUX</filename></entry>
<entry><filename>\Global??\AUX</filename></entry>
<entry>
Treated as an alias to <filename>COM1</filename>
</entry>
</row>
<row>
- <entry><filename><any_path>PRN</filename></entry>
+ <entry><filename><replaceable>any_path</replaceable>PRN</filename></entry>
<entry><filename>\Global??\PRN</filename></entry>
<entry>Treated as an alias to <filename>LPT1</filename></entry>
</row>
<row>
- <entry><filename><any_path>COM<N></filename></entry>
- <entry><filename>\Global??\COM<N></filename></entry>
+ <entry><filename><replaceable>any_path</replaceable>COM<replaceable>N</replaceable></filename></entry>
+ <entry><filename>\Global??\COM<replaceable>N</replaceable></filename></entry>
<entry>
- <filename>$(WINEPREFIX)/dosdevices/com<N></filename>
- (if the symbol link exists) or the Nth serial
+ <filename>$(WINEPREFIX)/dosdevices/com<replaceable>N</replaceable></filename>
+ (if the symbol link exists) or the <replaceable>N</replaceable>th serial
line in the system (on Linux,
- <filename>/dev/ttyS<N-1></filename>).
+ <filename>/dev/ttyS<replaceable>N-1</replaceable></filename>).
</entry>
</row>
<row>
- <entry><filename><any_path>LPT<N></filename></entry>
- <entry><filename>\Global??\LPT<N></filename></entry>
+ <entry><filename><replaceable>any_path</replaceable>LPT<replaceable>N</replaceable></filename></entry>
+ <entry><filename>\Global??\LPT<replaceable>N</replaceable></filename></entry>
<entry>
- <filename>$(WINEPREFIX)/dosdevices/lpt<N></filename>
- (if the symbol link exists) or the Nth printer
+ <filename>$(WINEPREFIX)/dosdevices/lpt<replaceable>N</replaceable></filename>
+ (if the symbol link exists) or the <replaceable>N</replaceable>th printer
in the system (on Linux,
- <filename>/dev/lp<N-1></filename>).
+ <filename>/dev/lp<replaceable>N-1</replaceable></filename>).
</entry>
</row>
<row>
- <entry><filename><any_path>NUL</filename></entry>
+ <entry><filename><replaceable>any_path</replaceable>NUL</filename></entry>
<entry><filename>\Global??\NUL</filename></entry>
<entry><filename>/dev/null</filename></entry>
</row>
@@ -1829,12 +1832,12 @@ if (res != ERROR_SUCCESS) return res;
</entry>
</row>
<row>
- <entry><filename>\\.\<device_name></filename></entry>
+ <entry><filename>\\.\<replaceable>device_name</replaceable></filename></entry>
<entry>
- <filename>\Global??\<device_name></filename>
+ <filename>\Global??\<replaceable>device_name</replaceable></filename>
</entry>
<entry>
- <filename>$(WINEPREFIX)/dosdevices/<device_name></filename>
+ <filename>$(WINEPREFIX)/dosdevices/<replaceable>device_name</replaceable></filename>
(if the symbol link exists).
</entry>
</row>
diff --git a/en/winedev-multimedia.sgml b/en/winedev-multimedia.sgml
index f8c0fc8..ba7635b 100644
--- a/en/winedev-multimedia.sgml
+++ b/en/winedev-multimedia.sgml
@@ -568,7 +568,7 @@ Kernel space | Client applications
The MSACM/MSACM32 keeps some data cached for all known ACM
drivers. Under the key
<screen>
- Software\Microsoft\AudioCompressionManager\DriverCache\<driver name>
+ Software\Microsoft\AudioCompressionManager\DriverCache\<replaceable>driver_name</replaceable>
</screen>
, are kept for values:
<itemizedlist>
@@ -890,14 +890,14 @@ HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Multimedia\MIDIMap
<literal>CurrentInstrument</literal> value. Note: Wine
(for simplicity while installing) allows to define
<literal>CurrentInstrument</literal> as
- <literal>#n</literal> (where n is a number), whereas
- Windows only allows the real device name here. If
+ <literal>#<replaceable>n</replaceable></literal> (where <replaceable>n</replaceable> is
+ a number), whereas Windows only allows the real device name here. If
<literal>UseScheme</literal> is set to a non null value,
<literal>CurrentScheme</literal> defines the name of the
scheme to map the different channels. All the schemes are
available with keys like
<screen>
-HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\MediaProperties\PrivateProperties\Midi\Schemes\%name_of_scheme%
+HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\MediaProperties\PrivateProperties\Midi\Schemes\<replaceable>scheme_name</replaceable>
</screen>
For every scheme, under this key, will be a sub-key (which
name is usually a two digit index, starting at 00). Its
@@ -911,7 +911,7 @@ HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\MediaProperties\PrivatePrope
To provide enhanced configuration and mapping
capabilities, each driver can define under the key
<screen>
-HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\MediaProperties\PrivateProperties\Midi\Ports\%driver_name%
+HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\MediaProperties\PrivateProperties\Midi\Ports\<replaceable>driver_name</replaceable>
</screen>
a link to and <filename>.IDF</filename> file which allows
to remap channels internally (for example 9 -> 16), to
diff --git a/en/winedev-ole.sgml b/en/winedev-ole.sgml
index c81372b..ed0097b 100644
--- a/en/winedev-ole.sgml
+++ b/en/winedev-ole.sgml
@@ -115,7 +115,7 @@ ICOM_DEFINE(IDirect3D,IUnknown)
necessary for the interface. We have to explicitly use the
interface name for macro expansion reasons again. Inherited
methods are inherited in C by using the IDirect3D_METHODS
- macro and the parent's Xxx_IMETHODS macro. In C++ we need
+ macro and the parent's <replaceable>Xxx</replaceable>_IMETHODS macro. In C++ we need
only use the IDirect3D_METHODS since method inheritance is
taken care of by the language.
</para>
@@ -129,7 +129,7 @@ ICOM_DEFINE(IDirect3D,IUnknown)
parameters. The 'undef ICOM_INTERFACE' is here to remind
you that using ICOM_INTERFACE in the following macros will
not work. This time it's because the ICOM_CALL macro
- expansion is done only once the 'IDirect3D_Xxx' macro is
+ expansion is done only once the 'IDirect3D_<replaceable>Xxx</replaceable>' macro is
expanded. And by that time ICOM_INTERFACE will be long gone
anyway.
</para>
@@ -141,7 +141,7 @@ ICOM_DEFINE(IDirect3D,IUnknown)
(I could only find doc about IDirect3D2), I left them blank.
</para>
<para>
- Finally the set of 'IDirect3D_Xxx' macros is a standard set
+ Finally the set of 'IDirect3D_<replaceable>Xxx</replaceable>' macros is a standard set
of macros defined to ease access to the interface methods in
C. Unfortunately I don't see any way to avoid having to
duplicate the inherited method definitions there. This time
@@ -208,7 +208,7 @@ struct IDirect3DVtbl {
<para>
The code generated by ICOM_DEFINE defines both the structure
representing the interface and the structure for the jump
- table. ICOM_DEFINE uses the parent's Xxx_IMETHODS macro to
+ table. ICOM_DEFINE uses the parent's <replaceable>Xxx</replaceable>_IMETHODS macro to
automatically repeat the prototypes of all the inherited
methods and then uses IDirect3D_METHODS to define the
IDirect3D methods.
@@ -220,7 +220,7 @@ struct IDirect3DVtbl {
and initialize the lpVtbl field to point to this variable.
</para>
<para>
- The IDirect3D_Xxx macros then just dereference the lpVtbl
+ The IDirect3D_<replaceable>Xxx</replaceable> macros then just dereference the lpVtbl
pointer and use the function pointer corresponding to the
macro name. This emulates the behavior of a virtual table
and should be just as fast.
@@ -297,7 +297,7 @@ struct IDirect3DVtbl {
numbers of parameters.
</para>
<para>
- Finally there is no IDirect3D_Xxx macro. These are not
+ Finally there is no IDirect3D_<replaceable>Xxx</replaceable> macro. These are not
needed in C++ unless the CINTERFACE macro is defined in
which case we would not be here.
</para>
@@ -643,7 +643,7 @@ static ICOM_VTABLE(IDirect3D) d3dvt = {
<listitem> <para> COM looks in
- HKEY_CLASSES_ROOT/Interface/{whatever-iid}/ProxyStubClsId32
+ HKEY_CLASSES_ROOT/Interface/<replaceable>whatever-iid</replaceable>/ProxyStubClsId32
to retrieve the CLSID of another COM object, which
implements IPSFactoryBuffer. </para> </listitem>
diff --git a/en/winedev-otherdebug.sgml b/en/winedev-otherdebug.sgml
index d34465b..b1421ed 100644
--- a/en/winedev-otherdebug.sgml
+++ b/en/winedev-otherdebug.sgml
@@ -76,21 +76,23 @@
<para>
Another method that has been much more successful is to attempt to
figure out how many arguments each function is removing from the
- stack. This instruction, <literal>ret hhll</literal> (where
- <symbol>hhll</symbol> is the number of bytes to remove, i.e. the
- number of arguments times 4), contains the bytes
- <literal>0xc2 ll hh</literal> in memory. It is a reasonable
+ stack. This instruction, <userinput>ret <replaceable>hhll</replaceable></userinput> (where
+ <replaceable>hhll</replaceable> is the number of bytes to remove, i.e. the
+ number of arguments times 4), contains the bytes
+ <literal>0xc2 <replaceable>ll</replaceable> <replaceable>hh</replaceable></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
+ therefore, simply searching for <replaceable>hh</replaceable> == 0 and
+ <replaceable>ll</replaceable> < 0x40 starting from the
address of a function yields the correct number of arguments most
of the time.
</para>
<para>
- Of course, this is not without errors. <literal>ret 00ll</literal>
- is not the only instruction that can have the byte sequence
- <literal>0xc2 ll 0x0</literal>; for example,
+ Of course, this is not without errors.
+ <literal>ret 00<replaceable>ll</replaceable></literal> is not the only instruction that can
+ can have the byte sequence <literal>0xc2 <replaceable>ll</replaceable> 0x0</literal>; for
+ example,
<literal>push 0x000040c2</literal> has the byte sequence
<literal>0x68 0xc2 0x40 0x0 0x0</literal>, which matches
the above. Properly, the utility should look for this sequence
@@ -105,19 +107,19 @@
Much more troublesome is the non-linear flow of a function. For
example, consider the following two functions:
<screen>
- somefunction1:
- jmp somefunction1_impl
+ <replaceable>somefunction1</replaceable>:
+ jmp <replaceable>somefunction1_impl</replaceable>
- somefunction2:
+ <replaceable>somefunction2</replaceable>:
ret 0004
- somefunction1_impl:
+ <replaceable>somefunction1_impl</replaceable>:
ret 0008
</screen>
In this case, we would incorrectly detect both
- <function>somefunction1</function> and
- <function>somefunction2</function> as taking only a single
- argument, whereas <function>somefunction1</function> really
+ <function><replaceable>somefunction1</replaceable></function> and
+ <function><replaceable>somefunction2</replaceable></function> as taking only a single
+ argument, whereas <function><replaceable>somefunction1</replaceable></function> really
takes two arguments.
</para>
diff --git a/en/winedev-testing.sgml b/en/winedev-testing.sgml
index f1446bc..bce30e6 100644
--- a/en/winedev-testing.sgml
+++ b/en/winedev-testing.sgml
@@ -379,7 +379,7 @@ Kit</ulink>.
<listitem><para>
Finally, in a command prompt window, compile the test with the command
<screen>
-<prompt>C:\your\work\dir></prompt>cl -I. -DSTANDALONE -D_X86_ mytest.c
+<prompt>C:\<replaceable>your\work\dir</replaceable>> </prompt><userinput>cl -I. -DSTANDALONE -D_X86_ mytest.c</userinput>
</screen>
</para></listitem>
<listitem><para>
--
1.8.3.4
More information about the wine-patches
mailing list