[LTP] [PATCH 1/1] doc/cve_catalog: Link CVE to www.cve.org

[Sachin Sant]

On 11/05/26 12:38 pm, Petr Vorel wrote:
> Although test_catalog page links to www.cve.org, it's more convenient for
> readers to have that link also on page dedicated to CVEs.
>
> While at it, change warning to note (it's really an info, nothing to
> warn about).
>
> Follow-up: 79396c7b71 ("doc: Add CVE catalog to documentation")
> Signed-off-by: Petr Vorel <pvorel@suse.cz>
> ---
> Hi Sachin, Andrea,
>
> thanks a lot for implementing the CVE list page. Very simple change to
> it but I prefer not to modify the page without your ack.
I am okay with this change. In-fact I had this change included in one of the
intermediate versions of the CVE catalog patch.

Based on review comments (The CVE link is present in corresponding test 
catalog
page) it was later removed

> Kind regards,
> Petr
>
>   doc/conf.py | 9 ++++++---
>   1 file changed, 6 insertions(+), 3 deletions(-)
>
> diff --git a/doc/conf.py b/doc/conf.py
> index 668cb4d980..591c1534df 100644
> --- a/doc/conf.py
> +++ b/doc/conf.py
> @@ -19,6 +19,7 @@ author = 'Linux Test Project'
>   release = '1.0'
>   ltp_repo = 'https://github.com/linux-test-project/ltp'
>   ltp_repo_base_url = f"{ltp_repo}/tree/master"
> +cve_url = "https://www.cve.org/CVERecord?id="
>   
>   # -- General configuration ---------------------------------------------------
>   # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
> @@ -293,7 +294,7 @@ def _generate_tags_table(tags):
>           "linux-stable-git": "https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/commit/?id=",
>           "glibc-git": "https://sourceware.org/git/?p=glibc.git;a=commit;h=",
>           "musl-git": "https://git.musl-libc.org/cgit/musl/commit/src/linux/clone.c?id=",
> -        "CVE": "https://www.cve.org/CVERecord?id=CVE-",
> +        "CVE": cve_url + 'CVE-',
>       }
>   
>       table = [
> @@ -586,7 +587,7 @@ def generate_cve_catalog(_):
>       # Generate single CVE catalog file
>       total_cves = len(cve_data)
>       text = [
> -        '.. warning::',
> +        '.. note::',
>           '    The following CVE catalog has been generated from test',
>           '    metadata and includes all CVE reproducers in LTP.',
>           '',
> @@ -614,8 +615,10 @@ def generate_cve_catalog(_):
>           # Join multiple tests with commas
>           tests_str = ', '.join(test_links)
>   
> +        cve_link = f'`{cve_id} <{cve_url}{cve_id}>`_'
> +
>           text.extend([
> -            f'   * - {cve_id}',
> +            f'   * - {cve_link}',
>               f'     - {tests_str}',
>           ])
>   

-- 
Thanks
- Sachin