README.adoc
1// Copyright 2014-2021 The Khronos Group Inc.
2//
3// SPDX-License-Identifier: CC-BY-4.0
4
5= Vulkan^(R)^ Specification Repository Scripts
6
7This directory contains scripts used in building the Vulkan API
8specification and related artifacts. For the most part, these scripts are
9invoked from the top-level directory or from the API Registry in
10../xml to build generated components of the specification.
11
12Scripts in this directory include:
13
14 * `genvk.py` - Python script to generate Vulkan headers and some other
15 targets, using the generators described below.
16 * `reg.py` - Python tools to read a registry XML file and call into
17 generators to create headers and other types of output.
18 * `conventions.py`, `vkconventions.py` - API-specific parameters and
19 formatting / style conventions used by generators.
20 * `generator.py` - output generator base class.
21 ** `cgenerator.py` - C header output generator.
22 ** `docgenerator.py` - Asciidoc interface language include generator.
23 ** `extensionmetadocgenerator.py` - Generator for Asciidoc extension
24 descriptions in spec appendices.
25 ** `hostsyncgenerator.py` - Asciidoc host sync table generator.
26 ** `pygenerator.py` - Generates python encoding of the API description.
27 ** `validitygenerator.py` - Asciidoc validity language generator.
28
29 * `check_spec_links.py` - validates a variety of markup and content in the
30 Asciidoctor specification source.
31 * `make_ext_dependency.py` - generate extension dependencies in Bash and
32 Python form for use when building the specification.
33 * `genRelease`, `genspec.py` - build HTML and PDF Specifications with a
34 variety of options to control target directories, extensions included
35 while building, etc.
36 * `genRef.py`, `reflib.py` - extract API reference pages from specification
37 source into single-page source documents.
38 * `indexExt.py` - generate HTML index of all extensions for inclusion into
39 the Vulkan registry index page.
40 * `reflow.py`, `reflow_count.py` - reflow specification source text to follow
41 style guidelines, and insert Valid Usage statements where they're
42 needed.
43 * `test_check_spec_links.py`, `test_check_spec_links_api_specific.py`,
44 `test_entity_db.py` - these are from another Khronos WG repository and
45 are unused by Vulkan at present.
46
47 * `compImages.sh` - compare images in two branches.
48 * `htmldiff/htmldiff` - HTML diff script (see below).
49 * `Retired/` - contains obsolete, unused, or single-purpose scripts. Not
50 maintained.
51
52HTML Diff Script for Vulkan
53===========================
54
55This is a first cut at a script to compare Vulkan HTML specifications. Usage
56is simply 'htmldiff file1.html file2.html > diff.html'. The script does not
57copy CSS and images required by the input specs, so it's best to generate
58the output in the same directory as one of the inputs. However, the script
59must be invoked from the directory it is located within.
60
61The scripts used require Python and Perl. Additionally, the python
62'utidylib' module and the underlying libtidy C library are required.
63On Debian Linux, it may be necessary to install the 'python-utidylib' and
64'libtidy' packages if they are not already present.
65
66The scripts are taken from the code backing the
67
68 http://services.w3.org/htmldiff
69
70website. `htmldiff` is the Python driver script. `htmldiff.pl` is the
71Perl script which generates the diff after preprocessing of the input
72HTML by `htmldiff`. `htmldiff.orig` is the original Python script from
73the website, modified to run at the command line instead of as a CGI
74script.
75
README.md
1HTML Diff Script for Vulkan
2===========================
3
4This is a first cut at a script to compare Vulkan HTML specifications. Usage
5is simply 'htmldiff file1.html file2.html > diff.html'. The script does not
6copy CSS and images requires by the input specs, so it's best to generate
7the output in the same directory as one of the inputs.
8
9The scripts used require Python and Perl. Additionally, the python
10'utidylib' module and the underlying libtidy C library are required,
11which may make it challenging to run the scripts on non-Linux platforms
12- I haven't checked and those requirements cannot be easily removed. On
13Debian Linux, it may be necessary to install the 'python-utidylib' and
14'libtidy' packages if they are not already present. I haven't checked
15dependencies for other Linux distributions but they are probably
16similar.
17
18The scripts are taken from the code backing the
19
20 http://services.w3.org/htmldiff
21
22website. 'htmldiff' is the Python driver script. 'htmldiff.pl' is the
23Perl script which generates the diff after preprocessing of the input
24HTML by 'htmldiff'. 'htmldiff.orig' is the original Python script from
25the website, modified to run at the command line instead of as a CGI
26script.
27