From patchwork Wed Jun 22 09:53:44 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 12890422 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 1756ACCA483 for ; Wed, 22 Jun 2022 09:54:05 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234694AbiFVJyD (ORCPT ); Wed, 22 Jun 2022 05:54:03 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:47704 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232696AbiFVJyB (ORCPT ); Wed, 22 Jun 2022 05:54:01 -0400 Received: from mail-pj1-x1032.google.com (mail-pj1-x1032.google.com [IPv6:2607:f8b0:4864:20::1032]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 175472C129; Wed, 22 Jun 2022 02:53:59 -0700 (PDT) Received: by mail-pj1-x1032.google.com with SMTP id cv13so12836741pjb.4; Wed, 22 Jun 2022 02:53:59 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=zwc5cjan8XJuhiO2AI0Z3XaaNZmw6lQvr6pdCpwGjII=; b=RCzyHlkdvvSD53hRmnKcVv4COSd1NhKAI5Q44wX03sqC4U5v14UYZv18yac3a3I+La Vqigz1/6gfz+Nn/sycVzc7a4Z+A1F4vEMWvkLtQ6A/jZR4+zhFqBL1hB5QjHs2SXWxbe mYx7ribRWCRfuuW0Qj1kF8SY7SFzNpbjPiU+jD/4qMevBxACsPImyU9B5rR0c3ZKv6CY DWLmr1l93PLSO+Cmpxiyl+XOz/yRZ2G57cMoqyLJGODUVm4mlBaYtOkhq4UymC4nyDf7 PtJTOFTpfiAwNG22faBVxkp5KTdROSwTKgsPnFRa2FM46dBKFYDwRg6KLG4MDre/KGyd quFw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=zwc5cjan8XJuhiO2AI0Z3XaaNZmw6lQvr6pdCpwGjII=; b=tkyuUw3C+05tYDRCweuXm4v4M0/6VIFwxbAcHtfPI/gZ6qjQm273YQ9OxiXC38VljM CKUF2cJSSQprrSu0JQ0PNwNBi1heQvbLiPI46tMp7FhvRQkyMX5N8A0Bmv7UOIkYf0y3 pCI+3MRrcyb7FwVcgsvBPDGDET3oivGT+PBocppF8BjB8e4KOz31NPyw+HeuWrQzOkI+ q8yCqfot73OgEHS8CCtgCmbJK5DPUtJrq7Z3JE/MxBl2DqsJwaDaSwYli9AVjhQSpAYF Wmmmudi0bQyaxT3JNogeqw+LcjUWyi1J9CwGmEsQnLt8lLiWSgQaIee/kGQ/vjt4GkGl oHtQ== X-Gm-Message-State: AJIora81k6eVTHmQoygKu6m2zgO00npEq6Nfvbcg5UO89Sx3meZjIZOY AP7oxeIawdkRv6du3lFdffLotCDq5mg= X-Google-Smtp-Source: AGRyM1sFGudijpzT26VAOlGiZRBnGgsqJsM7+nB/njLIsscreYO34kywo99d9jHItdLZZq8UD42HEQ== X-Received: by 2002:a17:902:efc4:b0:16a:133a:b20d with SMTP id ja4-20020a170902efc400b0016a133ab20dmr20472708plb.45.1655891637012; Wed, 22 Jun 2022 02:53:57 -0700 (PDT) Received: from debian.me (subs02-180-214-232-91.three.co.id. [180.214.232.91]) by smtp.gmail.com with ESMTPSA id d26-20020aa7869a000000b0051c4f6d2d95sm7064420pfo.106.2022.06.22.02.53.53 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 22 Jun 2022 02:53:56 -0700 (PDT) From: Bagas Sanjaya To: linux-doc@vger.kernel.org Cc: Bagas Sanjaya , Stephen Rothwell , Kishon Vijay Abraham I , Lorenzo Pieralisi , =?utf-8?q?Krzysztof_Wilczy=C5=84?= =?utf-8?q?ski?= , Bjorn Helgaas , Jonathan Corbet , Frank Li , Jon Mason , linux-pci@vger.kernel.org, linux-next@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH 1/2] Documentation: PCI: Use code-block block for scratchpad registers diagram Date: Wed, 22 Jun 2022 16:53:44 +0700 Message-Id: <20220622095345.27121-2-bagasdotme@gmail.com> X-Mailer: git-send-email 2.36.0 In-Reply-To: <20220622095345.27121-1-bagasdotme@gmail.com> References: <20220621200235.211b2e32@canb.auug.org.au> <20220622095345.27121-1-bagasdotme@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-pci@vger.kernel.org The diagram in "Scratchpad Registers" isn't formatted inside code block, hence triggers indentation warning: Documentation/PCI/endpoint/pci-vntb-function.rst:82: WARNING: Unexpected indentation. Fix the warning by using code-block directive to format the diagram inside code block, as in other diagrams in Documentation/. While at it, unindent the preceeding text. Link: https://lore.kernel.org/linux-next/20220621200235.211b2e32@canb.auug.org.au/ Fixes: 0c4b285d9636cc ("Documentation: PCI: Add specification for the PCI vNTB function device") Reported-by: Stephen Rothwell Cc: Kishon Vijay Abraham I Cc: Lorenzo Pieralisi Cc: "Krzysztof Wilczyński" Cc: Bjorn Helgaas Cc: Jonathan Corbet Cc: Frank Li Cc: Jon Mason Cc: linux-pci@vger.kernel.org Cc: linux-next@vger.kernel.org Cc: linux-kernel@vger.kernel.org Signed-off-by: Bagas Sanjaya --- Documentation/PCI/endpoint/pci-vntb-function.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Documentation/PCI/endpoint/pci-vntb-function.rst b/Documentation/PCI/endpoint/pci-vntb-function.rst index cad8013e88390e..0c51f53ab972a0 100644 --- a/Documentation/PCI/endpoint/pci-vntb-function.rst +++ b/Documentation/PCI/endpoint/pci-vntb-function.rst @@ -58,7 +58,10 @@ It is same as PCI NTB Function driver Scratchpad Registers: --------------------- - It is appended after Config region. +It is appended after Config region. + +.. code-block:: text + +--------------------------------------------------+ Base | | From patchwork Wed Jun 22 09:53:45 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 12890423 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id B2EA1C433EF for ; Wed, 22 Jun 2022 09:54:07 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234599AbiFVJyE (ORCPT ); Wed, 22 Jun 2022 05:54:04 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:47716 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229981AbiFVJyC (ORCPT ); Wed, 22 Jun 2022 05:54:02 -0400 Received: from mail-pl1-x631.google.com (mail-pl1-x631.google.com [IPv6:2607:f8b0:4864:20::631]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 6507E22B1C; Wed, 22 Jun 2022 02:54:02 -0700 (PDT) Received: by mail-pl1-x631.google.com with SMTP id o18so7885330plg.2; Wed, 22 Jun 2022 02:54:02 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=V3OJUOfLg2fp6Yw9slvyibMLkh1KMdKNRcGBNNwwEN0=; b=aWJrZZ+M2w9hzuBrUEi74QTz/Nca41Mgo0VBFDVPrxxtChz9X4xQ+oSNBAYzcOFGiX zqhsKq6NCt0/3WRYfh7twNIFnlOW1paAbZMYKZSOMMHPFXh0vRbt65LJswEqYJwM1HH8 wvvsfnxJGIH7irWLR7Qqh6V4IMKubJke91uMv6VKn/WoSPEE+LT5n5S70OoRfXQ7KLXN ubYJY8R2kIGThzm5jYnc4CwUc/5sCJaG3gRM46xlAAmR0oEYDzF7L8LNd7N9M0bp5+qU 50Jn8B0tsyragIhwsPTTV8G6FvZte0yiOKkEzEmaI1ViFFsCuXSHJRbekwZh4A22xHzB Rk7w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=V3OJUOfLg2fp6Yw9slvyibMLkh1KMdKNRcGBNNwwEN0=; b=VNk+7pXpQMHoPP9HhEWEjuyEiLvtz2E2Nd3kJWd0ugQBKxH6x7UTdQQrQLc2vn62yg +JXgq+sVfB3gr+uaTnb4WiKr4w/1SePfHPokqrWYBjbCjO7f95JjAoLx5Zmg7sBtF58S J/O/hhG1ycQef+AUVnlP907xrUm4fqrYKlcn4Eu5bGzMZJqdaxCKk7PakQ3CuA0cVlxK +N2o55kD9eqXq3ikGzaqQsao4lrQfH/gtEPNx2Too7VN/VMBJ+aQxNfLAtRuLsoDjdXp 70lvMT04ZFhkAZwLz8wuzX0fVin095Q69eXLpzu850DFfQC7Qges1ZfPOx0ZDfqa6Y+l M9PA== X-Gm-Message-State: AJIora8hrhXLWttfP15HeEKzlzoMRTzss0HDnhTSiAdRyIIRwfByx4Bz rDtga+ZoKmrjO4UOQRkak4c1TO7J+Io= X-Google-Smtp-Source: AGRyM1uOLIWxdusDf2pPM02W2RekyFBvS2fgYtoG0H0WN6AmcHuY4bVqjkR1k5JRlqty32zji3LVXg== X-Received: by 2002:a17:902:f64c:b0:156:4349:7e9b with SMTP id m12-20020a170902f64c00b0015643497e9bmr33831832plg.139.1655891641399; Wed, 22 Jun 2022 02:54:01 -0700 (PDT) Received: from debian.me (subs02-180-214-232-91.three.co.id. [180.214.232.91]) by smtp.gmail.com with ESMTPSA id d26-20020aa7869a000000b0051c4f6d2d95sm7064420pfo.106.2022.06.22.02.53.57 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 22 Jun 2022 02:54:00 -0700 (PDT) From: Bagas Sanjaya To: linux-doc@vger.kernel.org Cc: Bagas Sanjaya , Stephen Rothwell , Kishon Vijay Abraham I , Lorenzo Pieralisi , =?utf-8?q?Krzysztof_Wilczy=C5=84?= =?utf-8?q?ski?= , Bjorn Helgaas , Jonathan Corbet , Frank Li , Jon Mason , linux-pci@vger.kernel.org, linux-next@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH 2/2] Documentation: PCI: extend subheading underline for "lspci output" section Date: Wed, 22 Jun 2022 16:53:45 +0700 Message-Id: <20220622095345.27121-3-bagasdotme@gmail.com> X-Mailer: git-send-email 2.36.0 In-Reply-To: <20220622095345.27121-1-bagasdotme@gmail.com> References: <20220621200235.211b2e32@canb.auug.org.au> <20220622095345.27121-1-bagasdotme@gmail.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-pci@vger.kernel.org The underline syntax for "lspci output..." section is off-by-one less than the section heading's length, hence triggers the warning: Documentation/PCI/endpoint/pci-vntb-howto.rst:131: WARNING: Title underline too short. Extend the underline by one to match the heading length. Link: https://lore.kernel.org/linux-next/20220621200235.211b2e32@canb.auug.org.au/ Fixes: 0c4b285d9636cc ("Documentation: PCI: Add specification for the PCI vNTB function device") Reported-by: Stephen Rothwell Cc: Kishon Vijay Abraham I Cc: Lorenzo Pieralisi Cc: "Krzysztof Wilczyński" Cc: Bjorn Helgaas Cc: Jonathan Corbet Cc: Frank Li Cc: Jon Mason Cc: linux-pci@vger.kernel.org Cc: linux-next@vger.kernel.org Cc: linux-kernel@vger.kernel.org Signed-off-by: Bagas Sanjaya --- Documentation/PCI/endpoint/pci-vntb-howto.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/PCI/endpoint/pci-vntb-howto.rst b/Documentation/PCI/endpoint/pci-vntb-howto.rst index b4a679144692a8..31a0bae868f996 100644 --- a/Documentation/PCI/endpoint/pci-vntb-howto.rst +++ b/Documentation/PCI/endpoint/pci-vntb-howto.rst @@ -128,7 +128,7 @@ RootComplex Device ================== lspci Output at Host side ------------------------- +------------------------- Note that the devices listed here correspond to the values populated in "Creating pci-epf-ntb Device" section above::