From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.8 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,MENTIONS_GIT_HOSTING,SPF_HELO_NONE,SPF_PASS autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id A6940C433F5 for ; Mon, 20 Sep 2021 08:50:33 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 8A64860EB4 for ; Mon, 20 Sep 2021 08:50:33 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234202AbhITIv5 (ORCPT ); Mon, 20 Sep 2021 04:51:57 -0400 Received: from mga18.intel.com ([134.134.136.126]:46702 "EHLO mga18.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229844AbhITIvy (ORCPT ); Mon, 20 Sep 2021 04:51:54 -0400 X-IronPort-AV: E=McAfee;i="6200,9189,10112"; a="210170712" X-IronPort-AV: E=Sophos;i="5.85,307,1624345200"; d="scan'208";a="210170712" Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by orsmga106.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 20 Sep 2021 01:50:27 -0700 X-IronPort-AV: E=Sophos;i="5.85,307,1624345200"; d="scan'208";a="556028395" Received: from svandens-mobl1.ger.corp.intel.com (HELO localhost) ([10.251.216.120]) by fmsmga002-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 20 Sep 2021 01:50:21 -0700 From: Jani Nikula To: Akira Yokosawa , John Harrison , Michal Wajdeczko , Matthew Brost , Matt Roper Cc: intel-gfx@lists.freedesktop.org, dri-devel@lists.freedesktop.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Jonathan Corbet , Daniele Ceraolo Spurio Subject: Re: [PATCH] drm/i915/guc, docs: Fix pdfdocs build error by removing nested grid In-Reply-To: <4a227569-074f-c501-58bb-d0d8f60a8ae9@gmail.com> Organization: Intel Finland Oy - BIC 0357606-4 - Westendinkatu 7, 02160 Espoo References: <4a227569-074f-c501-58bb-d0d8f60a8ae9@gmail.com> Date: Mon, 20 Sep 2021 11:50:18 +0300 Message-ID: <877dfbvdf9.fsf@intel.com> MIME-Version: 1.0 Content-Type: text/plain Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org On Mon, 20 Sep 2021, Akira Yokosawa 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 > Cc: Michal Wajdeczko > Cc: Matthew Brost > Cc: Daniele Ceraolo Spurio > Cc: Matt Roper > Cc: Jonathan Corbet > Signed-off-by: Akira Yokosawa > --- > 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