* [Intel-gfx] [PATCH] drm/i915/guc, docs: Fix pdfdocs build error by removing nested grid
@ 2021-09-20 7:05 Akira Yokosawa
2021-09-20 8:50 ` Jani Nikula
` (2 more replies)
0 siblings, 3 replies; 4+ messages in thread
From: Akira Yokosawa @ 2021-09-20 7:05 UTC (permalink / raw)
To: John Harrison, Michal Wajdeczko, Matthew Brost, Matt Roper
Cc: intel-gfx, dri-devel, linux-doc, linux-kernel, Jonathan Corbet,
Daniele Ceraolo Spurio
Nested grids in grid-table cells are not specified as proper ReST
constructs.
Commit 572f2a5cd974 ("drm/i915/guc: Update firmware to v62.0.0")
added a couple of kerneldoc tables of the form:
+---+-------+------------------------------------------------------+
| 1 | 31:0 | +------------------------------------------------+ |
+---+-------+ | | |
|...| | | Embedded `HXG Message`_ | |
+---+-------+ | | |
| n | 31:0 | +------------------------------------------------+ |
+---+-------+------------------------------------------------------+
For "make htmldocs", they happen to work as one might expect,
but they are incompatible with "make latexdocs" and "make pdfdocs",
and cause the generated gpu.tex file to become incomplete and
unbuildable by xelatex.
Restore the compatibility by removing those nested grids in the tables.
Size comparison of generated gpu.tex:
Sphinx 2.4.4 Sphinx 4.2.0
v5.14: 3238686 3841631
v5.15-rc1: 376270 432729
with this fix: 3377846 3998095
Fixes: 572f2a5cd974 ("drm/i915/guc: Update firmware to v62.0.0")
Cc: John Harrison <John.C.Harrison@Intel.com>
Cc: Michal Wajdeczko <michal.wajdeczko@intel.com>
Cc: Matthew Brost <matthew.brost@intel.com>
Cc: Daniele Ceraolo Spurio <daniele.ceraolospurio@intel.com>
Cc: Matt Roper <matthew.d.roper@intel.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
---
Hi all,
I know there is little interest in building pdfdocs (or LaTeX) version
of kernel-doc, and this issue does not matter most of you.
But "make pdfdocs" is supposed to work, give or take those tables
with squeezed columns, and at least it is expected to complete
without fatal errors.
I have no idea who is responsible to those grid-tables, so added
a lot of people in the To: and Cc: lists.
Does removing those nested grids look reasonable to you?
Any feedback is welcome!
Note: This patch is against the docs-next branch of Jon's -doc tree
(git://git.lwn.net/linux.git). It can be applied against v5.15-rc1
and v5.15-rc2 as well.
Thanks, Akira
--
.../gpu/drm/i915/gt/uc/abi/guc_communication_ctb_abi.h | 10 +++++-----
.../drm/i915/gt/uc/abi/guc_communication_mmio_abi.h | 10 +++++-----
2 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/drivers/gpu/drm/i915/gt/uc/abi/guc_communication_ctb_abi.h b/drivers/gpu/drm/i915/gt/uc/abi/guc_communication_ctb_abi.h
index 99e1fad5ca20..c9086a600bce 100644
--- a/drivers/gpu/drm/i915/gt/uc/abi/guc_communication_ctb_abi.h
+++ b/drivers/gpu/drm/i915/gt/uc/abi/guc_communication_ctb_abi.h
@@ -102,11 +102,11 @@ static_assert(sizeof(struct guc_ct_buffer_desc) == 64);
* | +-------+--------------------------------------------------------------+
* | | 7:0 | NUM_DWORDS = length (in dwords) of the embedded HXG message |
* +---+-------+--------------------------------------------------------------+
- * | 1 | 31:0 | +--------------------------------------------------------+ |
- * +---+-------+ | | |
- * |...| | | Embedded `HXG Message`_ | |
- * +---+-------+ | | |
- * | n | 31:0 | +--------------------------------------------------------+ |
+ * | 1 | 31:0 | |
+ * +---+-------+ |
+ * |...| | [Embedded `HXG Message`_] |
+ * +---+-------+ |
+ * | n | 31:0 | |
* +---+-------+--------------------------------------------------------------+
*/
diff --git a/drivers/gpu/drm/i915/gt/uc/abi/guc_communication_mmio_abi.h b/drivers/gpu/drm/i915/gt/uc/abi/guc_communication_mmio_abi.h
index bbf1ddb77434..9baa3cb07d13 100644
--- a/drivers/gpu/drm/i915/gt/uc/abi/guc_communication_mmio_abi.h
+++ b/drivers/gpu/drm/i915/gt/uc/abi/guc_communication_mmio_abi.h
@@ -38,11 +38,11 @@
* +---+-------+--------------------------------------------------------------+
* | | Bits | Description |
* +===+=======+==============================================================+
- * | 0 | 31:0 | +--------------------------------------------------------+ |
- * +---+-------+ | | |
- * |...| | | Embedded `HXG Message`_ | |
- * +---+-------+ | | |
- * | n | 31:0 | +--------------------------------------------------------+ |
+ * | 0 | 31:0 | |
+ * +---+-------+ |
+ * |...| | [Embedded `HXG Message`_] |
+ * +---+-------+ |
+ * | n | 31:0 | |
* +---+-------+--------------------------------------------------------------+
*/
base-commit: 242f4c77b1c8cebfdfa0ad5b40e2e4ae0316e57d
--
2.17.1
^ permalink raw reply related [flat|nested] 4+ messages in thread* Re: [Intel-gfx] [PATCH] drm/i915/guc, docs: Fix pdfdocs build error by removing nested grid 2021-09-20 7:05 [Intel-gfx] [PATCH] drm/i915/guc, docs: Fix pdfdocs build error by removing nested grid Akira Yokosawa @ 2021-09-20 8:50 ` Jani Nikula 2021-09-20 14:50 ` [Intel-gfx] ✗ Fi.CI.BAT: failure for " Patchwork 2021-09-23 15:10 ` [Intel-gfx] [PATCH] " Jani Nikula 2 siblings, 0 replies; 4+ messages in thread From: Jani Nikula @ 2021-09-20 8:50 UTC (permalink / raw) To: Akira Yokosawa, John Harrison, Michal Wajdeczko, Matthew Brost, Matt Roper Cc: intel-gfx, dri-devel, linux-doc, linux-kernel, Jonathan Corbet, Daniele Ceraolo Spurio On Mon, 20 Sep 2021, Akira Yokosawa <akiyks@gmail.com> wrote: > Nested grids in grid-table cells are not specified as proper ReST > constructs. > Commit 572f2a5cd974 ("drm/i915/guc: Update firmware to v62.0.0") > added a couple of kerneldoc tables of the form: > > +---+-------+------------------------------------------------------+ > | 1 | 31:0 | +------------------------------------------------+ | > +---+-------+ | | | > |...| | | Embedded `HXG Message`_ | | > +---+-------+ | | | > | n | 31:0 | +------------------------------------------------+ | > +---+-------+------------------------------------------------------+ > > For "make htmldocs", they happen to work as one might expect, > but they are incompatible with "make latexdocs" and "make pdfdocs", > and cause the generated gpu.tex file to become incomplete and > unbuildable by xelatex. > > Restore the compatibility by removing those nested grids in the tables. > > Size comparison of generated gpu.tex: > > Sphinx 2.4.4 Sphinx 4.2.0 > v5.14: 3238686 3841631 > v5.15-rc1: 376270 432729 > with this fix: 3377846 3998095 > > Fixes: 572f2a5cd974 ("drm/i915/guc: Update firmware to v62.0.0") > Cc: John Harrison <John.C.Harrison@Intel.com> > Cc: Michal Wajdeczko <michal.wajdeczko@intel.com> > Cc: Matthew Brost <matthew.brost@intel.com> > Cc: Daniele Ceraolo Spurio <daniele.ceraolospurio@intel.com> > Cc: Matt Roper <matthew.d.roper@intel.com> > Cc: Jonathan Corbet <corbet@lwn.net> > Signed-off-by: Akira Yokosawa <akiyks@gmail.com> > --- > Hi all, > > I know there is little interest in building pdfdocs (or LaTeX) version > of kernel-doc, and this issue does not matter most of you. > > But "make pdfdocs" is supposed to work, give or take those tables > with squeezed columns, and at least it is expected to complete > without fatal errors. Absolutely! > I have no idea who is responsible to those grid-tables, so added > a lot of people in the To: and Cc: lists. > > Does removing those nested grids look reasonable to you? > > Any feedback is welcome! > > Note: This patch is against the docs-next branch of Jon's -doc tree > (git://git.lwn.net/linux.git). It can be applied against v5.15-rc1 > and v5.15-rc2 as well. I think this should go through drm-intel, and it'll find its way back to some v5.15-rc. BR, Jani. > > Thanks, Akira > -- > .../gpu/drm/i915/gt/uc/abi/guc_communication_ctb_abi.h | 10 +++++----- > .../drm/i915/gt/uc/abi/guc_communication_mmio_abi.h | 10 +++++----- > 2 files changed, 10 insertions(+), 10 deletions(-) > > diff --git a/drivers/gpu/drm/i915/gt/uc/abi/guc_communication_ctb_abi.h b/drivers/gpu/drm/i915/gt/uc/abi/guc_communication_ctb_abi.h > index 99e1fad5ca20..c9086a600bce 100644 > --- a/drivers/gpu/drm/i915/gt/uc/abi/guc_communication_ctb_abi.h > +++ b/drivers/gpu/drm/i915/gt/uc/abi/guc_communication_ctb_abi.h > @@ -102,11 +102,11 @@ static_assert(sizeof(struct guc_ct_buffer_desc) == 64); > * | +-------+--------------------------------------------------------------+ > * | | 7:0 | NUM_DWORDS = length (in dwords) of the embedded HXG message | > * +---+-------+--------------------------------------------------------------+ > - * | 1 | 31:0 | +--------------------------------------------------------+ | > - * +---+-------+ | | | > - * |...| | | Embedded `HXG Message`_ | | > - * +---+-------+ | | | > - * | n | 31:0 | +--------------------------------------------------------+ | > + * | 1 | 31:0 | | > + * +---+-------+ | > + * |...| | [Embedded `HXG Message`_] | > + * +---+-------+ | > + * | n | 31:0 | | > * +---+-------+--------------------------------------------------------------+ > */ > > diff --git a/drivers/gpu/drm/i915/gt/uc/abi/guc_communication_mmio_abi.h b/drivers/gpu/drm/i915/gt/uc/abi/guc_communication_mmio_abi.h > index bbf1ddb77434..9baa3cb07d13 100644 > --- a/drivers/gpu/drm/i915/gt/uc/abi/guc_communication_mmio_abi.h > +++ b/drivers/gpu/drm/i915/gt/uc/abi/guc_communication_mmio_abi.h > @@ -38,11 +38,11 @@ > * +---+-------+--------------------------------------------------------------+ > * | | Bits | Description | > * +===+=======+==============================================================+ > - * | 0 | 31:0 | +--------------------------------------------------------+ | > - * +---+-------+ | | | > - * |...| | | Embedded `HXG Message`_ | | > - * +---+-------+ | | | > - * | n | 31:0 | +--------------------------------------------------------+ | > + * | 0 | 31:0 | | > + * +---+-------+ | > + * |...| | [Embedded `HXG Message`_] | > + * +---+-------+ | > + * | n | 31:0 | | > * +---+-------+--------------------------------------------------------------+ > */ > > > base-commit: 242f4c77b1c8cebfdfa0ad5b40e2e4ae0316e57d -- Jani Nikula, Intel Open Source Graphics Center ^ permalink raw reply [flat|nested] 4+ messages in thread
* [Intel-gfx] ✗ Fi.CI.BAT: failure for drm/i915/guc, docs: Fix pdfdocs build error by removing nested grid 2021-09-20 7:05 [Intel-gfx] [PATCH] drm/i915/guc, docs: Fix pdfdocs build error by removing nested grid Akira Yokosawa 2021-09-20 8:50 ` Jani Nikula @ 2021-09-20 14:50 ` Patchwork 2021-09-23 15:10 ` [Intel-gfx] [PATCH] " Jani Nikula 2 siblings, 0 replies; 4+ messages in thread From: Patchwork @ 2021-09-20 14:50 UTC (permalink / raw) To: Akira Yokosawa; +Cc: intel-gfx [-- Attachment #1: Type: text/plain, Size: 10910 bytes --] == Series Details == Series: drm/i915/guc, docs: Fix pdfdocs build error by removing nested grid URL : https://patchwork.freedesktop.org/series/94858/ State : failure == Summary == CI Bug Log - changes from CI_DRM_10611 -> Patchwork_21098 ==================================================== Summary ------- **FAILURE** Serious unknown changes coming with Patchwork_21098 absolutely need to be verified manually. If you think the reported changes have nothing to do with the changes introduced in Patchwork_21098, please notify your bug team to allow them to document this new failure mode, which will reduce false positives in CI. External URL: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/index.html Possible new issues ------------------- Here are the unknown changes that may have been introduced in Patchwork_21098: ### IGT changes ### #### Possible regressions #### * igt@core_hotunplug@unbind-rebind: - fi-bxt-dsi: [PASS][1] -> [DMESG-WARN][2] [1]: https://intel-gfx-ci.01.org/tree/drm-tip/CI_DRM_10611/fi-bxt-dsi/igt@core_hotunplug@unbind-rebind.html [2]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-bxt-dsi/igt@core_hotunplug@unbind-rebind.html * igt@i915_module_load@reload: - fi-snb-2600: [PASS][3] -> [INCOMPLETE][4] [3]: https://intel-gfx-ci.01.org/tree/drm-tip/CI_DRM_10611/fi-snb-2600/igt@i915_module_load@reload.html [4]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-snb-2600/igt@i915_module_load@reload.html Known issues ------------ Here are the changes found in Patchwork_21098 that come from known issues: ### IGT changes ### #### Issues hit #### * igt@amdgpu/amd_basic@cs-compute: - fi-cfl-guc: NOTRUN -> [SKIP][5] ([fdo#109271]) +17 similar issues [5]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-cfl-guc/igt@amdgpu/amd_basic@cs-compute.html * igt@amdgpu/amd_basic@cs-gfx: - fi-skl-6700k2: NOTRUN -> [SKIP][6] ([fdo#109271]) +31 similar issues [6]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-skl-6700k2/igt@amdgpu/amd_basic@cs-gfx.html * igt@amdgpu/amd_basic@query-info: - fi-glk-dsi: NOTRUN -> [SKIP][7] ([fdo#109271]) +17 similar issues [7]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-glk-dsi/igt@amdgpu/amd_basic@query-info.html * igt@amdgpu/amd_basic@semaphore: - fi-icl-y: NOTRUN -> [SKIP][8] ([fdo#109315]) +17 similar issues [8]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-icl-y/igt@amdgpu/amd_basic@semaphore.html - fi-bdw-5557u: NOTRUN -> [SKIP][9] ([fdo#109271]) +27 similar issues [9]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-bdw-5557u/igt@amdgpu/amd_basic@semaphore.html * igt@amdgpu/amd_cs_nop@fork-compute0: - fi-ivb-3770: NOTRUN -> [SKIP][10] ([fdo#109271]) +18 similar issues [10]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-ivb-3770/igt@amdgpu/amd_cs_nop@fork-compute0.html * igt@amdgpu/amd_cs_nop@nop-compute0: - fi-ilk-650: NOTRUN -> [SKIP][11] ([fdo#109271]) +18 similar issues [11]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-ilk-650/igt@amdgpu/amd_cs_nop@nop-compute0.html * igt@amdgpu/amd_cs_nop@sync-gfx0: - fi-rkl-11600: NOTRUN -> [SKIP][12] ([fdo#109315]) +17 similar issues [12]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-rkl-11600/igt@amdgpu/amd_cs_nop@sync-gfx0.html * igt@core_hotunplug@unbind-rebind: - fi-rkl-guc: [PASS][13] -> [INCOMPLETE][14] ([i915#4130]) [13]: https://intel-gfx-ci.01.org/tree/drm-tip/CI_DRM_10611/fi-rkl-guc/igt@core_hotunplug@unbind-rebind.html [14]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-rkl-guc/igt@core_hotunplug@unbind-rebind.html - fi-cfl-8700k: [PASS][15] -> [INCOMPLETE][16] ([i915#4130]) [15]: https://intel-gfx-ci.01.org/tree/drm-tip/CI_DRM_10611/fi-cfl-8700k/igt@core_hotunplug@unbind-rebind.html [16]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-cfl-8700k/igt@core_hotunplug@unbind-rebind.html - fi-bdw-5557u: NOTRUN -> [WARN][17] ([i915#3718]) [17]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-bdw-5557u/igt@core_hotunplug@unbind-rebind.html * igt@gem_huc_copy@huc-copy: - fi-skl-6700k2: NOTRUN -> [SKIP][18] ([fdo#109271] / [i915#2190]) [18]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-skl-6700k2/igt@gem_huc_copy@huc-copy.html * igt@i915_module_load@reload: - fi-cfl-8109u: [PASS][19] -> [INCOMPLETE][20] ([i915#4130]) [19]: https://intel-gfx-ci.01.org/tree/drm-tip/CI_DRM_10611/fi-cfl-8109u/igt@i915_module_load@reload.html [20]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-cfl-8109u/igt@i915_module_load@reload.html * igt@kms_chamelium@dp-crc-fast: - fi-bdw-5557u: NOTRUN -> [SKIP][21] ([fdo#109271] / [fdo#111827]) +8 similar issues [21]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-bdw-5557u/igt@kms_chamelium@dp-crc-fast.html * igt@kms_pipe_crc_basic@compare-crc-sanitycheck-pipe-d: - fi-skl-6700k2: NOTRUN -> [SKIP][22] ([fdo#109271] / [i915#533]) [22]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-skl-6700k2/igt@kms_pipe_crc_basic@compare-crc-sanitycheck-pipe-d.html * igt@runner@aborted: - fi-cfl-8109u: NOTRUN -> [FAIL][23] ([i915#2426] / [i915#3363]) [23]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-cfl-8109u/igt@runner@aborted.html - fi-kbl-soraka: NOTRUN -> [FAIL][24] ([i915#2426] / [i915#3363]) [24]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-kbl-soraka/igt@runner@aborted.html - fi-snb-2600: NOTRUN -> [FAIL][25] ([i915#2426]) [25]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-snb-2600/igt@runner@aborted.html #### Possible fixes #### * igt@core_hotunplug@unbind-rebind: - fi-ilk-650: [DMESG-WARN][26] ([i915#164]) -> [PASS][27] [26]: https://intel-gfx-ci.01.org/tree/drm-tip/CI_DRM_10611/fi-ilk-650/igt@core_hotunplug@unbind-rebind.html [27]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-ilk-650/igt@core_hotunplug@unbind-rebind.html - fi-cfl-guc: [INCOMPLETE][28] ([i915#4130]) -> [PASS][29] [28]: https://intel-gfx-ci.01.org/tree/drm-tip/CI_DRM_10611/fi-cfl-guc/igt@core_hotunplug@unbind-rebind.html [29]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-cfl-guc/igt@core_hotunplug@unbind-rebind.html - fi-rkl-11600: [INCOMPLETE][30] ([i915#4130]) -> [PASS][31] [30]: https://intel-gfx-ci.01.org/tree/drm-tip/CI_DRM_10611/fi-rkl-11600/igt@core_hotunplug@unbind-rebind.html [31]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-rkl-11600/igt@core_hotunplug@unbind-rebind.html * igt@gem_exec_suspend@basic-s0: - fi-skl-6700k2: [DMESG-WARN][32] ([i915#1602]) -> [PASS][33] [32]: https://intel-gfx-ci.01.org/tree/drm-tip/CI_DRM_10611/fi-skl-6700k2/igt@gem_exec_suspend@basic-s0.html [33]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-skl-6700k2/igt@gem_exec_suspend@basic-s0.html * igt@i915_module_load@reload: - fi-ilk-650: [INCOMPLETE][34] -> [PASS][35] [34]: https://intel-gfx-ci.01.org/tree/drm-tip/CI_DRM_10611/fi-ilk-650/igt@i915_module_load@reload.html [35]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-ilk-650/igt@i915_module_load@reload.html - fi-ivb-3770: [INCOMPLETE][36] -> [PASS][37] [36]: https://intel-gfx-ci.01.org/tree/drm-tip/CI_DRM_10611/fi-ivb-3770/igt@i915_module_load@reload.html [37]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-ivb-3770/igt@i915_module_load@reload.html - fi-glk-dsi: [INCOMPLETE][38] ([i915#4130]) -> [PASS][39] [38]: https://intel-gfx-ci.01.org/tree/drm-tip/CI_DRM_10611/fi-glk-dsi/igt@i915_module_load@reload.html [39]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-glk-dsi/igt@i915_module_load@reload.html - fi-kbl-guc: [INCOMPLETE][40] ([i915#4130] / [i915#4139]) -> [PASS][41] [40]: https://intel-gfx-ci.01.org/tree/drm-tip/CI_DRM_10611/fi-kbl-guc/igt@i915_module_load@reload.html [41]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-kbl-guc/igt@i915_module_load@reload.html #### Warnings #### * igt@i915_module_load@reload: - fi-kbl-soraka: [INCOMPLETE][42] ([i915#4136]) -> [INCOMPLETE][43] ([i915#4130]) [42]: https://intel-gfx-ci.01.org/tree/drm-tip/CI_DRM_10611/fi-kbl-soraka/igt@i915_module_load@reload.html [43]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-kbl-soraka/igt@i915_module_load@reload.html - fi-icl-y: [INCOMPLETE][44] ([i915#4130]) -> [TIMEOUT][45] ([i915#4136]) [44]: https://intel-gfx-ci.01.org/tree/drm-tip/CI_DRM_10611/fi-icl-y/igt@i915_module_load@reload.html [45]: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/fi-icl-y/igt@i915_module_load@reload.html {name}: This element is suppressed. This means it is ignored when computing the status of the difference (SUCCESS, WARNING, or FAILURE). [fdo#109271]: https://bugs.freedesktop.org/show_bug.cgi?id=109271 [fdo#109315]: https://bugs.freedesktop.org/show_bug.cgi?id=109315 [fdo#111827]: https://bugs.freedesktop.org/show_bug.cgi?id=111827 [i915#1602]: https://gitlab.freedesktop.org/drm/intel/issues/1602 [i915#164]: https://gitlab.freedesktop.org/drm/intel/issues/164 [i915#2190]: https://gitlab.freedesktop.org/drm/intel/issues/2190 [i915#2426]: https://gitlab.freedesktop.org/drm/intel/issues/2426 [i915#3363]: https://gitlab.freedesktop.org/drm/intel/issues/3363 [i915#3718]: https://gitlab.freedesktop.org/drm/intel/issues/3718 [i915#4130]: https://gitlab.freedesktop.org/drm/intel/issues/4130 [i915#4136]: https://gitlab.freedesktop.org/drm/intel/issues/4136 [i915#4139]: https://gitlab.freedesktop.org/drm/intel/issues/4139 [i915#533]: https://gitlab.freedesktop.org/drm/intel/issues/533 Participating hosts (43 -> 36) ------------------------------ Missing (7): bat-adls-5 bat-dg1-6 fi-tgl-1115g4 fi-bsw-cyan fi-ctg-p8600 fi-bdw-samus bat-jsl-1 Build changes ------------- * Linux: CI_DRM_10611 -> Patchwork_21098 CI-20190529: 20190529 CI_DRM_10611: 8b0f8845694719e82824fad249557557077cd895 @ git://anongit.freedesktop.org/gfx-ci/linux IGT_6212: 0faa6b2533da9416a3428c34ca99661725577449 @ https://gitlab.freedesktop.org/drm/igt-gpu-tools.git Patchwork_21098: a7d7175da96fa437d3cca74786e5d1900c42d085 @ git://anongit.freedesktop.org/gfx-ci/linux == Linux commits == a7d7175da96f drm/i915/guc, docs: Fix pdfdocs build error by removing nested grid == Logs == For more details see: https://intel-gfx-ci.01.org/tree/drm-tip/Patchwork_21098/index.html [-- Attachment #2: Type: text/html, Size: 13600 bytes --] ^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [Intel-gfx] [PATCH] drm/i915/guc, docs: Fix pdfdocs build error by removing nested grid 2021-09-20 7:05 [Intel-gfx] [PATCH] drm/i915/guc, docs: Fix pdfdocs build error by removing nested grid Akira Yokosawa 2021-09-20 8:50 ` Jani Nikula 2021-09-20 14:50 ` [Intel-gfx] ✗ Fi.CI.BAT: failure for " Patchwork @ 2021-09-23 15:10 ` Jani Nikula 2 siblings, 0 replies; 4+ messages in thread From: Jani Nikula @ 2021-09-23 15:10 UTC (permalink / raw) To: Akira Yokosawa, John Harrison, Michal Wajdeczko, Matthew Brost, Matt Roper Cc: intel-gfx, dri-devel, linux-doc, linux-kernel, Jonathan Corbet, Daniele Ceraolo Spurio On Mon, 20 Sep 2021, Akira Yokosawa <akiyks@gmail.com> wrote: > Nested grids in grid-table cells are not specified as proper ReST > constructs. > Commit 572f2a5cd974 ("drm/i915/guc: Update firmware to v62.0.0") > added a couple of kerneldoc tables of the form: > > +---+-------+------------------------------------------------------+ > | 1 | 31:0 | +------------------------------------------------+ | > +---+-------+ | | | > |...| | | Embedded `HXG Message`_ | | > +---+-------+ | | | > | n | 31:0 | +------------------------------------------------+ | > +---+-------+------------------------------------------------------+ > > For "make htmldocs", they happen to work as one might expect, > but they are incompatible with "make latexdocs" and "make pdfdocs", > and cause the generated gpu.tex file to become incomplete and > unbuildable by xelatex. > > Restore the compatibility by removing those nested grids in the tables. > > Size comparison of generated gpu.tex: > > Sphinx 2.4.4 Sphinx 4.2.0 > v5.14: 3238686 3841631 > v5.15-rc1: 376270 432729 > with this fix: 3377846 3998095 > > Fixes: 572f2a5cd974 ("drm/i915/guc: Update firmware to v62.0.0") > Cc: John Harrison <John.C.Harrison@Intel.com> > Cc: Michal Wajdeczko <michal.wajdeczko@intel.com> > Cc: Matthew Brost <matthew.brost@intel.com> > Cc: Daniele Ceraolo Spurio <daniele.ceraolospurio@intel.com> > Cc: Matt Roper <matthew.d.roper@intel.com> > Cc: Jonathan Corbet <corbet@lwn.net> > Signed-off-by: Akira Yokosawa <akiyks@gmail.com> Pushed to drm-intel-gt-next, thanks for the patch. This makes the HTML output arguably worse, but there were no comments from anyone and the pdf build needs to work. BR, Jani. > --- > Hi all, > > I know there is little interest in building pdfdocs (or LaTeX) version > of kernel-doc, and this issue does not matter most of you. > > But "make pdfdocs" is supposed to work, give or take those tables > with squeezed columns, and at least it is expected to complete > without fatal errors. > > I have no idea who is responsible to those grid-tables, so added > a lot of people in the To: and Cc: lists. > > Does removing those nested grids look reasonable to you? > > Any feedback is welcome! > > Note: This patch is against the docs-next branch of Jon's -doc tree > (git://git.lwn.net/linux.git). It can be applied against v5.15-rc1 > and v5.15-rc2 as well. > > Thanks, Akira > -- > .../gpu/drm/i915/gt/uc/abi/guc_communication_ctb_abi.h | 10 +++++----- > .../drm/i915/gt/uc/abi/guc_communication_mmio_abi.h | 10 +++++----- > 2 files changed, 10 insertions(+), 10 deletions(-) > > diff --git a/drivers/gpu/drm/i915/gt/uc/abi/guc_communication_ctb_abi.h b/drivers/gpu/drm/i915/gt/uc/abi/guc_communication_ctb_abi.h > index 99e1fad5ca20..c9086a600bce 100644 > --- a/drivers/gpu/drm/i915/gt/uc/abi/guc_communication_ctb_abi.h > +++ b/drivers/gpu/drm/i915/gt/uc/abi/guc_communication_ctb_abi.h > @@ -102,11 +102,11 @@ static_assert(sizeof(struct guc_ct_buffer_desc) == 64); > * | +-------+--------------------------------------------------------------+ > * | | 7:0 | NUM_DWORDS = length (in dwords) of the embedded HXG message | > * +---+-------+--------------------------------------------------------------+ > - * | 1 | 31:0 | +--------------------------------------------------------+ | > - * +---+-------+ | | | > - * |...| | | Embedded `HXG Message`_ | | > - * +---+-------+ | | | > - * | n | 31:0 | +--------------------------------------------------------+ | > + * | 1 | 31:0 | | > + * +---+-------+ | > + * |...| | [Embedded `HXG Message`_] | > + * +---+-------+ | > + * | n | 31:0 | | > * +---+-------+--------------------------------------------------------------+ > */ > > diff --git a/drivers/gpu/drm/i915/gt/uc/abi/guc_communication_mmio_abi.h b/drivers/gpu/drm/i915/gt/uc/abi/guc_communication_mmio_abi.h > index bbf1ddb77434..9baa3cb07d13 100644 > --- a/drivers/gpu/drm/i915/gt/uc/abi/guc_communication_mmio_abi.h > +++ b/drivers/gpu/drm/i915/gt/uc/abi/guc_communication_mmio_abi.h > @@ -38,11 +38,11 @@ > * +---+-------+--------------------------------------------------------------+ > * | | Bits | Description | > * +===+=======+==============================================================+ > - * | 0 | 31:0 | +--------------------------------------------------------+ | > - * +---+-------+ | | | > - * |...| | | Embedded `HXG Message`_ | | > - * +---+-------+ | | | > - * | n | 31:0 | +--------------------------------------------------------+ | > + * | 0 | 31:0 | | > + * +---+-------+ | > + * |...| | [Embedded `HXG Message`_] | > + * +---+-------+ | > + * | n | 31:0 | | > * +---+-------+--------------------------------------------------------------+ > */ > > > base-commit: 242f4c77b1c8cebfdfa0ad5b40e2e4ae0316e57d -- Jani Nikula, Intel Open Source Graphics Center ^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2021-09-23 15:10 UTC | newest] Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- 2021-09-20 7:05 [Intel-gfx] [PATCH] drm/i915/guc, docs: Fix pdfdocs build error by removing nested grid Akira Yokosawa 2021-09-20 8:50 ` Jani Nikula 2021-09-20 14:50 ` [Intel-gfx] ✗ Fi.CI.BAT: failure for " Patchwork 2021-09-23 15:10 ` [Intel-gfx] [PATCH] " Jani Nikula
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).