doc


Log

Author Commit Date CI Message
Nick Wellnhofer d9e1198c 2022-04-23T18:42:35 Redirect examples test output to /dev/null Regressed in commit c61e1273.
Nick Wellnhofer c61e1273 2022-04-21T06:03:22 Fix warnings when testing --with-minimum build There's no simple way to make the doc/examples tests handle different configurations. But these tests aren't especially valuable, so remove the result file checks.
Nick Wellnhofer 67070107 2022-04-20T23:17:14 Add configuration flag for XPointer locations support Add a new configuration flag that controls whether the outdated support for XPointer locations (ranges and points) is enabled. --with-xptr-locs # Autotools LIBXML2_WITH_XPTR_LOCS # CMake The latest spec for what it essentially an XPath extension seems to be this working draft from 2002: https://www.w3.org/TR/xptr-xpointer/ The xpointer() scheme is listed as "being reviewed" in the XPointer registry since at least 2006. libxml2 seems to be the only modern software that tries to implement this spec, but the code has many bugs and quality issues. The flag defaults to "off" and support for this extensions has to be requested explicitly. The relevant API functions are deprecated.
Nick Wellnhofer 9a0be0dc 2022-04-21T01:11:35 Regenerate api.xml and testapi.c
David Seifert a62b31f4 2022-04-06T19:57:30 Use portable python shebangs * In conda or Gentoo Prefix, we don't want to use the system python and instead rely on PATH lookup.
Nick Wellnhofer e59aa6ca 2022-04-04T05:57:07 Move doc/examples tests to new test suite
Nick Wellnhofer 5ce893c0 2020-07-09T03:21:07 Move regexp tests to runtest
Nick Wellnhofer 48b03c84 2022-04-03T20:36:38 Remove major parts of old test suite Remove all the parts of the old test suite which are covered by runtest.c for quite some time. The following test programs are removed: - testC14N - testHTML - testReader - testRelax - testSAX - testSchemas - testURI - testXPath This also removes a few results of unimportant tests only run by the old test suite.
Nick Wellnhofer bf2436ac 2022-04-03T19:02:06 Update xml2-config man page
Nick Wellnhofer 61b78b0a 2022-04-03T18:30:26 Consolidate man pages Move xml2-config.1 into doc directory. Remove outdated libxml.3.
Nick Wellnhofer 7016b0e0 2022-04-03T01:42:17 Don't overlink executables With very few exceptions, utilities and test programs don't require any external libraries. - xmllint and xmlcatalog need libreadline - runtest and testThreads need pthreads
Nick Wellnhofer e1637646 2022-04-02T16:42:33 Rename xmlcatalog_man.xml
Nick Wellnhofer 207b10cf 2022-04-02T16:39:44 Streamline documentation installation Use Automake variables to install and distribute files. Remove check-extra-dist.
Nick Wellnhofer 95766541 2022-03-02T19:01:16 Only install *.html and *.c example files
Nick Wellnhofer 456a0bf6 2022-03-02T18:58:17 Remove --with-html-dir option Install documentation in $(docdir).
Nick Wellnhofer 74580967 2022-03-02T18:45:39 Rework documentation build system Since several generated files are under version control, their timestamps are essentially random and rebuilding documentation using Makefile rules can't work reliably. Simply add a phony rebuild target that regenerates the whole documentation and other files unconditionally. make -C doc rebuild
Nick Wellnhofer fb358884 2022-03-02T17:35:12 Remove old website
Nick Wellnhofer 991a9fc2 2022-03-29T16:20:28 Mark docbook symbols as removed
Nick Wellnhofer ff367708 2022-03-02T17:50:00 Make examples a standalone HTML page Also upload to GitLab Pages.
Nick Wellnhofer 28d03996 2022-03-02T16:52:29 Remove obsolete XML Software Autoupdate (XSA) file
Nick Wellnhofer d4f90698 2022-03-02T17:35:39 Add XML_DEPRECATED to ignored keywords Fixes the API documentation generator.
Nick Wellnhofer 4a8c71eb 2022-03-04T03:35:57 Remove DOCBparser This code has been broken and deprecated since version 2.6.0, released in 2003. Because of a bug in commit 961b535c, DOCBparser.c was never compiled since 2012. I couldn't find a Debian package using any of its symbols, so it seems safe to remove this module.
Nick Wellnhofer 6117700e 2022-02-20T20:56:40 Remove special configuration for certain maintainers
Nick Wellnhofer 346c3a93 2022-02-20T18:46:42 Remove elfgcchack.h The same optimization can be enabled with -fno-semantic-interposition since GCC 5. clang has always used this option by default.
Nick Wellnhofer 04d4124c 2022-02-19T18:50:10 Update news and rebuild documentation
Nick Wellnhofer f2ad86fa 2022-02-17T19:05:26 Remove SVN keyword anchors
Nick Wellnhofer b041d829 2022-02-16T19:55:30 Remove xmlwin32version.h This file was undocumented and never used anywhere. Maybe users were supposed to rename this file to xmlversion.h manually. These days, both CMake and win32/configure.js generate xmlversion.h from xmlversion.h.in, just like the Autotools build.
Nick Wellnhofer 8eb06937 2022-02-14T01:01:23 Remove outdated ChangeLog code The ChangeLog is from pre-Git times.
Nick Wellnhofer 10891111 2022-02-13T22:52:53 Redirect links to xmlsoft.org Documentation and releases are now available on gitlab.gnome.org.
Nick Wellnhofer 4f2693a1 2022-02-13T22:57:34 Remove README.docs This was just a partial copy of the main README.
Nick Wellnhofer b0e6eb97 2022-02-13T22:51:26 Remove xmltutorial.pdf We already have an HTML version.
Nick Wellnhofer fcd4c5b8 2022-02-07T19:22:45 Document how to escape XML_CATALOG_FILES Fixes #309.
Nick Wellnhofer 00e618eb 2022-01-17T21:39:27 Remove old devhelp format See #295.
Kjell Ahlstedt 66fb340a 2021-10-14T15:01:24 Update URL for libxml++ C++ binding Fixes #267
Mattia Rizzolo 96753450 2021-07-29T12:14:03 Correctly install the HTML examples into their subdirectory. Previous to this commit, the examples where installed haphazardly within all the other html documents, also overwriting index.html, for example. Signed-off-by: Mattia Rizzolo <mattia@mapreri.org>
Emmanuele Bassi 3ba59b93 2021-07-23T22:34:29 Generate devhelp2 index file The devhelp2 format was introduced in 2005, and the devhelp format was deprecated in 2017. Fixes: https://gitlab.gnome.org/GNOME/libxml2/-/issues/295
Jan Tojnar e6adc19f 2021-07-05T13:40:54 man: Mention XML_CATALOG_FILES is space-separated Fixes: https://bugzilla.gnome.org/show_bug.cgi?id=781274
Rainer M. Canavan bdd482c2 2021-07-05T18:48:10 add documentaiton for xmllint exit code 10 Closes: https://gitlab.gnome.org/GNOME/libxml2/-/issues/280
David King 2c0f2f03 2021-05-18T09:52:55 Fix some validation errors in the FAQ Move paragraphs inside li elements.
Daniel Veillard e1bcffea 2021-05-13T15:35:21 Release of libxml2-2.9.11 Prompted by CVE-2021-3541, but this includes an awful lot of serious bug fixes by Nick and others. - configure.ac: bumped to new release - doc/* updated and regenerated
Andre Klapper d6761e70 2020-07-13T11:59:45 Update to Devhelp index file format version 2 Fixes #89
Martin Vidner 43a8836c 2020-05-31T18:46:21 Fix rebuilding docs, by hiding __attribute__((...)) behind a macro. When enabled via `./configure --enable-rebuild-docs`, `make -C doc libxml2-api.xml` will invoke apibuild.py to rebuild libxml2-api.xml from the sources. But the code added in 9fa3200cb366c726f7c8ef234282603bb9e8816d made it error out with ``` Parsing ../parser.c Parse Error: parsing type : expecting a name ('Got token ', ('sep', '(')) ('Last token: ', ('sep', '(')) ('Token queue: ', [('name', 'destructor'), ('sep', ')'), ('sep', ')')]) ('Line 14689 end: ', '') ```
Nick Wellnhofer 20c60886 2020-03-08T17:19:42 Fix typos Resolves #133.
Nick Wellnhofer c2e09f44 2020-02-11T11:32:23 Add xmlPopOutputCallbacks Add function to pop a single set of output callbacks from the stack. This was only implemented for input callbacks before. Fixes #135.
Daniel Veillard 41a34e1f 2019-10-30T20:14:56 Release of libxml2-2.9.10 * configure.ac doc/xml.html: updated for the release * doc/*: regenerated docs, APIs, etc ...
Daniel Veillard 9acef289 2019-10-23T18:13:08 Fix some release issues on Fedora 30 * doc/Makefile.am: xzlib.html seems not generated anymore since it was only containing an internal define we can drop it * libxml.spec.in: don't run python tests as part of %check as this is now breaking on F30
Nick Wellnhofer 64966ebe 2019-09-30T17:34:32 Rebuild docs
Nick Wellnhofer 2e55f6dc 2019-09-30T17:30:17 Make apibuild.py ignore ATTRIBUTE_NO_SANITIZE
Jared Yanovich 2a350ee9 2019-09-30T17:04:54 Large batch of typo fixes Closes #109.
Nick Wellnhofer 80b110a9 2019-09-30T14:37:57 Mark xmlExp* symbols as removed
Jan Pokorný 81958b6e 2019-07-11T19:24:11 Doc: do not mislead towards "infeasible" scenario wrt. xmlBufNodeDump At least when merely public API is to be leveraged, one cannot use xmlBufCreate function that would otherwise be a clear fit, and relying on some invariants wrt. how some other struct fields will get initialized along the construction/filling such parent struct and (ab)using that instead does not appear clever, either. Hence, instruct people what's the Right Thing for the moment, that is, make them use xmlNodeDumpOutput instead (together with likewise public xmlAllocOutputBuffer). Going forward, it's questionable what do with xmlBuf* family of functions that are once public, since they, for any practical purpose, cannot be used by the library clients (that's how I've run into this). Signed-off-by: Jan Pokorný <jpokorny@redhat.com>
Nick Wellnhofer 37189c08 2019-07-08T12:18:24 dict.h: gcc 2.95 doesn't allow multiple storage classes This is a partial revert of commit c71f9305. I'm not sure what issue this commit was trying to solve but it seems to be related to a circular dependency. It might be related to tree.h being included from dict.h which is unnecessary. Resolves !22.
Nick Wellnhofer 538d827c 2019-02-15T17:26:38 Change git repo URL
Nick Wellnhofer 04fbfa3f 2019-02-15T17:20:18 Change bug tracker URL
Nick Wellnhofer 656df97d 2019-02-15T17:05:16 Remove outdated HTML file
Nick Wellnhofer 57d4329b 2018-01-23T17:33:42 Merge testThreadsWin32.c into testThreads.c Apply the same cross-platform modifications as previously in runtest.c.
Daniel Veillard f8a8c1f5 2019-01-03T19:14:17 Release of libxml2-2.9.9 * configure.ac doc/news.html doc/xml.html doc/libxml2.xsa: making changes for the release Signed-off-by: Daniel Veillard <veillard@redhat.com>
Daniel Veillard 18890f47 2018-03-05T17:09:43 Release of libxml2-2.9.8 * configure.ac doc/* libxml2.syms testapi.c: updated for the new release
Nick Wellnhofer e03f0a19 2017-11-09T16:42:47 Fix hash callback signatures Make sure that all parameters and return values of hash callback functions exactly match the callback function type. This is required to pass clang's Control Flow Integrity checks and to allow compilation to asm.js with Emscripten. Fixes bug 784861.
Daniel Veillard bc5a5d65 2017-11-02T21:26:55 Release of libxnl2-2.9.7 * configure.ac doc/news.html : update for release * doc/news.html doc/xmlcatalog.1 doc/xmlcatalog_man.html: regenerated
Nick Wellnhofer 09f51ecb 2017-10-24T14:29:26 Add Makefile rules to rebuild HTML man pages This should make sure that the online version of the man pages for xmllint and xmlcatalog stay up to date. Also rebuild both HTML documents.
Jan Pokorný ca01f813 2017-10-24T13:51:34 xmlcatalog: refresh man page wrt. quering system catalog easily Also normalize "lookup" spelling.
Nick Wellnhofer 03a238f9 2017-09-29T13:00:50 Use __linux__ macro in generated code
Daniel Veillard 4b4d3d85 2017-10-06T09:00:53 Release of libxml2-2.9.6 * configure.ac doc/xml.html doc/news.html: updated for release
Daniel Veillard 2960178f 2017-09-04T15:38:47 Release of libxml2-2.9.5 * configure.ac, doc/xslt.html: updated for the release * doc/*, python/setup.py, testapi.c: regenerated
Nick Wellnhofer 8bbe4508 2017-06-17T16:15:09 Spelling and grammar fixes Fixes bug 743172, bug 743489, bug 769632, bug 782400 and a few other misspellings.
Nick Wellnhofer 988a5a3b 2017-06-17T15:44:50 Build test programs only when needed Add test programs to 'check_PROGRAMS' instead of 'noinst_PROGRAMS'. Fixes bug 760457.
Nick Wellnhofer b9b4b6b5 2017-06-17T15:40:45 Fix doc/examples/index.py In my previous commit that silenced some test output I didn't realize that doc/examples/Makefile.am was autogenerated. Also make index.py output deterministic by sorting the glob results.
Nick Wellnhofer 1ce1f785 2017-06-17T14:11:03 Fix invalid-source-encoding warnings in testWriter.c Use hex escapes instead of binary data in source file.
Nick Wellnhofer 67f9f9d6 2017-06-12T19:25:01 Misc fixes for 'make tests' - Silence test output. - Clean up after doc/examples tests. - Adjust expected output for script tests. - Add missing results for relaxng/pattern3 There are still two test failures I can't comment on: - regexp/bug316338 - schemas/any4_0
Nick Wellnhofer 94613f64 2016-08-22T12:16:31 Remove unused variables
Daniel Veillard bdec2183 2016-05-23T16:04:52 Release of libxml2-2.9.4 * doc/xml.html libxml.spec.in: updated for the release * doc/*: regenerated but no API additions
Daniel Veillard 8effcb57 2016-05-09T10:31:09 Fix apibuild for a recently added construct commit c71f9305a99b6aa03cb08fab31106c9c56f1be4f added __XML_EXTERNC cpp construct which not understood by apibuild, leading to make dist failures, ask to ignore that construct.
Jan Pokorný 27aae651 2016-04-13T16:56:08 Fix typo: s{ ec -> cr }cipt Signed-off-by: Jan Pokorný <jpokorny@redhat.com>
Jan Pokorný bb654feb 2016-04-13T16:56:07 Fix typos: dictio{ nn -> n }ar{y,ies} Signed-off-by: Jan Pokorný <jpokorny@redhat.com>
David Kilzer c5ddd095 2016-01-20T20:41:44 Bug 760921: REGRESSION (8eb55d78): doc/examples/io1 test fails after fix for "xmlSaveUri() incorrectly recomposes URIs with rootless paths" <https://bugzilla.gnome.org/show_bug.cgi?id=760921> * doc/examples/io1.res: Update expected result.
Daniel Veillard 6657afe8 2015-11-20T17:55:11 Release of libxml2-2.9.3 * configure.ac: updated * doc/*: regenerated
Daniel Veillard 73b2d73d 2015-07-03T20:58:33 Avoid XSS on the search of xmlsoft.org query string need to be escaped before being displayed back
Daniel Veillard 726f67e2 2014-10-16T15:40:16 Release of libxml2-2.9.2
Daniel Veillard af62eb4f 2014-10-13T16:40:56 Python generator bug raised by the const change the doc methode for xmlDocGetRootElement wasn't generated anymore
Patrick Monnerat ea8c89b9 2014-03-04T16:13:34 doc/news.html: small update to avoid line join while generating NEWS.
Daniel Veillard 4e73bfae 2014-07-12T17:46:46 Fix a link to James SAX documentation old page
Daniel Veillard e59c244e 2013-12-11T00:01:38 Add limitations about encoding conversion
Daniel Veillard e38217ae 2013-05-10T15:40:13 Forgot to document 2.9.1 release, regenerate docs
Daniel Veillard f4e5a699 2013-04-19T15:36:36 Release of libxml2-2.9.1 * configure.in: bumped version * doc/*: updated the symbols file and regenerated
Roumen Petrov 4d7a3295 2012-11-23T23:30:49 rebuild docs:Makefile.am
Daniel Veillard 54ae471c 2013-04-01T16:37:05 Regenerated API, and testapi, rebuild documentation After the previous commit adding 2 new entry points
Daniel Veillard d8a75bff 2013-03-28T00:16:42 Converting apibuild.py to python3 not finished ....
Daniel Veillard 113384f1 2013-03-27T11:43:41 Add documentation for xmllint --xpath https://bugzilla.gnome.org/show_bug.cgi?id=694822 this wasn't documented in the man page, and there was a typo in xmllint help output.
Daniel Veillard f7aeda24 2013-03-23T10:31:26 Fix the URL of the SAX docuemntation from James as it has moved
Michael Wood fb27e2cd 2012-09-28T08:59:33 Fix spelling of "length".
Daniel Veillard 38bbd341 2012-09-11T15:00:08 Release of libxml2-2.9.0 * libxml.spec.in: update * doc/*: updated and regenerated * libxml2.syms testapi.c: regenerated
Daniel Veillard f8e3db04 2012-09-11T13:26:36 Big space and tab cleanup Remove all space before tabs and space and tabs at end of lines.
Daniel Veillard e00778b4 2012-09-08T21:09:26 Followup to LibXML2 docs/examples cleanup patch
Daniel Richard 878ec9db 2012-09-07T14:52:17 Second round of cleanups for LibXML2 docs/examples configure.am: * Explicitly disallow --enable-rebuild-docs when builddir != srcdir, per what you said about needing to build docs with an in-source build doc/Makefile.am: * Ensure that xmlversion.h is in the source tree before running apibuild.py, to avoid generating an incomplete libxml2-api.xml * Update the .PHONY target (forgot to do this earlier) doc/devhelp/Makefile.am: * Wrap the doc-generating rule in an "if REBUILD_DOCS" conditional so it doesn't cause trouble for regular users * Added a handy-dandy "rebuild" target doc/examples/index.py: * NOTE: You need to run this script to regenerate the files it creates, and then commit the newly-updated files! The generated files currently in git master (e.g. doc/examples/Makefile.am) are out of date even before this patch! * index.html really needs to be in EXTRA_DIST * Wrap the doc-generating rules in an "if REBUILD_DOCS" conditional, because they shouldn't be active otherwise
Daniel Veillard 857104cd 2012-09-04T14:25:23 Remove all .cvsignore as they are not used anymore For https://bugzilla.gnome.org/show_bug.cgi?id=682985 suggested by Adrian Bunk <bunk@stusta.de>
Vojtech Fried 3e031b7d 2012-08-24T16:52:44 Switching XPath node sorting to Timsort I use libxml xpath engine on quite large (and mostly "flat") xml files. It seems that Shellsort, that is used in xmlXPathNodeSetSort is a performance bottleneck for my case. I have read some posts about sorting in libxml in the libxml archive, but I agree that qsort was not the way to go. I experimented with Timsort instead and my results were good for me. For about 10000 nodes, my test was about 5x faster with Timsort, for 1000 nodes about 10% faster, for small data files, the difference was not measurable. * timsort.h: the algorithm, kept in a separate header * xpath.c: plug in the new algorithm in xmlXPathNodeSetSort * Makefile.am: add the header to the EXTRA_DIST * doc/apibuild.py: avoid indexing the new header
Daniel Veillard 82cdfc4e 2012-08-22T11:05:09 Expose xmlBufShrink in the public tree API As suggested by Andrew W. Nosenko: Proposal: expose the new xmlBufShrink() to the "public" API for compatibility with xmlBufUse(). Reason: the following scenario: 1. Read something into xmlParserInputBuffer (e.g. using xmlParserInputBufferRead()) 2. Extract content through xmlBufContent() 3. Extract content length through xmlBufUse(). Result have type 'size_t'. 4. Use this content 5. Now, you need to shrink the buffer. How to do it? Doing that through legacy xmlBufferShrink() is unsafe because it uses 'unsigned int' and the whole point of introducing the new API was handling the cases, when 'unsigned int' is not enough. Therefore, need to use the new xmlBufShrink(). But it is "private". Therefore, I propose to expose the new xmlBufShrink() in the same way, as xmlBufContent() and xmlBufUse() are exposed.
Daniel Richard G 6842ee81 2012-08-17T09:58:38 More cleanups to the documentation part of libxml2 doc/Makefile.am: * Build what's in doc/ before doc/devhelp/, as the dependency graph flows that way * Add "--path $(srcdir)" so that xsltproc can find DTDs in srcdir * Replaced $(top_srcdir)/doc with an equivalent $(srcdir) * Qualified libxml2-api.xml with $(srcdir) as it's always generated there * Rewrote the dependencies for libxml2-api.xml so that xmlversion.h doesn't throw everything off doc/devhelp/Makefile.am: * Use Automake constructs to install the HTML files instead of an install-data-local rule * Reorganized the file a bit (hello whitespace!) * EXTRA_DIST doesn't need to list so many files now that dist_devhelp_DATA is being used * Only print "Rebuilding devhelp files" if rebuilding is actually occurring doc/examples/index.py: * Make the "this file is auto-generated" banner more prominent * Autotools updates: Use AM_CPPFLAGS/AM_CFLAGS instead of INCLUDES * Got rid of DEPS as it's not needed (Automake already sees the dependency on libxml2.la by way of LDADD(S)) * Replaced LDADDS with LDADD, which is applied to all programs listed in the file. Since all the test programs have the same link dependencies, this way is more concise yet equivalent. * Remove the *.tmp files via "make clean" instead of having the test programs do it themselves (more on this later) * Invoke index.py in srcdir, as it pretty much needs to run there * Restructured the index.html rule so that only the xmllint invocation is allowed to fail * Use $(MKDIR_P) instead of $(mkinstalldirs), $(VAR) instead of @VAR@ * Remove symlinks for test?.xml in an out-of-source build * Sort lists for neatness * Better formatting for EXTRA_DIST and noinst_PROGRAMS variables * Simplified the Automake bits printed for each program: *_LDFLAGS doesn't need to be specified as it's empty anyway, *_DEPENDENCIES is redundant, *_LDADD isn't needed due to the global LDADD * Added a bit that symlinks in test?.xml from srcdir in out-of-source builds. This allows the reader4 test to read these files in the current directory, which ensures that the output always looks the same (i.e. does not contain references to srcdir) * Don't hide the test program invocation (or else it's hard to tell which test failed), and don't use superfluous parentheses * NOTE: If you check in these changes, be sure to run this script and also check in the updated files that it generates! doc/examples/*.c: * Updated the test: lines so that + "&&" is used to separate commands instead of ";" so that errors are not masked + reference files are qualified with $(srcdir)/ + no "rm" takes place -- these are a problem because (1) if a test fails, it's useful to have the output file ready for inspection; (2) the "rm" invocation masks a potential non-zero exit status from diff (This is why I added the CLEANFILES line above) doc/examples/io1.res: * Updated this ref file so that the test passes. (This is correct, right?) doc/examples/reader4.res: * Changed this back to its original form, as the symlinking of test?.xml means this file no longer has to contain path prefixes on the filenames doc/examples/testWriter.c: * Changed the output filenames to *.tmp instead of *.res, partly for consistency, partly to not have to add special cases to CLEANFILES doc/examples/xpath1.c: * Removed the "./" prefix on the test invocation, which is redundant as index.py already adds one
Daniel Veillard 64d11249 2012-08-15T09:10:50 Fix missing xmlsave.h module which was ignored in recent builds due to "save.h" rule discarding it too