From patchwork Thu May 23 16:16:31 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jonathan Corbet X-Patchwork-Id: 165041 Delivered-To: patch@linaro.org Received: by 2002:a92:9e1a:0:0:0:0:0 with SMTP id q26csp2408155ili; Thu, 23 May 2019 09:16:37 -0700 (PDT) X-Google-Smtp-Source: APXvYqwpvcbzeX8wEQpCRAoBsjySh6KJOLC3w6R7mkDzErNBr3EQOS6QCrbwrJuI+UpdEwDoAPUc X-Received: by 2002:a17:902:bb96:: with SMTP id m22mr99805548pls.5.1558628197498; Thu, 23 May 2019 09:16:37 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1558628197; cv=none; d=google.com; s=arc-20160816; b=tIf57p1vtFDggPP+O/J1D3tLNV/1JEsu3yvH7nzDo6y8mxid5+yn9Obw6k9HSLn637 e1/0/f5uTEFACF0QdAC4I1tn/+VtVuM5QmmtZI+IaNUlPkiRozy9yPV/F+6oTLnG6BOi 61rF6o/FLNl9vGMcS+0/Aov1Ivgt9BpVE77b81ejQed+8AegVT6qbnjbWilygx82kyvg Kyj3zuK8KQ/YH0P2FcLV+hhHXInuDCDZbkkjzKZ/JTAT7CRtmODshw5D/IDGGK5G2DCU 1d3qKShVgzxUoelj72DDUJWNU1yh9FYsAeM2ccSyQOZAAhLcj6NA3aEL/jurkHrEXai/ 8sBw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:content-transfer-encoding:list-subscribe:list-help :list-post:list-archive:list-unsubscribe:list-id:precedence :mime-version:organization:message-id:subject:to:from:date :delivered-to; bh=nPIDynuTx6Ef8oX8VWUDf0AA0DtpwDdcIjRbyM6pBM0=; b=kOzd3+za11sIkZ1pjoJwLzA3Rf/ir4KuAyku9p3Ao3THD7tc5yFRfDxstxNOMtQkpr E52Ax88D96gLjkp5IiB8jql2nvyaZKyRILBlWVR7RwQE8O5AaU0UE6aHikfRLxbT8yo6 qfC8yBi3H1R3/ul0NbksljTDvVusbGt++HDYxf5Fia9tpYxXnt0mfNOdFEWauLBhPBmC BipFZl10ccgVU3027VoXFQhbcBYjOYFmGucIlCXP+Of9bvKxn4zpHla8t10I3ZRKkquX aq7q3+dDxR9AHCxolBn1IvnCDbDKdEqZuU33pGdIjnikXIRab9ncb27rP3TvIVKIeB/L jUEA== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: best guess record for domain of dri-devel-bounces@lists.freedesktop.org designates 2610:10:20:722:a800:ff:fe36:1795 as permitted sender) smtp.mailfrom=dri-devel-bounces@lists.freedesktop.org Return-Path: Received: from gabe.freedesktop.org (gabe.freedesktop.org. [2610:10:20:722:a800:ff:fe36:1795]) by mx.google.com with ESMTPS id d9si28602026plo.395.2019.05.23.09.16.37 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Thu, 23 May 2019 09:16:37 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of dri-devel-bounces@lists.freedesktop.org designates 2610:10:20:722:a800:ff:fe36:1795 as permitted sender) client-ip=2610:10:20:722:a800:ff:fe36:1795; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of dri-devel-bounces@lists.freedesktop.org designates 2610:10:20:722:a800:ff:fe36:1795 as permitted sender) smtp.mailfrom=dri-devel-bounces@lists.freedesktop.org Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id E86306E029; Thu, 23 May 2019 16:16:35 +0000 (UTC) X-Original-To: dri-devel@lists.freedesktop.org Delivered-To: dri-devel@lists.freedesktop.org Received: from ms.lwn.net (ms.lwn.net [45.79.88.28]) by gabe.freedesktop.org (Postfix) with ESMTPS id 9CD966E029 for ; Thu, 23 May 2019 16:16:34 +0000 (UTC) Received: from lwn.net (localhost [127.0.0.1]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ms.lwn.net (Postfix) with ESMTPSA id F3728AB5; Thu, 23 May 2019 16:16:32 +0000 (UTC) Date: Thu, 23 May 2019 10:16:31 -0600 From: Jonathan Corbet To: dri-devel@lists.freedesktop.org Subject: [PATCH] drm/i915: Maintain consistent documentation subsection ordering Message-ID: <20190523101631.64fb33c0@lwn.net> Organization: LWN.net MIME-Version: 1.0 X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" With Sphinx 2.0 (or prior versions with the deprecation warnings fixed) the docs build fails with: Documentation/gpu/i915.rst:403: WARNING: Title level inconsistent: Global GTT Fence Handling ~~~~~~~~~~~~~~~~~~~~~~~~~ reST markup error: Documentation/gpu/i915.rst:403: (SEVERE/4) Title level inconsistent: I "fixed" it by changing the subsections in i915.rst, but that didn't seem like the correct change. It turns out that a couple of i915 files create their own subsections in kerneldoc comments using apostrophes as the heading marker: Layout '''''' That breaks the normal subsection marker ordering, and newer Sphinx is rather more strict about enforcing that ordering. So fix the offending comments to make Sphinx happy. (This is unfortunate, in that kerneldoc comments shouldn't need to be aware of where they might be included in the heading hierarchy, but I don't see a better way around it). Signed-off-by: Jonathan Corbet Acked-by: Jani Nikula --- [If I can possibly get an ack for this, I would like to send it up soon with the other Sphinx-related fixes.] drivers/gpu/drm/i915/i915_reg.h | 6 +++--- drivers/gpu/drm/i915/intel_workarounds.c | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/drivers/gpu/drm/i915/i915_reg.h b/drivers/gpu/drm/i915/i915_reg.h index b74824f0b5b1..249d35c12a75 100644 --- a/drivers/gpu/drm/i915/i915_reg.h +++ b/drivers/gpu/drm/i915/i915_reg.h @@ -35,7 +35,7 @@ * macros. Do **not** mass change existing definitions just to update the style. * * Layout - * '''''' + * ~~~~~~ * * Keep helper macros near the top. For example, _PIPE() and friends. * @@ -79,7 +79,7 @@ * style. Use lower case in hexadecimal values. * * Naming - * '''''' + * ~~~~~~ * * Try to name registers according to the specs. If the register name changes in * the specs from platform to another, stick to the original name. @@ -97,7 +97,7 @@ * suffix to the name. For example, ``_SKL`` or ``_GEN8``. * * Examples - * '''''''' + * ~~~~~~~~ * * (Note that the values in the example are indented using spaces instead of * TABs to avoid misalignment in generated documentation. Use TABs in the diff --git a/drivers/gpu/drm/i915/intel_workarounds.c b/drivers/gpu/drm/i915/intel_workarounds.c index 9682dd575152..6decd432f4d3 100644 --- a/drivers/gpu/drm/i915/intel_workarounds.c +++ b/drivers/gpu/drm/i915/intel_workarounds.c @@ -37,7 +37,7 @@ * costly and simplifies things. We can revisit this in the future. * * Layout - * '''''' + * ~~~~~~ * * Keep things in this file ordered by WA type, as per the above (context, GT, * display, register whitelist, batchbuffer). Then, inside each type, keep the