From: Jani Nikula <jani.nikula@linux.intel.com>
To: Akira Yokosawa <akiyks@gmail.com>,
John Harrison <John.C.Harrison@Intel.com>,
Michal Wajdeczko <michal.wajdeczko@intel.com>,
Matthew Brost <matthew.brost@intel.com>,
Matt Roper <matthew.d.roper@intel.com>
Cc: intel-gfx@lists.freedesktop.org, dri-devel@lists.freedesktop.org,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Jonathan Corbet <corbet@lwn.net>,
Daniele Ceraolo Spurio <daniele.ceraolospurio@intel.com>
Subject: Re: [Intel-gfx] [PATCH] drm/i915/guc, docs: Fix pdfdocs build error by removing nested grid
Date: Mon, 20 Sep 2021 11:50:18 +0300 [thread overview]
Message-ID: <877dfbvdf9.fsf@intel.com> (raw)
In-Reply-To: <4a227569-074f-c501-58bb-d0d8f60a8ae9@gmail.com>
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
next prev parent reply other threads:[~2021-09-20 8:50 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
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 [this message]
2021-09-20 14:50 ` [Intel-gfx] ✗ Fi.CI.BAT: failure for " Patchwork
2021-09-23 15:10 ` [Intel-gfx] [PATCH] " Jani Nikula
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=877dfbvdf9.fsf@intel.com \
--to=jani.nikula@linux.intel.com \
--cc=John.C.Harrison@Intel.com \
--cc=akiyks@gmail.com \
--cc=corbet@lwn.net \
--cc=daniele.ceraolospurio@intel.com \
--cc=dri-devel@lists.freedesktop.org \
--cc=intel-gfx@lists.freedesktop.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=matthew.brost@intel.com \
--cc=matthew.d.roper@intel.com \
--cc=michal.wajdeczko@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).