summaryrefslogtreecommitdiffstats
path: root/Utilities/cmexpat/README.md
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2019-11-11 15:42:32 (GMT)
committerBrad King <brad.king@kitware.com>2019-11-11 15:42:32 (GMT)
commitb63a5c88a2089494e53f22f83db1925435161934 (patch)
treebf092a546d8a6b442589d10ad115572e528ca9da /Utilities/cmexpat/README.md
parent512fabaa9d8a864ee212664df1bfddf112f5d79b (diff)
parent1712885b4f68093e4e30e5e9e979ac0611030608 (diff)
downloadCMake-b63a5c88a2089494e53f22f83db1925435161934.zip
CMake-b63a5c88a2089494e53f22f83db1925435161934.tar.gz
CMake-b63a5c88a2089494e53f22f83db1925435161934.tar.bz2
Merge branch 'upstream-expat' into update-expat
* upstream-expat: expat 2019-09-25 (a7bc26b6)
Diffstat (limited to 'Utilities/cmexpat/README.md')
-rw-r--r--Utilities/cmexpat/README.md63
1 files changed, 62 insertions, 1 deletions
diff --git a/Utilities/cmexpat/README.md b/Utilities/cmexpat/README.md
index fd3911e..1cc52b0 100644
--- a/Utilities/cmexpat/README.md
+++ b/Utilities/cmexpat/README.md
@@ -3,7 +3,7 @@
[![Packaging status](https://repology.org/badge/tiny-repos/expat.svg)](https://repology.org/metapackage/expat/versions)
-# Expat, Release 2.2.7
+# Expat, Release 2.2.9
This is Expat, a C library for parsing XML, started by
[James Clark](https://en.wikipedia.org/wiki/James_Clark_(programmer)) in 1997.
@@ -13,6 +13,11 @@ are called when the parser discovers the associated structures in the
document being parsed. A start tag is an example of the kind of
structures for which you may register handlers.
+Expat supports the following compilers:
+- GNU GCC >=4.5
+- LLVM Clang >=3.5
+- Microsoft Visual Studio >=8.0/2005
+
Windows users should use the
[`expat_win32` package](https://sourceforge.net/projects/expat/files/expat_win32/),
which includes both precompiled libraries and executables, and source code for
@@ -125,3 +130,59 @@ information.
A reference manual is available in the file `doc/reference.html` in this
distribution.
+
+
+The CMake build system is still *experimental* and will replace the primary
+build system based on GNU Autotools at some point when it is ready.
+For an idea of the available (non-advanced) options for building with CMake:
+
+```console
+# rm -f CMakeCache.txt ; cmake -D_EXPAT_HELP=ON -LH . | grep -B1 ':.*=' | sed 's,^--$,,'
+// Choose the type of build, options are: None Debug Release RelWithDebInfo MinSizeRel ...
+CMAKE_BUILD_TYPE:STRING=
+
+// Install path prefix, prepended onto install directories.
+CMAKE_INSTALL_PREFIX:PATH=/usr/local
+
+// Path to a program.
+DOCBOOK_TO_MAN:FILEPATH=/usr/bin/docbook2x-man
+
+// build man page for xmlwf
+EXPAT_BUILD_DOCS:BOOL=ON
+
+// build the examples for expat library
+EXPAT_BUILD_EXAMPLES:BOOL=ON
+
+// build fuzzers for the expat library
+EXPAT_BUILD_FUZZERS:BOOL=OFF
+
+// build the tests for expat library
+EXPAT_BUILD_TESTS:BOOL=ON
+
+// build the xmlwf tool for expat library
+EXPAT_BUILD_TOOLS:BOOL=ON
+
+// Character type to use (char|ushort|wchar_t) [default=char]
+EXPAT_CHAR_TYPE:STRING=char
+
+// install expat files in cmake install target
+EXPAT_ENABLE_INSTALL:BOOL=ON
+
+// Use /MT flag (static CRT) when compiling in MSVC
+EXPAT_MSVC_STATIC_CRT:BOOL=OFF
+
+// build a shared expat library
+EXPAT_SHARED_LIBS:BOOL=ON
+
+// Treat all compiler warnings as errors
+EXPAT_WARNINGS_AS_ERRORS:BOOL=OFF
+
+// Make use of getrandom function (ON|OFF|AUTO) [default=AUTO]
+EXPAT_WITH_GETRANDOM:STRING=AUTO
+
+// utilize libbsd (for arc4random_buf)
+EXPAT_WITH_LIBBSD:BOOL=OFF
+
+// Make use of syscall SYS_getrandom (ON|OFF|AUTO) [default=AUTO]
+EXPAT_WITH_SYS_GETRANDOM:STRING=AUTO
+```