1
0
mirror of https://gitlab.gnome.org/GNOME/libxml2.git synced 2024-12-24 21:33:51 +03:00
libxml2/MAINTAINERS.md

119 lines
3.4 KiB
Markdown
Raw Normal View History

2022-08-26 15:50:21 +03:00
# Maintainer's Guide
## Working with the test suite
Most of the tests are contained in the `runtest` executable which
generally reads test cases from the `test` directory and compares output
to files in the `result` directory.
You can simply add new test cases and run `runtest -u` to update the
results. If you debug test failures, it's also useful to execute
`runtest -u` and then `git diff result` to get a diff between actual and
expected results. You can restore the original results by running
`git restore result` and `git clean -xd result`.
2023-09-22 16:46:11 +03:00
## 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.
2022-08-26 15:50:21 +03:00
## Making a release
### Rebuild generated files and documentation
2023-09-22 16:46:11 +03:00
See above for details and run `make -C doc rebuild`.
2023-09-22 16:46:11 +03:00
Look for new warning messages and inspect changes for correctness
before committing.
2022-08-26 15:50:21 +03:00
### Update the NEWS file
You can get started by running
git log --format='- %s (%an)' [previous-release-tag]..
2022-08-26 15:50:21 +03:00
### Bump the version number
Edit the version number in `configure.ac` if you haven't done so already.
2022-08-26 15:50:21 +03:00
### Build the tarball
I'd recommend to build the tarball by running
make distcheck
which performs some useful checks as well.
2022-08-26 15:50:21 +03:00
### Upload the tarball
Follow the instructions at
<https://wiki.gnome.org/MaintainersCorner/Releasing>:
scp libxml2-[version].tar.xz master.gnome.org:
ssh master.gnome.org ftpadmin install libxml2-[version].tar.xz
2022-08-26 15:50:21 +03:00
### Tag the release
Create an annotated tag and push it:
git tag -a [version] -m 'Release [version]'
git push origin [version]
2022-08-26 15:50:21 +03:00
### Create a GitLab release
Create a new GitLab release on
<https://gitlab.gnome.org/GNOME/libxml2/-/releases>.
2022-08-26 15:50:21 +03:00
### Announce the release
2024-04-30 18:00:01 +03:00
Announce the release on https://discourse.gnome.org under topics 'libxml2'
and 'announcements'.
## Breaking the ABI
Unfortunately, libxml2 exposes many internal structs which makes some
beneficial changes impossible without breaking the ABI.
The following changes are allowed (after careful consideration):
- Appending members to structs which client code should never allocate
directly. A notable example is xmlParserCtxt. Other structs like
xmlError are allocated directly by client code and must not be changed.
- Making a void function return a value.
- Making functions accept const pointers unless it's a typedef for a
callback.
- Changing signedness of struct members or function arguments.
2022-08-26 15:50:21 +03:00
## Updating the CI Docker image
2024-03-22 20:12:25 +03:00
Note that the CI image is used for libxslt as well. First create a
GitLab access token with `read_registry` and `write_registry`
permissions. Then run the following commands with the Dockerfile in the
.gitlab-ci directory:
2022-08-26 15:50:21 +03:00
2024-03-22 20:12:25 +03:00
docker login -u <username> -p <access_token> \
registry.gitlab.gnome.org
docker build -t registry.gitlab.gnome.org/gnome/libxml2 - \
< .gitlab-ci/Dockerfile
2022-08-26 15:50:21 +03:00
docker push registry.gitlab.gnome.org/gnome/libxml2