[gentoo-dev] XML Schema files for metadata.xml, projects.xml and repositories.xml, for review and testing

[Michał Górny]

Hello, everyone.

As you may be aware, we were considering replacing the DTD files for
our XML documents with a more modern and more complete format. As part
of considering options for this, I've written XML Schema files [1] that
provide a more correct replacement for the current DTD files and I'd
like you to review it.

XML Schema not only allows us to express our data formats more
correctly than DTD but also gives some degree of value checks.
In particular, it finds a number of existing issues that DTD can't
find.

For example:

  $ xmllint --noout --schema projects.xsd projects.xml
  projects.xml:864: element project: Schemas validity error : Element
  'project': Duplicate key-sequence ['desktop-misc@g.o'] in key
  identity-constraint 'projectKey'. projects.xml fails to validate

which means there are two projects using the same e-mail address
(and therefore being ambiguous for metadata references).

Aside to the usual structure errors, my schemas find:

- duplicate keys (project e-mails, repository names),

- duplicate supposedly-unique values (like duplicate
  <longdescription/>s in the same language),

- some data well-formedness errors (e.g. <pkg/> tags referencing
  things that are not correct qualified package names),

- some random weirdnesses (like using multiple <use/> blocks for
  flags, for no good reason).

I should note that I've based those schemas on existing DTDs, PMS
and some understanding guesswork, so they may be over- or understrict.
If someone can provide better PMS-y package name regexps, I'd
appreciate.

Please test and review. I'm going to reply to this mail with the list
of current metadata.xml validation failures (it's quite long).

[1]:https://github.com/mgorny/gentoo-xml-schema

-- 
Best regards,
Michał Górny
<http://dev.gentoo.org/~mgorny/>