|I have a problem and I think I know how to fix it. How can I
communicate my ideas to the Xerces team?
To maximize the probability that your ideas will grab the
attention of one of the Xerces developers who knows about the
area of the parser you're concerned with, you should follow
- Check out and build the most recent Xerces code. For
instructions on how to do this, see the
Source Repository page. If you do this, you can confirm that your
bug still exists and has not been fixed since the last
Write up your bug report. Include a description of your
system (JDK level and vendor, platform and classpath
contents) as well as sufficient code to reproduce the
problem. This code might involve XML documents,
accompanying grammars, and the code you are using to
invoke the parser or use its APIs.
Describe why your solution works.
Prepare a patch to fix Xerces code. To do this, when you
have applied your changes to a local copy of the most
recent xerces source code, do
file for each file you've changed.
Zip (or tar) up your patches. If you send them in the
body of a message or bug report they are very difficult to
Submit a bug report on JIRA
(remembering to attach your patches and test code)
or, if you think your patch might need some discussion,
post it to the email@example.com list.
|I am a recent committer. It has fallen to my lot to prepare a Xerces-J
release; how do I do this?
You're in luck--it isn't at all difficult. Just
follow these steps and you'll be done in no time:
- Ensure that the API code has been properly refreshed.
That is, make sure that
tools/xml-apis--src.zip reflect the
state of the branch of xml-commons that contains the API
set to which the parser must conform. At the time of
writing (September 2, 2007) this was the main
- Change the following files:
(that is, change the
parser_version properties as appropriate for the
(contributors should have updated this file as significant
changes/patches were applied, but the release manager should verify that
nothing has slipped through.
Also, the release manager should attempt to ensure that appropriate
credit has been given for contributions).
- Tag the release in SVN
(tags for releases usually have the form Xerces-J_x_y_z
where x.y.z is the Xerces-J release number)
You should also tag the current branch of xml-commons
containing the APIs that the parser needs to conform
to; see step 1 above.
- Do a test build and regression test run;
build test at a bare minimum.
In general, apply as many test suites (OASIS XML
tests, W3C DOM and Schema tests etc.) as are
available, particularly with a view to preventing
regressions since the previous release.
- Do the final build based on that tag:
windows build to produce
unix build (on a unix machine to make sure no 0x0d's
appear in documentation of
packages. Beware to do the build from within
X-windows to avoid problems with StyleBook on the
- zip and tar the tools directory
Generate PGP/GNUPG signatures for dist binaries:
That is, add public key to the SVN
KEYS file if necessary
and make sure public key is on a key server or two.
- Upload the binaries and signatures to the dist section of
which directs the user to the most recent release. Take
care to move old packages to the
directory so that the package listing is manageable.
- Prepare release e-mail -- be sure to give contributors
credit for their work
- Send the release e-mail to the xerces-j lists, firstname.lastname@example.org and,
if it's a big enough release, email@example.com and
Firstly, create new release. Then,
remove oldest release (if we are up-to 6
Upload generated docs directory to minotaur (until this process
matures and becomes SVN-based).
/www/xerces.apache.org/xerces2-j to SVN;
i.e., update the xml-site module.