Skip to contentSkip to conversation

meson: Make doc building dependent on gtk-doc

PATCH In review Arkadiusz Hiler 3 participants 6 messages Feb 27, 2019 – Feb 28, 2019 Arm/Amlogic Meson SoC support

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 meson: Make doc building dependent on gtk-doc

Currently, when gtk-doc is not installed 'ninja' succeeds but 'ninja install' fails with the following error:

FileNotFoundError: [Errno 2] No such file or directory: 'gtkdoc-scan': 'gtkdoc-scan'

With this patch 'meson build' will log that documentations would not build and 'ninja install' will succeed.

When forcing building docs with 'meson -Dbuild_docs=true build' the following error will occur instead:

meson.build:323:0: ERROR: Dependency "gtk-doc" not found, tried pkgconfig and cmake

---
 meson.build | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
meson.build +3 -1
index 099db897..557400a5 100644
@@ -320,9 +320,11 @@ endif
 subdir('overlay')
 subdir('man')
 
+gtk_doc = dependency('gtk-doc', required : _docs_required)
+
 docs_info = 'No'
 if _build_docs
-	if _build_tests
+	if _build_tests and gtk_doc.found()
 		subdir('docs')
 		docs_info = 'Yes'
 	elif _docs_required
Signature · 6 lines
2.20.1

_______________________________________________
igt-dev mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/igt-dev
#1 lore raw

[igt-dev] ✓ Fi.CI.BAT: success for meson: Make doc building dependent on gtk-doc

== Series Details ==

== Series Details ==

Series: meson: Make doc building dependent on gtk-doc
URL : https://patchwork.freedesktop.org/series/57309/
State : success

== Summary ==

CI Bug Log - changes from CI_DRM_5666 -> IGTPW_2533
====================================================

Summary
-------

**SUCCESS**

No regressions found.

External URL: https://patchwork.freedesktop.org/api/1.0/series/57309/revisions/1/

Known issues
------------

Here are the changes found in IGTPW_2533 that come from known issues:

### IGT changes ###

#### Issues hit ####

* igt@kms_busy@basic-flip-a:
- fi-gdg-551: PASS -> FAIL [fdo#103182]

* igt@kms_psr@primary_mmap_gtt:
- fi-blb-e6850: NOTRUN -> SKIP [fdo#109271] +27

#### Possible fixes ####

* igt@i915_selftest@live_execlists:
- fi-apl-guc: INCOMPLETE [fdo#103927] / [fdo#109720] -> PASS

* igt@kms_pipe_crc_basic@suspend-read-crc-pipe-b:
- fi-blb-e6850: INCOMPLETE [fdo#107718] -> PASS

* igt@prime_vgem@basic-fence-flip:
- fi-gdg-551: FAIL [fdo#103182] -> PASS

[fdo#103182]: https://bugs.freedesktop.org/show_bug.cgi?id=103182
[fdo#103927]: https://bugs.freedesktop.org/show_bug.cgi?id=103927
[fdo#107718]: https://bugs.freedesktop.org/show_bug.cgi?id=107718
[fdo#109271]: https://bugs.freedesktop.org/show_bug.cgi?id=109271
[fdo#109720]: https://bugs.freedesktop.org/show_bug.cgi?id=109720

Participating hosts (44 -> 38)
------------------------------

Missing (6): fi-ilk-m540 fi-hsw-4200u fi-byt-squawks fi-bsw-cyan fi-ctg-p8600 fi-icl-y

Build changes
-------------

* IGT: IGT_4860 -> IGTPW_2533

CI_DRM_5666: 358ab8acaabef3cef2a7ce9e5dd7c4196a0c30fc @ git://anongit.freedesktop.org/gfx-ci/linux
IGTPW_2533: https://intel-gfx-ci.01.org/tree/drm-tip/IGTPW_2533/
IGT_4860: b79007f9c575a538a63ce9301a890ed9e1a45f35 @ git://anongit.freedesktop.org/xorg/app/intel-gpu-tools

== Logs ==

For more details see: https://intel-gfx-ci.01.org/tree/drm-tip/IGTPW_2533/
_______________________________________________
igt-dev mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/igt-dev

#2 lore raw

[igt-dev] ✗ Fi.CI.IGT: failure for meson: Make doc building dependent on gtk-doc

In reply to Arkadiusz Hiler
== Series Details ==

== Series Details ==

Series: meson: Make doc building dependent on gtk-doc
URL : https://patchwork.freedesktop.org/series/57309/
State : failure

== Summary ==

CI Bug Log - changes from CI_DRM_5666_full -> IGTPW_2533_full
====================================================

Summary
-------

**FAILURE**

Serious unknown changes coming with IGTPW_2533_full absolutely need to be verified manually.

If you think the reported changes have nothing to do with the changes introduced in IGTPW_2533_full, please notify your bug team to allow them to document this new failure mode, which will reduce false positives in CI.

External URL: https://patchwork.freedesktop.org/api/1.0/series/57309/revisions/1/

Possible new issues
-------------------

Here are the unknown changes that may have been introduced in IGTPW_2533_full:

### IGT changes ###

#### Possible regressions ####

* igt@kms_flip@flip-vs-suspend-interruptible:
- shard-hsw: PASS -> DMESG-WARN

* igt@runner@aborted:
- shard-hsw: NOTRUN -> FAIL

Known issues
------------

Here are the changes found in IGTPW_2533_full that come from known issues:

### IGT changes ###

#### Issues hit ####

* igt@gem_ctx_isolation@rcs0-s3:
- shard-kbl: NOTRUN -> INCOMPLETE [fdo#103665]

* igt@gem_eio@wait-wedge-10ms:
- shard-snb: PASS -> INCOMPLETE [fdo#105411] +1

* igt@gem_mmap_gtt@basic-write-cpu-read-gtt:
- shard-glk: NOTRUN -> SKIP [fdo#109271] +16

* igt@gen3_render_tiledx_blits:
- shard-snb: NOTRUN -> SKIP [fdo#109271] +31

* igt@i915_suspend@fence-restore-tiled2untiled:
- shard-kbl: PASS -> INCOMPLETE [fdo#103665]

* igt@kms_busy@basic-modeset-f:
- shard-apl: NOTRUN -> SKIP [fdo#109271] / [fdo#109278]

* igt@kms_busy@extended-modeset-hang-newfb-with-reset-render-a:
- shard-hsw: PASS -> DMESG-WARN [fdo#107956]

* igt@kms_busy@extended-modeset-hang-newfb-with-reset-render-b:
- shard-kbl: PASS -> DMESG-WARN [fdo#107956]
- shard-snb: PASS -> DMESG-WARN [fdo#107956]

* igt@kms_busy@extended-modeset-hang-newfb-with-reset-render-e:
- shard-glk: NOTRUN -> SKIP [fdo#109271] / [fdo#109278]

* igt@kms_busy@extended-modeset-hang-oldfb-render-e:
- shard-kbl: NOTRUN -> SKIP [fdo#109271] / [fdo#109278] +5

* igt@kms_busy@extended-pageflip-modeset-hang-oldfb-render-a:
- shard-apl: PASS -> DMESG-WARN [fdo#107956]

* igt@kms_ccs@pipe-a-crc-sprite-planes-basic:
- shard-glk: PASS -> FAIL [fdo#108145]

* igt@kms_ccs@pipe-c-missing-ccs-buffer:
- shard-apl: NOTRUN -> SKIP [fdo#109271] +33

* igt@kms_color@pipe-a-gamma:
- shard-kbl: PASS -> FAIL [fdo#104782] +1

* igt@kms_color@pipe-a-legacy-gamma:
- shard-glk: PASS -> FAIL [fdo#104782] / [fdo#108145]

* igt@kms_color@pipe-c-degamma:
- shard-apl: PASS -> FAIL [fdo#104782]

* igt@kms_cursor_crc@cursor-128x128-dpms:
- shard-kbl: PASS -> FAIL [fdo#103232]

* igt@kms_cursor_crc@cursor-128x42-sliding:
- shard-apl: PASS -> FAIL [fdo#103232] +3

* igt@kms_cursor_legacy@2x-long-cursor-vs-flip-atomic:
- shard-hsw: PASS -> FAIL [fdo#105767]

* igt@kms_flip@modeset-vs-vblank-race-interruptible:
- shard-glk: PASS -> FAIL [fdo#103060]

* igt@kms_frontbuffer_tracking@fbc-1p-primscrn-cur-indfb-onoff:
- shard-kbl: PASS -> FAIL [fdo#103167]

* igt@kms_frontbuffer_tracking@fbc-1p-primscrn-spr-indfb-draw-mmap-cpu:
- shard-apl: PASS -> FAIL [fdo#103167] +3

* igt@kms_frontbuffer_tracking@fbc-1p-rte:
- shard-glk: PASS -> FAIL [fdo#103167] / [fdo#105682]

* igt@kms_frontbuffer_tracking@fbc-2p-primscrn-spr-indfb-draw-mmap-cpu:
- shard-glk: PASS -> FAIL [fdo#103167] +6

* igt@kms_frontbuffer_tracking@psr-1p-offscren-pri-indfb-draw-mmap-wc:
- shard-kbl: NOTRUN -> SKIP [fdo#109271] +58

* igt@kms_plane@pixel-format-pipe-c-planes-source-clamping:
- shard-glk: PASS -> FAIL [fdo#108948]

* igt@kms_plane@plane-position-covered-pipe-a-planes:
- shard-glk: PASS -> FAIL [fdo#103166] +2

* igt@kms_plane@plane-position-covered-pipe-c-planes:
- shard-kbl: PASS -> FAIL [fdo#103166] +1

* igt@kms_plane_alpha_blend@pipe-c-alpha-7efc:
- shard-kbl: NOTRUN -> FAIL [fdo#108145] / [fdo#108590]

* igt@kms_plane_alpha_blend@pipe-c-alpha-transparant-fb:
- shard-glk: NOTRUN -> FAIL [fdo#108145]

* igt@kms_plane_alpha_blend@pipe-c-constant-alpha-max:
- shard-kbl: NOTRUN -> FAIL [fdo#108145]

* igt@kms_plane_alpha_blend@pipe-c-coverage-7efc:
- shard-snb: NOTRUN -> SKIP [fdo#109271] / [fdo#109278] +1

* igt@kms_plane_multiple@atomic-pipe-c-tiling-yf:
- shard-apl: PASS -> FAIL [fdo#103166] +3

* igt@kms_rotation_crc@multiplane-rotation-cropping-bottom:
- shard-kbl: PASS -> DMESG-FAIL [fdo#105763]

* igt@kms_rotation_crc@multiplane-rotation-cropping-top:
- shard-kbl: PASS -> FAIL [fdo#109016]

* igt@perf_pmu@rc6-runtime-pm-long:
- shard-apl: PASS -> FAIL [fdo#105010]
- shard-kbl: PASS -> FAIL [fdo#105010]

#### Possible fixes ####

* igt@gem_ctx_isolation@rcs0-s3:
- shard-apl: INCOMPLETE [fdo#103927] -> PASS

* igt@i915_pm_rc6_residency@rc6-accuracy:
- shard-snb: SKIP [fdo#109271] -> PASS

* igt@kms_busy@extended-modeset-hang-newfb-render-c:
- shard-hsw: DMESG-WARN [fdo#107956] -> PASS +1
- shard-kbl: DMESG-WARN [fdo#107956] -> PASS

* igt@kms_ccs@pipe-b-crc-sprite-planes-basic:
- shard-kbl: FAIL [fdo#107725] / [fdo#108145] -> PASS

* igt@kms_color@pipe-a-ctm-max:
- shard-kbl: FAIL [fdo#108147] -> PASS

* igt@kms_cursor_crc@cursor-256x256-random:
- shard-apl: FAIL [fdo#103232] -> PASS +3

* igt@kms_cursor_crc@cursor-64x64-onscreen:
- shard-kbl: FAIL [fdo#103232] -> PASS +1

* igt@kms_cursor_crc@cursor-size-change:
- shard-glk: FAIL [fdo#103232] -> PASS

* igt@kms_cursor_legacy@2x-long-flip-vs-cursor-legacy:
- shard-glk: FAIL [fdo#104873] -> PASS

* igt@kms_draw_crc@draw-method-xrgb8888-mmap-wc-ytiled:
- shard-glk: FAIL [fdo#103184] -> PASS

* igt@kms_frontbuffer_tracking@fbc-1p-primscrn-cur-indfb-draw-pwrite:
- shard-apl: FAIL [fdo#103167] -> PASS +6

* igt@kms_frontbuffer_tracking@fbc-1p-primscrn-spr-indfb-fullscreen:
- shard-kbl: FAIL [fdo#103167] -> PASS +3

* igt@kms_frontbuffer_tracking@fbc-1p-rte:
- shard-apl: FAIL [fdo#103167] / [fdo#105682] -> PASS

* igt@kms_frontbuffer_tracking@fbc-2p-primscrn-cur-indfb-draw-mmap-cpu:
- shard-glk: FAIL [fdo#103167] -> PASS +6

* igt@kms_plane@pixel-format-pipe-c-planes-source-clamping:
- shard-apl: FAIL [fdo#108948] -> PASS

* igt@kms_plane_multiple@atomic-pipe-a-tiling-none:
- shard-apl: FAIL [fdo#103166] -> PASS +1

* igt@kms_plane_multiple@atomic-pipe-a-tiling-yf:
- shard-kbl: FAIL [fdo#103166] -> PASS

* igt@kms_plane_multiple@atomic-pipe-b-tiling-y:
- shard-glk: FAIL [fdo#103166] -> PASS +2

* igt@kms_rotation_crc@multiplane-rotation:
- shard-kbl: DMESG-FAIL [fdo#105763] -> PASS

* igt@kms_vblank@pipe-b-ts-continuation-modeset-rpm:
- shard-apl: FAIL [fdo#104894] -> PASS +1
- shard-kbl: FAIL [fdo#104894] -> PASS

* igt@tools_test@tools_test:
- shard-hsw: SKIP [fdo#109271] -> PASS
- shard-kbl: SKIP [fdo#109271] -> PASS

{name}: This element is suppressed. This means it is ignored when computing
the status of the difference (SUCCESS, WARNING, or FAILURE).

[fdo#103060]: https://bugs.freedesktop.org/show_bug.cgi?id=103060
[fdo#103166]: https://bugs.freedesktop.org/show_bug.cgi?id=103166
[fdo#103167]: https://bugs.freedesktop.org/show_bug.cgi?id=103167
[fdo#103184]: https://bugs.freedesktop.org/show_bug.cgi?id=103184
[fdo#103232]: https://bugs.freedesktop.org/show_bug.cgi?id=103232
[fdo#103665]: https://bugs.freedesktop.org/show_bug.cgi?id=103665
[fdo#103927]: https://bugs.freedesktop.org/show_bug.cgi?id=103927
[fdo#104782]: https://bugs.freedesktop.org/show_bug.cgi?id=104782
[fdo#104873]: https://bugs.freedesktop.org/show_bug.cgi?id=104873
[fdo#104894]: https://bugs.freedesktop.org/show_bug.cgi?id=104894
[fdo#105010]: https://bugs.freedesktop.org/show_bug.cgi?id=105010
[fdo#105411]: https://bugs.freedesktop.org/show_bug.cgi?id=105411
[fdo#105682]: https://bugs.freedesktop.org/show_bug.cgi?id=105682
[fdo#105763]: https://bugs.freedesktop.org/show_bug.cgi?id=105763
[fdo#105767]: https://bugs.freedesktop.org/show_bug.cgi?id=105767
[fdo#107725]: https://bugs.freedesktop.org/show_bug.cgi?id=107725
[fdo#107956]: https://bugs.freedesktop.org/show_bug.cgi?id=107956
[fdo#108145]: https://bugs.freedesktop.org/show_bug.cgi?id=108145
[fdo#108147]: https://bugs.freedesktop.org/show_bug.cgi?id=108147
[fdo#108590]: https://bugs.freedesktop.org/show_bug.cgi?id=108590
[fdo#108948]: https://bugs.freedesktop.org/show_bug.cgi?id=108948
[fdo#109016]: https://bugs.freedesktop.org/show_bug.cgi?id=109016
[fdo#109271]: https://bugs.freedesktop.org/show_bug.cgi?id=109271
[fdo#109278]: https://bugs.freedesktop.org/show_bug.cgi?id=109278

Participating hosts (7 -> 5)
------------------------------

Missing (2): shard-skl shard-iclb

Build changes
-------------

* IGT: IGT_4860 -> IGTPW_2533
* Piglit: piglit_4509 -> None

CI_DRM_5666: 358ab8acaabef3cef2a7ce9e5dd7c4196a0c30fc @ git://anongit.freedesktop.org/gfx-ci/linux
IGTPW_2533: https://intel-gfx-ci.01.org/tree/drm-tip/IGTPW_2533/
IGT_4860: b79007f9c575a538a63ce9301a890ed9e1a45f35 @ git://anongit.freedesktop.org/xorg/app/intel-gpu-tools
piglit_4509: fdc5a4ca11124ab8413c7988896eec4c97336694 @ git://anongit.freedesktop.org/piglit

== Logs ==

For more details see: https://intel-gfx-ci.01.org/tree/drm-tip/IGTPW_2533/
_______________________________________________
igt-dev mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/igt-dev

#3 lore raw

Re: [igt-dev] ✗ Fi.CI.IGT: failure for meson: Make doc building dependent on gtk-doc

Quoted 32 lines · Patchwork

== Series Details ==

Series: meson: Make doc building dependent on gtk-doc
URL : https://patchwork.freedesktop.org/series/57309/
State : failure

== Summary ==

CI Bug Log - changes from CI_DRM_5666_full -> IGTPW_2533_full
====================================================

Summary
-------

**FAILURE**

Serious unknown changes coming with IGTPW_2533_full absolutely need to be verified manually.

If you think the reported changes have nothing to do with the changes introduced in IGTPW_2533_full, please notify your bug team to allow them to document this new failure mode, which will reduce false positives in CI.

External URL: https://patchwork.freedesktop.org/api/1.0/series/57309/revisions/1/

Possible new issues
-------------------

Here are the unknown changes that may have been introduced in IGTPW_2533_full:

### IGT changes ###

Quoted 7 lines

#### Possible regressions ####

* igt@kms_flip@flip-vs-suspend-interruptible:
- shard-hsw: PASS -> DMESG-WARN

* igt@runner@aborted:
- shard-hsw: NOTRUN -> FAIL

Hey,

Those are false possitives. The patch in question touches only documentation building.

Quoted 12 lines

Participating hosts (7 -> 5)
------------------------------

Missing (2): shard-skl shard-iclb

Build changes
-------------

* IGT: IGT_4860 -> IGTPW_2533
* Piglit: piglit_4509 -> None

Quoted 8 lines

CI_DRM_5666: 358ab8acaabef3cef2a7ce9e5dd7c4196a0c30fc @ git://anongit.freedesktop.org/gfx-ci/linux
IGTPW_2533: https://intel-gfx-ci.01.org/tree/drm-tip/IGTPW_2533/
IGT_4860: b79007f9c575a538a63ce9301a890ed9e1a45f35 @ git://anongit.freedesktop.org/xorg/app/intel-gpu-tools
piglit_4509: fdc5a4ca11124ab8413c7988896eec4c97336694 @ git://anongit.freedesktop.org/piglit

== Logs ==

For more details see: https://intel-gfx-ci.01.org/tree/drm-tip/IGTPW_2533/

_______________________________________________
igt-dev mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/igt-dev

Reviewed-by on v1 1/1
#4 lore raw
In reply to Arkadiusz Hiler
Quoted 8 lines · Arkadiusz Hiler

Currently, when gtk-doc is not installed 'ninja' succeeds but 'ninja install' fails with the following error:

FileNotFoundError: [Errno 2] No such file or directory: 'gtkdoc-scan': 'gtkdoc-scan'

With this patch 'meson build' will log that documentations would not build and 'ninja install' will succeed.

Quoted 8 lines

When forcing building docs with 'meson -Dbuild_docs=true build' the following error will occur instead:

meson.build:323:0: ERROR: Dependency "gtk-doc" not found, tried pkgconfig and cmake

The gtk_doc dependency object is left unused, doc building uses import('gnome') instead for it, but hey.

_______________________________________________
igt-dev mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/igt-dev

#5 lore raw
Quoted 14 lines · Petri Latvala
Quoted 13 lines · Arkadiusz Hiler

Currently, when gtk-doc is not installed 'ninja' succeeds but 'ninja install' fails with the following error:

FileNotFoundError: [Errno 2] No such file or directory: 'gtkdoc-scan': 'gtkdoc-scan'

With this patch 'meson build' will log that documentations would not build and 'ninja install' will succeed.

When forcing building docs with 'meson -Dbuild_docs=true build' the following error will occur instead:

meson.build:323:0: ERROR: Dependency "gtk-doc" not found, tried pkgconfig and cmake

Quoted 8 lines
Quoted 3 lines

The gtk_doc dependency object is left unused, doc building uses import('gnome') instead for it, but hey.

Yeah, I am surprised thta gnome.gtkdoc() is not clever enough, doesn't do any dependency checks and lacks 'required' flag.

They have an issue on that since 0.45.1 in Meson.

Anyway, thanks for the review. Pushing in a moment.
_______________________________________________
igt-dev mailing list [email protected]
https://lists.freedesktop.org/mailman/listinfo/igt-dev