[docs] winedev: Avoid empty end tags
Frédéric Delanoy
frederic.delanoy at gmail.com
Wed Jul 17 17:48:31 CDT 2013
---
en/winedev-debugger.sgml | 28 ++++-----
en/winedev-documentation.sgml | 4 +-
en/winedev-kernel.sgml | 2 +-
en/winedev-testing.sgml | 135 +++++++++++++++++++++---------------------
4 files changed, 85 insertions(+), 84 deletions(-)
diff --git a/en/winedev-debugger.sgml b/en/winedev-debugger.sgml
index 012d6f1..3cd2fda 100644
--- a/en/winedev-debugger.sgml
+++ b/en/winedev-debugger.sgml
@@ -649,32 +649,32 @@ process tid prio (all id:s are in hex)
<para>
The best, freely available, disassembler for Win16 programs is
<application>Windows Codeback</application>, archive name
- <filename>wcbxxx.zip</> (e.g. <filename>wcb105a.zip</>).
+ <filename>wcbxxx.zip</filename> (e.g. <filename>wcb105a.zip</filename>).
</para>
<para>
Disassembling win32 programs is possible using
- e.g. <application>GoVest</> by Ansgar Trimborn. It can be found
- <ulink url="http://www.oocities.com/govest/">here</>.
+ e.g. <application>GoVest</application> by Ansgar Trimborn. It can be found
+ <ulink url="http://www.oocities.com/govest/">here</ulink>.
</para>
<para>
You can also use the newer and better
- <application>Interactive Disassembler</> (IDA) from DataRescue.
+ <application>Interactive Disassembler</application> (IDA) from DataRescue.
Take a look in the
- <ulink url="http://appdb.winehq.org/appview.php?appId=565">AppDB</>
+ <ulink url="http://appdb.winehq.org/appview.php?appId=565">AppDB</ulink>
for links to various versions of IDA.
</para>
<para>
Another popular disassembler is
- <application>Windows Disassembler 32</> from URSoft.
- Look for a file called <filename>w32dsm87.zip</> (or similar) on
- <ulink url="http://www.winsite.com/">winsite.com</> or
- <ulink url="http://www.softpedia.com/">softpedia.com</>.
+ <application>Windows Disassembler 32</application> from URSoft.
+ Look for a file called <filename>w32dsm87.zip</filename> (or similar) on
+ <ulink url="http://www.winsite.com/">winsite.com</ulink> or
+ <ulink url="http://www.softpedia.com/">softpedia.com</ulink>.
It seems that Windows Disassembler 32 currently has problems
working correctly under Wine, so use IDA or GoVest.
</para>
<para>
Also of considerable fame amongst disassemblers is
- <application>SoftIce</> from NuMega. That software has since been
+ <application>SoftIce</application> from NuMega. That software has since been
acquired by CompuWare (http://www.compuware.com/) and made part of
their Windows driver development suite. Newer versions of SoftIce
needs to run as a Windows Service and therefore won't currently
@@ -682,7 +682,7 @@ process tid prio (all id:s are in hex)
</para>
<para>
If nothing works for you, you might try one of the disassemblers found in
- <ulink url="http://directory.google.com/Top/Computers/Programming/Disassemblers/DOS_and_Windows/">Google's directory</>.
+ <ulink url="http://directory.google.com/Top/Computers/Programming/Disassemblers/DOS_and_Windows/">Google directory</ulink>.
</para>
<para>
Understanding disassembled code is mostly a question of exercise.
@@ -1009,7 +1009,7 @@ winedbg myprog.exe
<term>
<application>GoVest</application>:
<filename>govest.zip</filename> is available from
- <ulink url="http://www.oocities.com/govest/">http://www.oocities.com/govest/</>.
+ <ulink url="http://www.oocities.com/govest/"></ulink>.
</term>
<listitem>
<para>
@@ -1028,7 +1028,7 @@ winedbg myprog.exe
</para>
<para>
Take a look in the
- <ulink url="http://appdb.winehq.org/appview.php?appId=565">AppDB</>
+ <ulink url="http://appdb.winehq.org/appview.php?appId=565">AppDB</ulink>
for links to various versions of IDA.
</para>
</listitem>
@@ -1366,7 +1366,7 @@ set $BreakAllThreadsStartup = 1
<sect2 id="cfg-dbg-relay">
<title>Configuring +relay behaviour</title>
<para>
- When setting <parameter>WINEDEBUG</> to +relay and debugging,
+ When setting <parameter>WINEDEBUG</parameter> to +relay and debugging,
you might get a lot of output. You can limit the output by
configuring the value RelayExclude in the registry, located
under the key:
diff --git a/en/winedev-documentation.sgml b/en/winedev-documentation.sgml
index 09e9cba..3e50a67 100644
--- a/en/winedev-documentation.sgml
+++ b/en/winedev-documentation.sgml
@@ -74,8 +74,8 @@
</para>
<para>
- To obtain a copy of the Wine documentation refer to
- <ulink url="http://source.winehq.org/git/docs.git/">the Documentation Git tree</>.
+ To obtain a copy of the Wine documentation refer to
+ <ulink url="http://source.winehq.org/git/docs.git/">the Documentation Git tree</ulink>.
</para>
<para>
diff --git a/en/winedev-kernel.sgml b/en/winedev-kernel.sgml
index 7b88396..9469501 100644
--- a/en/winedev-kernel.sgml
+++ b/en/winedev-kernel.sgml
@@ -1783,7 +1783,7 @@ if (res != ERROR_SUCCESS) return res;
<tbody>
<row>
<entry><filename><any_path>AUX</filename></entry>
- <entry<filename>>\Global??\AUX</filename></entry>
+ <entry><filename>\Global??\AUX</filename></entry>
<entry>
Treated as an alias to <filename>COM1</filename>
</entry>
diff --git a/en/winedev-testing.sgml b/en/winedev-testing.sgml
index 940ae49..fa4dfcd 100644
--- a/en/winedev-testing.sgml
+++ b/en/winedev-testing.sgml
@@ -118,7 +118,7 @@
results using WM_GETTEXT. Similarly one could create a listbox and
check the effect of LB_DELETESTRING on the number of items of the list,
selected items list, highlighted item, etc. For concrete examples,
- see <filename>dlls/user32/tests/win.c</> and the related tests.
+ see <filename>dlls/user32/tests/win.c</filename> and the related tests.
</para>
<para>
However, undocumented behavior should not be tested for unless there
@@ -140,41 +140,41 @@
<para>
The tests for a specific Wine library are located in a 'tests'
subdirectory of the library directory. Each test is contained in a
- file (e.g. <filename>dlls/kernel/tests/thread.c</>). Each
+ file (e.g. <filename>dlls/kernel/tests/thread.c</filename>). Each
file itself contains many checks concerning one or more related APIs.
</para>
<para>
So to run all the tests related to a given Wine library, go to the
corresponding 'tests' directory and type 'make test'. This will
- compile the tests, run them, and create an '<replaceable>xxx</>.ok'
+ compile the tests, run them, and create an '<replaceable>xxx</replaceable>.ok'
file for each test that passes successfully. And if you only want to
- run the tests contained in the <filename>thread.c</> file of the
+ run the tests contained in the <filename>thread.c</filename> file of the
kernel library, you would do:
<screen>
-<prompt>$ </>cd dlls/kernel/tests
-<prompt>$ </>make thread.ok
+<prompt>$ </prompt>cd dlls/kernel/tests
+<prompt>$ </prompt>make thread.ok
</screen>
</para>
<para>
Note that if the test has already been run and is up to date (i.e. if
- neither the kernel library nor the <filename>thread.c</> file has
- changed since the <filename>thread.ok</> file was created), then make
+ neither the kernel library nor the <filename>thread.c</filename> file has
+ changed since the <filename>thread.ok</filename> file was created), then make
will say so. To force the test to be re-run, delete the
- <filename>thread.ok</> file, and run the make command again.
+ <filename>thread.ok</filename> file, and run the make command again.
</para>
<para>
You can also run tests manually using a command similar to the
following:
<screen>
-<prompt>$ </>../../../tools/runtest -q -M kernel32.dll -p kernel32_test.exe.so thread.c
-<prompt>$ </>../../../tools/runtest -P wine -p kernel32_test.exe.so thread.c
+<prompt>$ </prompt>../../../tools/runtest -q -M kernel32.dll -p kernel32_test.exe.so thread.c
+<prompt>$ </prompt>../../../tools/runtest -P wine -p kernel32_test.exe.so thread.c
thread.c: 86 tests executed, 5 marked as todo, 0 failures.
</screen>
The '-P wine' option defines the platform that is currently being
tested and is used in conjunction with the 'todo' statements (see
below). Remove the '-q' option if you want the testing framework
to report statistics about the number of successful and failed tests.
- Run <command>runtest -h</> for more details.
+ Run <command>runtest -h</command> for more details.
</para>
</sect1>
@@ -194,7 +194,7 @@ thread.c: 86 tests executed, 5 marked as todo, 0 failures.
The following step should probably work on any deb based system.
</para>
<para>
- Run <command>apt-get install mingw32</>.
+ Run <command>apt-get install mingw32</command>.
</para>
</sect3>
<sect3>
@@ -205,7 +205,7 @@ thread.c: 86 tests executed, 5 marked as todo, 0 failures.
The following step should probably work on any rpm based system.
</para>
<para>
- Run <command>yum install mingw32-gcc</>.
+ Run <command>yum install mingw32-gcc</command>.
</para>
</sect3>
<sect3>
@@ -224,13 +224,13 @@ thread.c: 86 tests executed, 5 marked as todo, 0 failures.
Windows executables is easy by using the Wine build system.
</para>
<para>
- If you had already run <command>configure</>, then delete
- <filename>config.cache</> and re-run <command>configure</>.
- You can then run <command>make crosstest</>. To sum up:
+ If you had already run <command>configure</command>, then delete
+ <filename>config.cache</filename> and re-run <command>configure</command>.
+ You can then run <command>make crosstest</command>. To sum up:
<screen>
-<prompt>$ </><userinput>rm config.cache</>
-<prompt>$ </><userinput>./configure</>
-<prompt>$ </><userinput>make crosstest</>
+<prompt>$ </prompt><userinput>rm config.cache</userinput>
+<prompt>$ </prompt><userinput>./configure</userinput>
+<prompt>$ </prompt><userinput>make crosstest</userinput>
</screen>
</para>
</sect2>
@@ -243,7 +243,7 @@ thread.c: 86 tests executed, 5 marked as todo, 0 failures.
<title>Using pre-compiled binaries</title>
<para>
The simplest solution is to visit
- <ulink url="http://test.winehq.org">test.winehq.org</> and
+ <ulink url="http://test.winehq.org">test.winehq.org</ulink> and
download the latest version of winetest at the bottom of the page.
This executable contains all the Wine
conformance tests, runs them and reports the results.
@@ -251,7 +251,7 @@ thread.c: 86 tests executed, 5 marked as todo, 0 failures.
<para>
You can also get the older versions from
<ulink url="http://www.astro.gla.ac.uk/users/paulm/WRT/CrossBuilt/">Paul
- Millar's website</>.
+ Millar's website</ulink>.
</para>
</sect2>
<sect2>
@@ -260,20 +260,22 @@ thread.c: 86 tests executed, 5 marked as todo, 0 failures.
<listitem><para>
If you are using Visual Studio 6, make sure you have the
"processor pack" from
- <ulink url="http://msdn.microsoft.com/vstudio/downloads/tools/ppack/default.aspx">http://msdn.microsoft.com/vstudio/downloads/tools/ppack/default.aspx</>.
+ <ulink url="http://msdn.microsoft.com/vstudio/downloads/tools/ppack/default.aspx"></ulink>.
The processor pack fixes <emphasis>"error C2520: conversion from
- unsigned __int64 to double not implemented, use signed __int64"</>.
+ unsigned __int64 to double not implemented, use signed __int64"</emphasis>.
However note that the "processor pack" is incompatible with
Visual Studio 6.0 Standard Edition, and with the Visual Studio 6
Service Pack 6. If you are using Visual Studio 7 or greater you
do not need the processor pack. In either case it is recommended
to use the most recent compatible Visual Studio
- <ulink url="http://msdn.microsoft.com/vstudio/downloads/updates/sp/">service pack</>.
- If are using Visual Studio Express and you need specific libraries like
- <filename>ntdll.lib</> that don't ship with Visual Studio Express, you will need the
- <ulink url="http://www.microsoft.com/whdc/devtools/ddk/default.mspx">Windows Driver Development Kit (DDK)</>
- which is part of the
- <ulink url="http://www.microsoft.com/whdc/resources/downloads.mspx">Windows Developer Kit</>.
+ <ulink url="http://msdn.microsoft.com/vstudio/downloads/updates/sp/">service pack</ulink>.
+ If are using Visual Studio Express and you need specific libraries like
+ <filename>ntdll.lib</filename> that don't ship with Visual Studio Express, you will need the
+ <ulink url="http://www.microsoft.com/whdc/devtools/ddk/default.mspx">Windows Driver
+Development Kit (DDK)</ulink>
+ which is part of the
+ <ulink url="http://www.microsoft.com/whdc/resources/downloads.mspx">Windows Developer
+Kit</ulink>.
</para></listitem>
<listitem><para>
get the Wine sources
@@ -283,7 +285,7 @@ thread.c: 86 tests executed, 5 marked as todo, 0 failures.
'msvcmaker' is a perl script so you may be able to run it on
Windows.
<screen>
-<prompt>$ </>./tools/winapi/msvcmaker --no-wine
+<prompt>$ </prompt>./tools/winapi/msvcmaker --no-wine
</screen>
</para></listitem>
<listitem><para>
@@ -293,7 +295,7 @@ thread.c: 86 tests executed, 5 marked as todo, 0 failures.
this using Samba but copying them altogether would work too.
</para></listitem>
<listitem><para>
- On the Windows machine, open the <filename>winetest.dsw</>
+ On the Windows machine, open the <filename>winetest.dsw</filename>
workspace. This will load each test's project. For each test there
are two configurations: one compiles the test with the Wine
headers, and the other uses the Microsoft headers.
@@ -302,37 +304,37 @@ thread.c: 86 tests executed, 5 marked as todo, 0 failures.
If you choose the "Win32 MSVC Headers" configuration, most of the
tests will not compile with the regular Visual Studio headers. So
to use this configuration, download and install a recent
- <ulink url="http://www.microsoft.com/msdownload/platformsdk/sdkupdate/">Platform SDK</>
- as well as the latest <ulink url="http://msdn.microsoft.com/library/default.asp?url=/downloads/list/directx.asp">DirectX SDK</>.
- Then, <ulink url="http://msdn.microsoft.com/library/default.asp?url=/library/EN-US/sdkintro/sdkintro/installing_the_platform_sdk_with_visual_studio.asp">configure Visual Studio</>
+ <ulink url="http://www.microsoft.com/msdownload/platformsdk/sdkupdate/">Platform SDK</ulink>
+ as well as the latest <ulink url="http://msdn.microsoft.com/library/default.asp?url=/downloads/list/directx.asp">DirectX SDK</ulink>.
+ Then, <ulink url="http://msdn.microsoft.com/library/default.asp?url=/library/EN-US/sdkintro/sdkintro/installing_the_platform_sdk_with_visual_studio.asp">configure Visual Studio</ulink>
to use these SDK headers and libraries. Alternately you could go
- to the <menuchoice><guimenu>Project</> <guimenu>Settings...</></>
+ to the <menuchoice><guimenu>Project</guimenu> <guimenu>Settings...</guimenu></menuchoice>
menu and modify the settings appropriately, but you would then
have to redo this whenever you rerun msvcmaker.
</para></listitem>
<listitem><para>
- Open the <menuchoice><guimenu>Build</> <guimenu>Batch
- build...</></> menu and select the tests and build configurations
- you want to build. Then click on <guibutton>Build</>.
+ Open the <menuchoice><guimenu>Build</guimenu> <guimenu>Batch
+ build...</guimenu></menuchoice> menu and select the tests and build configurations
+ you want to build. Then click on <guibutton>Build</guibutton>.
</para></listitem>
<listitem><para>
To run a specific test from Visual C++, go to
- <menuchoice><guimenu>Project</> <guimenu>Settings...</></>. There
+ <menuchoice><guimenu>Project</guimenu> <guimenu>Settings...</guimenu></menuchoice>. There
select that test's project and build configuration and go to the
- <guilabel>Debug</> tab. There type the name of the specific test
- to run (e.g. 'thread') in the <guilabel>Program arguments</>
- field. Validate your change by clicking on <guibutton>Ok</> and
+ <guilabel>Debug</guilabel> tab. There type the name of the specific test
+ to run (e.g. 'thread') in the <guilabel>Program arguments</guilabel>
+ field. Validate your change by clicking on <guibutton>Ok</guibutton> and
start the test by clicking the red exclamation mark (or hitting
'F5' or any other usual method).
</para></listitem>
<listitem><para>
You can also run the tests from the command line. You will find
- them in either <filename>Output\Win32_Wine_Headers</> or
- <filename>Output\Win32_MSVC_Headers</> depending on the build
+ them in either <filename>Output\Win32_Wine_Headers</filename> or
+ <filename>Output\Win32_MSVC_Headers</filename> depending on the build
method. So to run the kernel 'path' tests you would do:
<screen>
-<prompt>C:\></>cd dlls\kernel\tests\Output\Win32_MSVC_Headers
-<prompt>C:\wine\dlls\kernel\tests\Output\Win32_MSVC_Headers></> kernel32_test path
+<prompt>C:\></prompt>cd dlls\kernel\tests\Output\Win32_MSVC_Headers
+<prompt>C:\wine\dlls\kernel\tests\Output\Win32_MSVC_Headers></prompt> kernel32_test path
</screen>
</para></listitem>
</itemizedlist>
@@ -356,39 +358,38 @@ thread.c: 86 tests executed, 5 marked as todo, 0 failures.
Here's the simplest way to do that on a Windows system:
<itemizedlist>
<listitem><para>
- Download and install the free-as-in-beer
- <ulink url="http://msdn.microsoft.com/visualc/vctoolkit2003">Microsoft C++ Toolkit</>
- and the
- <ulink url="http://www.microsoft.com/msdownload/platformsdk/sdkupdate">Microsoft Platform SDK</>.
+ Download and install the free-as-in-beer
+ <ulink url="http://msdn.microsoft.com/visualc/vctoolkit2003">Microsoft C++ Toolkit</ulink>
+ and the
+ <ulink url="http://www.microsoft.com/msdownload/platformsdk/sdkupdate">Microsoft Platform SDK</ulink>.
</para></listitem>
<listitem><para>
- Make a directory <filename>wine</> underneath your work directory,
- and copy the file <filename>wine/test.h</> from the Wine source tree there
+ Make a <filename>wine</filename> directory underneath your work directory,
+ and copy the file <filename>wine/test.h</filename> from the Wine source tree there
(you can download this file from the latest revision at
- <ulink url="http://source.winehq.org/git/?p=wine.git;a=blob_plain;f=include/wine/test.h">
- http://source.winehq.org/git/?p=wine.git;a=blob_plain;f=include/wine/test.h</>).
+ <ulink url="http://source.winehq.org/git/?p=wine.git;a=blob_plain;f=include/wine/test.h"></ulink>).
</para></listitem>
<listitem><para>
Copy some existing test from the Wine source tree, or
- create your test program (say, <filename>mytest.c</>) using Notepad,
- being sure to begin it with <function>#include <wine/test.h></>
+ create your test program (say, <filename>mytest.c</filename>) using Notepad,
+ being sure to begin it with <function>#include <wine/test.h></function>
following the usual Wine test style.
</para></listitem>
<listitem><para>
Finally, in a command prompt window, compile the test with the command
<screen>
-<prompt>C:\your\work\dir></>cl -I. -DSTANDALONE -D_X86_ mytest.c
+<prompt>C:\your\work\dir></prompt>cl -I. -DSTANDALONE -D_X86_ mytest.c
</screen>
</para></listitem>
<listitem><para>
Once that's working, try running the program under Wine without
recompiling it. See? No Wine source required at all,
- save for that one header, <filename>wine/test.h</>.
+ save for that one header, <filename>wine/test.h</filename>.
</para></listitem>
<listitem><para>
If you want to use the Microsoft C++ Toolkit under Wine,
install it under Windows, then copy it to your fake C drive;
- it'll work fine there. See <ulink url="http://kegel.com/wine/cl-howto.html">CL Howto</>
+ it'll work fine there. See <ulink url="http://kegel.com/wine/cl-howto.html">CL Howto</ulink>
for some tips on making it easy to use from the Linux command line.
</para></listitem>
</itemizedlist>
@@ -405,7 +406,7 @@ thread.c: 86 tests executed, 5 marked as todo, 0 failures.
add a new one. If your tests are related to the tests performed by an
existing file, then add them to that file. Otherwise create a new .c
file in the tests directory and add that file to the
- <varname>CTESTS</> variable in <filename>Makefile.in</>.
+ <varname>CTESTS</varname> variable in <filename>Makefile.in</filename>.
</para>
<para>
A new test file will look something like the following:
@@ -429,17 +430,17 @@ START_TEST(paths)
it may be better to split related checks in functions you will call
from the START_TEST section. The parameter to START_TEST must match
the name of the C file. So in the above example the C file would be
- called <filename>paths.c</>.
+ called <filename>paths.c</filename>.
</para>
<para>
- Tests should start by including the <filename>wine/test.h</> header.
+ Tests should start by including the <filename>wine/test.h</filename> header.
This header will provide you access to all the testing framework
functions. You can then include the windows header you need, but make
sure to not include any Unix or Wine specific header: tests must
compile on Windows.
</para>
<para>
- You can use <function>trace</> to print informational messages. Note
+ You can use <function>trace</function> to print informational messages. Note
that these messages will only be printed if 'runtest -v' is being used.
<screen>
trace("testing GlobalAddAtomA\n");
@@ -447,14 +448,14 @@ START_TEST(paths)
</screen>
</para>
<para>
- Then just call functions and use <function>ok</> to make sure that
+ Then just call functions and use <function>ok</function> to make sure that
they behaved as expected:
<screen>
ATOM atom = GlobalAddAtomA( "foobar" );
ok( GlobalFindAtomA( "foobar" ) == atom, "could not find atom foobar\n" );
ok( GlobalFindAtomA( "FOOBAR" ) == atom, "could not find atom FOOBAR\n" );
</screen>
- The first parameter of <function>ok</> is an expression which must
+ The first parameter of <function>ok</function> is an expression which must
evaluate to true if the test was successful. The next parameter is a
printf-compatible format string which is displayed in case the test
failed, and the following optional parameters depend on the format
@@ -466,7 +467,7 @@ START_TEST(paths)
<title>Writing good error messages</title>
<para>
The message that is printed when a test fails is
- <emphasis>extremely</> important.
+ <emphasis>extremely</emphasis> important.
</para>
<para>
Someone will take your test, run it on a Windows platform that
--
1.8.3.2
More information about the wine-patches
mailing list