1
0
mirror of https://gitlab.gnome.org/GNOME/libxml2.git synced 2024-10-26 12:25:09 +03:00

doc: Update MAINTAINERS and NEWS

This commit is contained in:
Nick Wellnhofer 2023-09-22 15:46:11 +02:00
parent 84e1ffc813
commit d94f0b0ba2
2 changed files with 57 additions and 4 deletions

View File

@ -1,14 +1,34 @@
# Maintainer's Guide
## Generated files
The documentation and other generated files can be rebuilt by running
make -C doc rebuild
This requires `xsltproc`, the DocBook stylesheets in your XML Catalog
and the libxml2 Python bindings to be installed, so it's best done on a
Linux system. On Debian/Ubuntu, try
apt install xsltproc python3-libxml2 docbook-xsl docbook-xml
doc/apibuild.py generates doc/libxml2-api.xml which is used to generate
- API documentation with XSLT stylesheets
- testapi.c with gentest.py
- Python bindings with python/generator.py
Man pages and HTML documentation for xmllint and xmlcatalog are
generated with xsltproc and DocBook stylesheets.
## Making a release
### Rebuild generated files and documentation
The documentation and some generated files can be rebuilt by running
See above for details and run `make -C doc rebuild`.
make -C doc rebuild
This requires `xsltproc` and the libxml2 Python bindings to be installed.
Look for new warning messages and inspect changes for correctness
before committing.
### Update the NEWS file

33
NEWS
View File

@ -1,5 +1,38 @@
NEWS file for libxml2
v2.12.0: not released yet
### Major changes
Starting with this release, it should be enough to add the --with-legacy
configuration option to provide maximum ABI compatibility. For example,
if a code module was removed from the default configuration, the option
will add stubs for the removed symbols.
libxml2 will now store global variables in thread-local storage if supported
by the compiler. This avoids allocating the data lazily which can result in
a fatal error condition. A new API function xmlCheckThreadLocalStorage
was added so the allocation can be checked earlier.
Several cyclic dependencies in public header files were fixed. As a result,
certain headers won't include other headers as before.
Refactoring of the encoding code has been mostly completed. Calling
xmlSwitchEncoding from client code is now fully supported, for example to
override the encoding for the push parser.
When parsing data from memory, libxml2 will now stream data chunk by chunk
instead of copying the whole buffer (possibly twice with encodings),
reducing peak memory consumption considerably.
A new API function xmlCtxtSetMaxAmplification was added to allow parsing
of files that would otherwise trigger the billion laughs protection.
Several bugs in the regex determinism checks were fixed. Invalid XML
Schemas which previous versions erroneously accepted will now be
rejected.
v2.11.0: Apr 28 2023
### Major changes