[LTP] [PATCH v3 1/2] doc: generate CVE catalog documentation

[Petr Vorel]

Hi,

...
> > The implementation:
> > - Parses runtest/cve to extract CVE IDs, test names, and options
> > - Generates a single CVE catalog file (_static/cves.rst) containing:

> Please use just 'cve.rst' instead of 'cves.rst'. The plural is not
> providing any info here.

+1

> > +def generate_cve_catalog(_):
> > +    """
> > +    Generate CVE catalog in a single file. Parse runtest/cve file and
> > +    generate documentation with links to CVE databases and test sources.
> > +    Similar to test_catalog, creates a single _static/cves.rst file with
> > +    all CVE information.
> > +    """
> > +    output = '_static/cves.rst'
> > +    runtest_cve = '../runtest/cve'
> > +
> > +    # Parse runtest/cve file
> > +    cve_data = {}
> > +    cve_pattern = re.compile(r'^(cve-(\d{4})-\d+)\s+(\S+)(?:\s+(.*))?$')

> Do we need a regexp for this? The runtest file is well defining the
> following structure:

>   <cve-id> <binary> <arg0> <arg1> ..

> We only need to split lines which are not starting with # char,
> considering space as separator.

+1

...
> What about generating only a simple reference table? There are only 3
> information we need: CVE ID, test binary, year.

> | ID | Test name | Year |
> -------------------------
> | .. |    ..     |  ..  |

Do we need year in a column at all? If we like separating by year, we can make
more tables each being just for a particular year.

> etc..

> There's no need to have a direct link to the CVE, since we already pointing
> CVE to the Test catalog anyway.

OTOH it would not harm (people interested at CVE will have look mostly on this
page, that would save them one click.

Kind regards,
Petr