doc


Log

Author Commit Date CI Message
Nick Wellnhofer e4091bcf 2023-09-21T22:54:57 doc: Allow 'unsigned' without 'int'
Nick Wellnhofer 46d7aaec 2023-09-21T22:54:30 doc: Add ignored tokens to apibuild.py
Nick Wellnhofer 9fc5090c 2023-09-16T19:58:42 hash: Clean up libxml/hash.h Rename variables, fix subincludes, whitespace.
Nick Wellnhofer 1117fae0 2023-09-20T19:20:41 include: Remove unneeded includes
Nick Wellnhofer a77f9ab8 2023-09-20T16:57:22 globals: Don't include SAX2.h from globals.h
Nick Wellnhofer ed3bd052 2023-08-20T20:48:10 parser: Allow to set maximum amplification factor
Nick Wellnhofer b463b38b 2023-04-30T16:19:28 .gitignore: Split up and rearrange .gitignore files
Nick Wellnhofer fc119e32 2023-04-30T15:28:12 examples: Don't call xmlCleanupParser and xmlMemoryDump xmlCleanupParser is dangerous and shouldn't be called in most cases. Being part of the examples led many people to use it incorrectly. xmlMemoryDump is an obsolete way to test for memory leaks.
Nick Wellnhofer 6e12409b 2023-04-26T21:21:31 Regenerate docs and testapi.c
Nick Wellnhofer 21cec82b 2023-03-10T17:25:44 win32: Remove broken libxml2.def.src Fixes #472.
Nick Wellnhofer bbb2b8f1 2023-01-17T16:08:06 Remove symbols from version script The version script didn't account for symbols disabled by configuration options. This has caused problems on some OSs in the past and breaks lld 16 which enables --no-undefined-version by default. A proper fix would be rather involved, so we simply remove all symbols from the version script. This is an ELF-only feature and libxml2 never made use of symbol versioning anyway. Ultimately, this removes the need for a lot of bookkeeping without tangible benefits. We have to keep the version nodes to avoid errors when running binaries linked against older versions of libxml2. Fixes #473.
Nick Wellnhofer 78c4430f 2022-12-22T00:03:10 doc: Remove ancient files
Nick Wellnhofer 785cfcff 2022-12-08T19:05:12 doc/libxml2-api.xml: Regenerate
Nick Wellnhofer ce9baf94 2022-12-08T02:48:27 Remove XMLCALL and XMLCDECL macros from public headers
Ross Burton 4762c856 2022-12-06T21:40:01 Use python3 not python As per https://peps.python.org/pep-0394/, the python binary can be one of the following options: - Python 2 - Python 3 - Not exist All of the scripts in libxml2 use 'python', which may not exist. As Python 2 reached EOL on the 1st January 2020, it's safe to move the scripts to use python3 explicitly.
Nick Wellnhofer b693905f 2022-11-04T14:50:39 doc: Remove xmlDllMain from documentation and version script This is a Windows-only symbol.
Nick Wellnhofer d48faf1a 2022-11-04T14:30:50 doc: Mention ${sysconfdir} in man pages Fixes #395.
Nick Wellnhofer 3ab57bf4 2022-11-04T14:25:23 doc: Document xmlcatalog --convert Fixes #417.
Nick Wellnhofer ae7096a1 2022-11-04T14:21:53 doc: Document xmllint --nodict and --pedantic Fixes #418.
Nick Wellnhofer 736487df 2022-11-04T14:17:01 doc: Fix indentation in source XML files
Nick Wellnhofer fec85df1 2022-09-06T18:50:23 xmllint: Document --quiet option
Nick Wellnhofer caef8563 2022-09-02T17:26:47 Move automata test to runtest.c
Nick Wellnhofer 1bd24d44 2022-09-02T17:59:09 Fix compiler warning in examples
Nick Wellnhofer 1660331b 2022-08-26T02:24:23 Remove xmlErrMemory from symbols This function was never publically declared.
Nick Wellnhofer 0f568c0b 2022-08-26T01:22:33 Consolidate private header files Private functions were previously declared - in header files in the root directory - in public headers guarded with IN_LIBXML - in libxml.h - redundantly in source files that used them. Consolidate all private header files in include/private.
Nick Wellnhofer 34a050cd 2022-08-24T16:35:58 Move some HTML functions to correct header file
Nick Wellnhofer ca3807d9 2022-08-24T15:55:46 Mark more functions setting globals as deprecated
Nick Wellnhofer e70b0c5e 2022-08-24T15:16:04 Rebuild documentation
Nick Wellnhofer 88637d42 2022-08-24T15:09:46 Improve cross-references in API docs Also cross-reference keywords followed by a period. This is still a hack but catches quite a few more keywords.
Nick Wellnhofer 6cdaa192 2022-08-24T14:34:04 Rebuild documentation
Nick Wellnhofer b33be8a0 2022-08-24T14:29:50 Switch back to HTML output for API documentation
Nick Wellnhofer 0e49f882 2022-08-24T05:25:37 Mark most SAX1 functions as deprecated No compiler warnings generated yet.
Nick Wellnhofer 9a82b94a 2022-08-24T04:21:58 Introduce xmlNewSAXParserCtxt and htmlNewSAXParserCtxt Add API functions to create a parser context with a custom SAX handler without having to mess with ctxt->sax manually.
Nick Wellnhofer 3513d76a 2022-08-24T02:18:50 Improve documentation of globals Document more global variables as deprecated. Some of the variables don't generate deprecation warnings yet, but they shouldn't be used in new code.
Nick Wellnhofer f703ed69 2022-08-24T01:29:49 Fix documentation parser Reset comment right after adding to the index.
Nick Wellnhofer bd6a4272 2022-08-24T00:17:51 Rebuild API documentation
Nick Wellnhofer 4f3eb8a3 2022-08-24T00:15:10 Support comments for global variables in documentation This was never implemented.
Nick Wellnhofer 288c951e 2022-08-24T00:12:59 Fix update call in apibuild.py There are still a few places where try/except is used for branching. This is a bad idea since it can hide errors like this one.
Nick Wellnhofer 92bb889b 2022-08-24T00:03:44 Don't index anything in DOC_DISABLE sections Somewhat misleadingly, the DOC_DISABLE directive only disabled warnings. Now we really stop the documentation generator from indexing. This results in additional warnings for xmlThrDef* functions. This should be fixed by documenting or deprecating them.
Nick Wellnhofer d54f829f 2022-08-19T11:28:49 Rebuild documentation
Nick Wellnhofer 18d79460 2022-08-18T21:03:56 Port doc/examples/index.py to Python 3 - Make sure that examples.xml is generated deterministically - Sort includes by line number
Nick Wellnhofer a7af2c99 2022-08-18T20:03:07 Fix order of exports in libxml2-api.xml The values passed to the `uniq` function are dictionary keys and should already be unique. On older Python versions, this would reshuffle the list after it had just been sorted.
Nick Wellnhofer f82b56c6 2022-08-18T19:51:33 Remove libxml2-refs.xml The cross-reference was only used by the old website.
Nick Wellnhofer d20df9d8 2022-08-17T12:01:04 Cleanup files generated by test suite Fixes make distcheck.
Nick Wellnhofer 4e494b9c 2022-08-17T12:00:40 Add uninstall target for examples Fixes make distcheck.
Nick Wellnhofer 229fe8f1 2022-08-17T11:41:23 Rebuild documentation
Nick Wellnhofer 24323d31 2022-08-17T11:39:55 Don't autogenerate doc/examples/Makefile.am
Nick Wellnhofer 3e7b4f37 2022-05-20T23:28:25 Avoid calling xmlSetTreeDoc Create text nodes with xmlNewDocText or set the document directly to avoid xmlSetTreeDoc being called when the node is inserted.
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.