src/expat/watcom/README.TXT

   1
   2                         Expat, Release 2.0.0
   3                  Open Watcom OS/2-eCS and NT/2000/XP
   4
   5 SUMMARY
   6 =======
   7 This is the first effort of adding Open Watcom (www.openwatcom.org) build
   8 capability to the expat project. The included changes and makefiles are
   9 verified to work with Open Watcom 1.5, however, it might build with
  10 version 1.4.
  11
  12 HISTORY
  13 =======
  14 June 2006 - First successful compile with Open Watcom 1.5
  15 July 2006 - Submit as patch
  16
  17 BUILDING
  18 ========
  19 The makefile system is based on a multi-platform system provided by
  20 Mat Nieuwenhoven. In the watcom directory is the main makefile which
  21 accepts the following options:
  22
  23    os2       - OS/2-ECS Release
  24    nt        - WinNT/2000/XP Release
  25    linux     - Linux Release
  26    os2d      - OS/2-ECS Debug
  27    ntd       - WinNT/2000/XP Debug
  28    linuxd    - Linux Debug
  29    full      - all release
  30    fulld     - all debug
  31    fullall   - all release and debug
  32    cleanall  - remove all
  33    clean     - remove build keep release
  34    xmlts.zip - download test suite and unzip
  35
  36 The options for the OW build of expat are set in watcom\buildopts.inc.
  37
  38 The following expat options are available:
  39
  40 XML_DTD (Note 1)
  41     Include support for using and reporting DTD-based content. If this
  42     is defined, default attribute values from an external DTD subset are
  43     reported and attribute value normalization occurs based on the type of
  44     attributes defined in the external subset. Without this, Expat has a
  45     smaller memory footprint and can be faster, but will not load external
  46     entities or process conditional sections. This does not affect the set
  47     of functions available in the API.
  48
  49 XML_NS (Note 1)
  50     When defined, support for the Namespaces in XML specification is included.
  51
  52 XML_UNICODE (Note 2)
  53     When defined, character data reported to the application is encoded
  54     in UTF-16 using wide characters of the type XML_Char. This is implied
  55     if XML_UNICODE_WCHAR_T is defined.
  56
  57 XML_UNICODE_WCHAR_T (Note 2)
  58     If defined, causes the XML_Char character type to be defined using the
  59     wchar_t type; otherwise, unsigned short is used. Defining this implies
  60     XML_UNICODE.
  61
  62 XML_LARGE_SIZE (Note 3)
  63     (OS/2 and Windows) [optional] If defined, causes the XML_Size and XML_Index
  64     integer types to be at least 64 bits in size. This is intended to support
  65     processing of very large input streams, where the return values of
  66     XML_GetCurrentByteIndex, XML_GetCurrentLineNumber and
  67     XML_GetCurrentColumnNumber could overflow. It may not be supported by all
  68     compilers, and is turned off by default.
  69
  70 XML_CONTEXT_BYTES (Note 1)
  71     The number of input bytes of markup context which the parser will ensure are
  72     available for reporting via XML_GetInputContext. This is normally set to 1024,
  73     and must be set to a positive interger. If this is not defined, the input
  74     context will not be available and XML_GetInputContext will always report NULL.
  75     Without this, Expat has a smaller memory footprint and can be faster.
  76
  77 XML_MIN_SIZE (Note 3)
  78     (OS/2 and Windows) [optional] Makes a parser that's smaller but that,
  79     in general, will run slower.
  80
  81 Note 1: Define by default in watcomconfig.h - XML_CONTEXT_BYTES define as 1024.
  82
  83 Note 2: Not yet supported
  84
  85 Note 3: Not defined by default, but supported by Open Watcom
  86
  87
  88 XML_TEST_SUITE
  89 ==============
  90 While you are welcome to run the tests, however, it will require downloading and
  91 setting up additional unix type utilitiy/tools on OS/2-ECS and Windows platforms.
  92
  93 I have added the target xmlts.zip to the makefile which will use wget to dowload
  94 and unzip to setup the test files. The tests/xmltest.sh file will have to be
  95 modified, changing XMLWF= to the location of the xmlwwf.exe file.
  96
  97 The ouput from both OS2-ECS and WinNT/2000/XP builds is listed below. I have
  98 built expat 2.0.0 on a Linux gcc system and verified that the output is the same
  99 result for OS/2-ECS and Windows platforms. So, I feel confident that the Open Watcom
 100 build is working as well as the other compiler builds.
 101
 102 The test results should be:
 103
 104   Output differs: ibm/valid/P02/ibm02v01.xml
 105   Output differs: ibm/valid/P28/ibm28v02.xml
 106   Output differs: ibm/valid/P29/ibm29v01.xml
 107   Output differs: ibm/valid/P29/ibm29v02.xml
 108   Output differs: ibm/valid/P54/ibm54v01.xml
 109   Output differs: ibm/valid/P56/ibm56v08.xml
 110   Output differs: ibm/valid/P57/ibm57v01.xml
 111   Output differs: ibm/valid/P58/ibm58v01.xml
 112   Output differs: ibm/valid/P58/ibm58v02.xml
 113   Output differs: ibm/valid/P70/ibm70v01.xml
 114   Output differs: ibm/valid/P82/ibm82v01.xml
 115   E:/expat-2.0.0/tests/XML-Test-Suite/out/ibm/invalid/P29//*.xml: No such file or directory
 116   ibm49i02.dtd: No such file or directory
 117   In ibm/invalid/P49/: ibm49i02.xml:4:1: error in processing external entity reference
 118   Output differs: ibm/invalid/P58/ibm58i01.xml
 119   Output differs: ibm/invalid/P58/ibm58i02.xml
 120   Output differs: xmltest/valid/sa/069.xml
 121   Output differs: xmltest/valid/sa/076.xml
 122   Output differs: xmltest/valid/sa/090.xml
 123   Output differs: xmltest/valid/sa/091.xml
 124   Output differs: sun/valid/not-sa01.xml
 125   Output differs: sun/valid/not-sa02.xml
 126   Output differs: sun/valid/not-sa03.xml
 127   Output differs: sun/valid/not-sa04.xml
 128   Output differs: sun/valid/notation01.xml
 129   Output differs: sun/valid/sa02.xml
 130   Output differs: sun/valid/sa03.xml
 131   Output differs: sun/valid/sa04.xml
 132   Output differs: sun/valid/sa05.xml
 133   Expected well-formed: ibm/not-wf/misc/432gewf.xml
 134   Expected well-formed: xmltest/not-wf/not-sa/005.xml
 135   Expected well-formed: sun/not-wf/uri01.xml
 136   Expected well-formed: oasis/p06fail1.xml
 137   Expected well-formed: oasis/p08fail1.xml
 138   Expected well-formed: oasis/p08fail2.xml
 139   Passed: 1776
 140   Failed: 34
 141
 142
 143
 144
 145
 146