Received: by 2002:a05:6a10:17d3:0:0:0:0 with SMTP id hz19csp446516pxb; Sat, 10 Apr 2021 07:54:37 -0700 (PDT) X-Google-Smtp-Source: ABdhPJxCt4fkJQf2WPh5UT5xvOSYNAoHK0ZXPq9QYueeDB1gNGSnhfzZsnpgcIVL/4xcdeF2GfPb X-Received: by 2002:a17:906:430f:: with SMTP id j15mr20556371ejm.543.1618066477691; Sat, 10 Apr 2021 07:54:37 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1618066477; cv=none; d=google.com; s=arc-20160816; b=iA5G/KS7tvVk/StOCbLi9xwoZnNpF3Dc9RssrbMyXuOU9akqMQ2uLo3H4KorRRvnPG VBE1HhZYWjO2lnJhihlEIyOCgECbMuVkXHavJAQq7P1bBL8K46/vBo9lk2XVX6HNx7Qx YVSyaUWX0tBqhiNWRKmKV6bd2a7bPcGK9lvkHQ86/J4fDDHlGrfzN+1FBiOpD9r7YXyJ pbtMbt6c8G07mFTttTiZiAXBeNLp8j/8ABBDhBLMtCjJYNZ2yvn+HXld8wt9yGF9T5FX WfxTG6IMp/Pq7xwWRL0MZfLQXrznv4esvF6JNBWN93QEJM7BkbjIZMTXjZpi3sp7LBzD zqfA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:references:in-reply-to:references:in-reply-to :message-id:date:subject:cc:to:from:dkim-signature; bh=Gk8+F4Hq+bcU9lIwVlixskJY7MPpsG/LpoyqOFUQLxI=; b=XxmTnp++zpegzo2obCUWyG6CYuqw1IhXcuNxC7xsvTJOLrymfwGMxXSxBEVh9hIuRQ 9HE7t2MvonZ4asBKOFNwkuOR7IH/QbcbuKhkjpKgT9LSTBIja6IA+KABjkS0ukrH3n3T 5wihrqG8+5AK8VebWYfhteGqZpnK/SmxLLVOP4snxWWVJYAve7mFysS0vIzDmDN1ics2 3WgjK9sxSM1BKvfDQuk3g+yKtdxzWZ+WCfDaWbYK9H3WjGR+zp8Q93GJeZUQuNyq2MOt zYguks9mBpiQZiB5EEXE+7GSFGvk5KCdKkA9T3UjVS3qoyLJE8j4MedMzcC6g728UIDi 2MIw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@synopsys.com header.s=mail header.b=OmyWQdQT; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=synopsys.com Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id y19si3887867edt.293.2021.04.10.07.54.12; Sat, 10 Apr 2021 07:54:37 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@synopsys.com header.s=mail header.b=OmyWQdQT; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=synopsys.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234849AbhDJOxY (ORCPT + 99 others); Sat, 10 Apr 2021 10:53:24 -0400 Received: from smtprelay-out1.synopsys.com ([149.117.87.133]:36542 "EHLO smtprelay-out1.synopsys.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234816AbhDJOxY (ORCPT ); Sat, 10 Apr 2021 10:53:24 -0400 Received: from mailhost.synopsys.com (mdc-mailhost1.synopsys.com [10.225.0.209]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) (No client certificate requested) by smtprelay-out1.synopsys.com (Postfix) with ESMTPS id 78580C0122; Sat, 10 Apr 2021 14:53:07 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=synopsys.com; s=mail; t=1618066389; bh=hSMiiE5yY/Kmol8iEahtysLfqdzwvrDySsXziVJjQ98=; h=From:To:Cc:Subject:Date:In-Reply-To:References:In-Reply-To: References:From; b=OmyWQdQTudifMc+fv8BFpCrGoAFVZZjeYyJlg94F7BRKwJ9tvrDsH3fxCOHIctXDp HpsKTVBJvZOaCgV6ypRHrN2oLbC/VzVRHYX1p4ct+Q6RHc7hNAYzwm++iWWXFIHmKe mIgWkBUR/kC445u6uJZgzx0hHozWOhRN3mpZcbAZjn+9Gv923aFeLcPGiPN9gEcOuW SYLiBX7cMqKCLHw8WB78nkIKHwbVTiHToXON7A938H3JJyHMVF4Gd/d+68UePCCB+l O4BE2pEDBnFIKDenb9Tdw+NOTxPLuQH4IeQ3T+Wck9Gvu+sCxCV1sn/sRwCk5Sf8fw 2+uQd92SuKfXg== Received: from de02dwvm009.internal.synopsys.com (de02dwvm009.internal.synopsys.com [10.225.17.73]) by mailhost.synopsys.com (Postfix) with ESMTP id 1382FA0231; Sat, 10 Apr 2021 14:53:06 +0000 (UTC) X-SNPS-Relay: synopsys.com From: Gustavo Pimentel To: linux-doc@vger.kernel.org, linux-pci@vger.kernel.org, linux-kernel@vger.kernel.org, Derek Kiernan , Dragan Cvetic , Arnd Bergmann , Andrew Morton , Greg Kroah-Hartman , Jonathan Corbet , Bjorn Helgaas , =?UTF-8?q?Krzysztof=20Wilczy=C5=84ski?= , Stephen Rothwell , Gustavo Pimentel Cc: Gustavo Pimentel Subject: [PATCH v4 1/2] dw-xdata-pcie: Fix documentation build warns Date: Sat, 10 Apr 2021 16:52:58 +0200 Message-Id: <42ed2d9d27579291dc7cce89c0164bd9255fe337.1618066164.git.gustavo.pimentel@synopsys.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: References: In-Reply-To: References: Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Fixes documentation build warns related to indentation, text formatting, and missing reference on toc. This fix solves the following warnings: WARNING: Unexpected indentation. WARNING: Block quote ends without a blank line; unexpected unindent. WARNING: document isn't included in any toctree Fixes: e1181b5bbc3c ("Documentation: misc-devices: Add Documentation for dw-xdata-pcie driver") Link: https://lore.kernel.org/linux-next/20210406214615.40cf3493@canb.auug.org.au/ Reported-by: Stephen Rothwell Signed-off-by: Gustavo Pimentel --- Documentation/misc-devices/dw-xdata-pcie.rst | 14 +++++++------- Documentation/misc-devices/index.rst | 1 + 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/Documentation/misc-devices/dw-xdata-pcie.rst b/Documentation/misc-devices/dw-xdata-pcie.rst index fd75c93..cbc9f69 100644 --- a/Documentation/misc-devices/dw-xdata-pcie.rst +++ b/Documentation/misc-devices/dw-xdata-pcie.rst @@ -17,24 +17,24 @@ information to /var/log/kern.log or dmesg. Request write TLPs traffic generation - Root Complex to Endpoint direction - Command: - echo 1 > /sys/class/misc/dw-xdata-pcie/write +echo 1 > /sys/class/misc/dw-xdata-pcie/write Get write TLPs traffic link throughput in MB/s - Command: - cat /sys/class/misc/dw-xdata-pcie/write +cat /sys/class/misc/dw-xdata-pcie/write - Output example: - 204 +204 Request read TLPs traffic generation - Endpoint to Root Complex direction: - Command: - echo 1 > /sys/class/misc/dw-xdata-pcie/read +echo 1 > /sys/class/misc/dw-xdata-pcie/read Get read TLPs traffic link throughput in MB/s - Command: - cat /sys/class/misc/dw-xdata-pcie/read +cat /sys/class/misc/dw-xdata-pcie/read - Output example: - 199 +199 Request to stop any current TLP transfer: - Command: - echo 1 > /sys/class/misc/dw-xdata-pcie/stop +echo 1 > /sys/class/misc/dw-xdata-pcie/stop diff --git a/Documentation/misc-devices/index.rst b/Documentation/misc-devices/index.rst index 64420b331..30ac58f 100644 --- a/Documentation/misc-devices/index.rst +++ b/Documentation/misc-devices/index.rst @@ -19,6 +19,7 @@ fit into other categories. bh1770glc eeprom c2port + dw-xdata-pcie ibmvmc ics932s401 isl29003 -- 2.7.4