Skip to content

Latest commit

 

History

History
31 lines (24 loc) · 2.01 KB

README.md

File metadata and controls

31 lines (24 loc) · 2.01 KB

Transforms

Build Status GitHub issues Open license

This poorly named transforms project (should really be called 'commons' or something similiar as it is meant to be used as a submodule to other CC projects), contains 5 basic file types (and one subproject) that are common resources to various protection profile projects.

The 5 types are:

  • XSL files which are housed in the xsl directory. These are primarily XSL files, but also contain XML files.
  • Python3 files which are are housed in the py directory.
  • Make files which are in the root directory and also other directories.
    Unlike the *.make files which build various projects, the Makefile only builds the schema documentation and you shouldn't need to access it. Helper.make contains the vast majority of the the building logic.
  • RelaxNG Schema Files which are housed in the schemas directory, which defines, roughly, the structure of an input file, and
  • Dictionary files, in the dictionaries directory, which include various lists of words that are frequently used by protection profiles but not recognized by hunspell, a spell checker we use.

It also contains a subproject, rng-to-html, in the schemas directory and it is used by executing the shell script in the bin directory. It uses xsltproc to transform a RelaxNG schema (hopefully with annotations), to a clickable, javadoc-style reference.

Links

Help working with Transforms Submodule

License

See License

Team Discussions

The team the governs the transforms project is the transforms team