Re: [PATCH] drm/i915/guc, docs: Fix pdfdocs build error by removing nested grid

On Thu, 23 Sep 2021 18:10:23 +0300, Jani Nikula wrote:

On Mon, 20 Sep 2021, Akira Yokosawa [off-list ref] wrote:

quoted

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 <redacted>
Cc: Michal Wajdeczko <redacted>
Cc: Matthew Brost <matthew.brost@intel.com>
Cc: Daniele Ceraolo Spurio <redacted>
Cc: Matt Roper <redacted>
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.

[Dropped most CCs]

Hi Jani,

Thank you for taking care of this patch.

Jon, as this has reached upstream, can you back-merge v5.15-rc4
into docs-next so that "make pdfdocs" can complete?

I tried the back-merge without seeing any conflict.
"make pdfdocs" finishes successfully now.

        Thanks, Akira

BR,
Jani.

quoted

---

[...]