[igt-dev] [PATCH i-g-t v2 2/2] testplan: build also a PDF file with the testplan

[Kamil Konieczny]

Hi Mauro,

On 2023-03-20 at 09:45:00 +0100, Mauro Carvalho Chehab wrote:
> From: Mauro Carvalho Chehab <mchehab at kernel.org>
> 
> PDF files are easier to share, and it costs almost nothing to
> produce them with Sphinx using rst2pdf. So, add support for it,

s/So, add/Added/
s/it,/it/

> if rst2pdf is installed.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab at kernel.org>
> ---
>  docs/testplan/meson.build | 27 ++++++++++++++++++++++-----
>  1 file changed, 22 insertions(+), 5 deletions(-)
> 
> diff --git a/docs/testplan/meson.build b/docs/testplan/meson.build
> index 11c08573307e..65bb6c31cd65 100644
> --- a/docs/testplan/meson.build
> +++ b/docs/testplan/meson.build
> @@ -4,6 +4,7 @@ build_testplan = get_option('testplan')
>  build_sphinx = get_option('sphinx')
>  
>  rst2html = find_program('rst2html-3', 'rst2html', required : build_testplan)
> +rst2pdf = find_program('rst2pdf')
>  sphinx = find_program('sphinx-build', required: build_sphinx)
>  
>  stylesheet = meson.current_source_dir() + '/testplan.css'
> @@ -46,14 +47,30 @@ if sphinx.found()
>                                  )
>  
>          custom_target('index.html',
> -                    build_by_default : true,
> -                    command : [ 'sphinx-build', '-c', meson.current_source_dir(), meson.current_build_dir(), sphinx_out_dir],
> -                    input : index_rst,
> -                    output : 'index.html'
> -                    )
> +                      build_by_default : true,
> +                      command : [ 'sphinx-build', '-c', meson.current_source_dir(),
> +                      meson.current_build_dir(), sphinx_out_dir],
> +                      input : index_rst,
> +                      output : 'index.html'
> +                      )
> +    endif

Please do not touch unrelated lines.

> +
> +    if rst2pdf.found()
> +        sphinx_out_pdf = meson.current_build_dir() + '/pdf'
> +
> +        custom_target('xe_tests.pdf',
> +                      build_by_default : true,
> +                      command : [ 'sphinx-build', '-c', meson.current_source_dir(),
> +                      '-b', 'pdf',
> +                      '-D', 'version=' + meson.project_version(),
> +                      meson.current_build_dir(), sphinx_out_pdf],
> +                      input : index_rst,
> +                      output : 'xe_tests.pdf'
> +                      )

It seemd build fails when no rst2pdf is present:

Program rst2pdf found: NO

docs/testplan/meson.build:7:0: ERROR: Program 'rst2pdf' not found or not executable

Regards,
Kamil

>      endif
>  endif
>  
>  build_info += 'Build ReST test documentation: @0@'.format(igt_doc_script.found())
>  build_info += 'Build simple html testplan documentation: @0@'.format(rst2html.found())
>  build_info += 'Build indexed html testplan documentation: @0@'.format(sphinx.found())
> +build_info += 'Build pdf testplan documentation: @0@'.format(sphinx.found() and rst2pdf.found())
> -- 
> 2.39.2
>