From patchwork Wed May 10 03:54:12 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 13236287 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 7086BC7EE2D for ; Wed, 10 May 2023 03:55:52 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235928AbjEJDzt (ORCPT ); Tue, 9 May 2023 23:55:49 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:54040 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235883AbjEJDzE (ORCPT ); Tue, 9 May 2023 23:55:04 -0400 Received: from mail-pl1-x635.google.com (mail-pl1-x635.google.com [IPv6:2607:f8b0:4864:20::635]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id AF7F54EFE; Tue, 9 May 2023 20:54:35 -0700 (PDT) Received: by mail-pl1-x635.google.com with SMTP id d9443c01a7336-1aaef97652fso46478255ad.0; Tue, 09 May 2023 20:54:35 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1683690875; x=1686282875; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=6Bksri3u+2ou45ymklEGdo+3VOZCYOTumAp0Ryz1FdA=; b=EooubZ2VKqSN/12+BCYDM79baPLfy3nlIouj+oJ/D+gXMVC9pAQfgyQDiHBwkJs0ip srUtmMJHmwA1Kj4Y8zzpo82gGZUNkqP9Now2KmZFG2+vxPPNNmG5S6pitipsVKYojcJy tjRLOBpFilaEN7z7WEFM93UYi2ZLp39bP37A8Eb7f0ILbG+kacrlAJ0GkxLY5+hiRSzy epdQvo8CHIGJSGZ3wkLWhFfR+76JhJL13Mdvc9iNELrtZDBqfbjysvWv/ccwv/3DWmbb V+VXlWnzox3THZ0TPUTO5vjRzRmVyVE9QWa7Jy9zohx1DB2Bd+hQ03LpFB+Jo7CZZoB2 ezfg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683690875; x=1686282875; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=6Bksri3u+2ou45ymklEGdo+3VOZCYOTumAp0Ryz1FdA=; b=GNUZNC6Amdo4tx0cSp7kT74+qGt7Q3nTxUmXxGKJBOkHf8jQ/Q4EWELQdPIvLRk3v4 FAdOWNAVnXTpClNOnj31XkwqB+9S4aXbiPjPoukMjVOXUQHLFAROT36ycrs2nIJUlvWn c6QrnVOx6rbyktiz6hf2a7xSumjV5n6ImBK+5uXL8pOJdIRPfE5nhx9SP3H5n2HGK4Ta QYO6Pw9JY7ofiXgpTaZQScoLEDE/jiNcHvDCFtmhxSi7nK11ZA2q/Td/iiMDyDBpW3/k yZ+f1d5VnAOfPr5rYwKtWxQTzpV1j0wEYstU6CR5fjd/Yg98X8iJ6yHl7mQa2/zWk/Mv SaNw== X-Gm-Message-State: AC+VfDyQlO+s/xxD6OnzgEGuba1BkZ12gdWKk6kduTi+PVFPORslLgYc T7GseNK9maWfz9AXHLvExqc= X-Google-Smtp-Source: ACHHUZ7VhzmbNMlSO14YvlGNTgX4G+2oJJOBGDaU8NLBWdQE2DLFPByKUrOh3G/lO43KkONMvHoaNg== X-Received: by 2002:a17:902:c1cd:b0:1a9:40d5:b0ae with SMTP id c13-20020a170902c1cd00b001a940d5b0aemr16980105plc.12.1683690875088; Tue, 09 May 2023 20:54:35 -0700 (PDT) Received: from debian.me (subs32-116-206-28-21.three.co.id. [116.206.28.21]) by smtp.gmail.com with ESMTPSA id az7-20020a170902a58700b001a212a93295sm2471278plb.189.2023.05.09.20.54.33 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 09 May 2023 20:54:34 -0700 (PDT) Received: by debian.me (Postfix, from userid 1000) id 61D0F106AA3; Wed, 10 May 2023 10:54:29 +0700 (WIB) From: Bagas Sanjaya To: Linux Networking , Remote Direct Memory Access Kernel Subsystem , Linux Documentation , Linux Kernel Mailing List Cc: Saeed Mahameed , Leon Romanovsky , "David S. Miller" , Eric Dumazet , Jakub Kicinski , Paolo Abeni , Jonathan Corbet , Bagas Sanjaya , Gal Pressman , Rahul Rameshbabu , Maher Sanalla , Moshe Shemesh , Tariq Toukan , Leon Romanovsky Subject: [PATCH net v2 1/4] Documentation: net/mlx5: Wrap vnic reporter devlink commands in code blocks Date: Wed, 10 May 2023 10:54:12 +0700 Message-Id: <20230510035415.16956-2-bagasdotme@gmail.com> X-Mailer: git-send-email 2.40.1 In-Reply-To: <20230510035415.16956-1-bagasdotme@gmail.com> References: <20230510035415.16956-1-bagasdotme@gmail.com> MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=2123; i=bagasdotme@gmail.com; h=from:subject; bh=O0gb1djqqGlVnpw0BLHtEz7rG+DhvvWYMeRgnv2afG0=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDCnRomnL/wm/fB9dnr71bcNuOZlDKROXpDMsvdyzxezbx 2nLl0gs7ChlYRDjYpAVU2SZlMjXdHqXkciF9rWOMHNYmUCGMHBxCsBE3BMYGe6JHXGffVul8FCj zmsbtrneb3qlf5rlZDGFb8/gab88o57hf8XKTqMDr8KdZu/245vnYurzWcjo4cJbYilqdStXzey UYQMA X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D Precedence: bulk List-ID: X-Mailing-List: linux-rdma@vger.kernel.org Sphinx reports htmldocs warnings: Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst:287: WARNING: Unexpected indentation. Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst:288: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst:290: WARNING: Unexpected indentation. Fix above warnings by wrapping diagnostic devlink commands in "vnic reporter" section in code blocks to be consistent with other devlink command snippets. Fixes: b0bc615df488ab ("net/mlx5: Add vnic devlink health reporter to PFs/VFs") Fixes: cf14af140a5ad0 ("net/mlx5e: Add vnic devlink health reporter to representors") Reviewed-by: Leon Romanovsky Signed-off-by: Bagas Sanjaya Reviewed-by: Simon Horman --- .../device_drivers/ethernet/mellanox/mlx5/devlink.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst b/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst index 3a7a714cc08f0a..0f0598caea145f 100644 --- a/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst +++ b/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst @@ -283,10 +283,14 @@ nic_receive_steering_discard: number of packets that completed RX flow steering but were discarded due to a mismatch in flow table. User commands examples: -- Diagnose PF/VF vnic counters + +- Diagnose PF/VF vnic counters:: + $ devlink health diagnose pci/0000:82:00.1 reporter vnic + - Diagnose representor vnic counters (performed by supplying devlink port of the - representor, which can be obtained via devlink port command) + representor, which can be obtained via devlink port command):: + $ devlink health diagnose pci/0000:82:00.1/65537 reporter vnic NOTE: This command can run over all interfaces such as PF/VF and representor ports. From patchwork Wed May 10 03:54:13 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 13236289 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 8C62EC7EE2A for ; Wed, 10 May 2023 03:55:55 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S236000AbjEJDzx (ORCPT ); Tue, 9 May 2023 23:55:53 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53282 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235893AbjEJDzF (ORCPT ); Tue, 9 May 2023 23:55:05 -0400 Received: from mail-pf1-x430.google.com (mail-pf1-x430.google.com [IPv6:2607:f8b0:4864:20::430]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 98B8C5FC1; Tue, 9 May 2023 20:54:36 -0700 (PDT) Received: by mail-pf1-x430.google.com with SMTP id d2e1a72fcca58-64115eef620so47259750b3a.1; Tue, 09 May 2023 20:54:36 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1683690876; x=1686282876; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=RrruFyLLgJJMJgx5u7sEynKf36MmMk0i/j9iaoKs+9E=; b=A/r04JqUZep5KvkgYVpgT8GvIxTLL5xMq1m8jz2fbJMyc+Tn2NeK9zK2UVsyuf//pD HXe1n1zUJBeIZ3kpjMTJ6U05UNQM4Cfj+1dneYS17EnMZDhSuWDRHMwGeYuVna2DnUHC UZ1SFrvKwb7XFnpOeNT8ihdfvN/MEYhlumRqMRecTPSaAcngngthUEVAf5j7ccZrD6LP 5ImyIzG+XVb7gUeb2nj/+tO0Pj1bCHZP5HPfZQVhMELFQ3S6y9vxq3QPu9zuOoqon18C GOgoyafz7hJl0mRaHdWUqsSs8jw17iJtH1Iq9gCMk5CNt6Bmba7CnyDRxdne8NXmhKS7 3CVA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683690876; x=1686282876; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=RrruFyLLgJJMJgx5u7sEynKf36MmMk0i/j9iaoKs+9E=; b=UCbwO1h+CcnW9Fx+JW9joyKsmNXsR76CGy0VwbIRXw0jB9cLNaKlkWNPwKuurR+m2i Mvvl+i000VPK03rqCwqvA6DReWsP4e8yXoYbEmcBqV/gLx2jxCC5gSPL7uCEsWs/XF3L P/COOfApelF2IQfETpQfr7mN6JnYr6kaFOSg/WI8LEEE+dA9tl1B0nf/SqYuZ9OaLzQV oCBMxgz9sxDSJjEBKwjhIwAbpnIdZ8mHe9LO5szAjfJsoqL1CL65roH9MeqVh6+/q/rA 48RELz8k3mEZc/yC7nc9MdfOahCDg6mPF4lIIuYbQjM+QTk+z/kX4CLEBtiWw0Vup1vw XVhQ== X-Gm-Message-State: AC+VfDy35r/7a6zRZz6JHocfrzPrdwpVE/M2LwPEW+IHYJ3kFpla0LO4 TnWNjFTNoNoPmS523adWZ94= X-Google-Smtp-Source: ACHHUZ5yOZmYLWXZY122w/MJgciElXT98GlE1D13KqOurL+OEM0S8WnDY2Fsm3I+elnnfuSIjch1fQ== X-Received: by 2002:a17:902:e848:b0:1a9:5674:281c with SMTP id t8-20020a170902e84800b001a95674281cmr21389486plg.23.1683690876007; Tue, 09 May 2023 20:54:36 -0700 (PDT) Received: from debian.me (subs32-116-206-28-21.three.co.id. [116.206.28.21]) by smtp.gmail.com with ESMTPSA id h11-20020a170902b94b00b00194d14d8e54sm2491291pls.96.2023.05.09.20.54.34 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 09 May 2023 20:54:34 -0700 (PDT) Received: by debian.me (Postfix, from userid 1000) id 109A4106868; Wed, 10 May 2023 10:54:29 +0700 (WIB) From: Bagas Sanjaya To: Linux Networking , Remote Direct Memory Access Kernel Subsystem , Linux Documentation , Linux Kernel Mailing List Cc: Saeed Mahameed , Leon Romanovsky , "David S. Miller" , Eric Dumazet , Jakub Kicinski , Paolo Abeni , Jonathan Corbet , Bagas Sanjaya , Gal Pressman , Rahul Rameshbabu , Maher Sanalla , Moshe Shemesh , Tariq Toukan , Leon Romanovsky Subject: [PATCH net v2 2/4] Documentation: net/mlx5: Use bullet and definition lists for vnic counters description Date: Wed, 10 May 2023 10:54:13 +0700 Message-Id: <20230510035415.16956-3-bagasdotme@gmail.com> X-Mailer: git-send-email 2.40.1 In-Reply-To: <20230510035415.16956-1-bagasdotme@gmail.com> References: <20230510035415.16956-1-bagasdotme@gmail.com> MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=2777; i=bagasdotme@gmail.com; h=from:subject; bh=NEIhd+5K/G8nrmt5Y9QAggc3+/Jm4hr2uEYbbziVrlI=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDCnRomnsljt3uUY2G63fmvDDwshZ+0OIqOSfkLxckXd7m y7OeWPbUcrCIMbFICumyDIpka/p9C4jkQvtax1h5rAygQxh4OIUgInwH2D4Z1bzqPd12GzbnWd3 u+fOcUiTN2iLPnlnbq/W7UubWrPXzWJk6J/jxPhUYxXjnmf2vrpKCdPPBDs+riq2P960q/TEirX TeAE= X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D Precedence: bulk List-ID: X-Mailing-List: linux-rdma@vger.kernel.org "vnic reporter" section contains unformatted description for vnic counters, which is rendered as one long paragraph instead of list. Use bullet and definition lists to match other lists. Fixes: b0bc615df488ab ("net/mlx5: Add vnic devlink health reporter to PFs/VFs") Reviewed-by: Leon Romanovsky Signed-off-by: Bagas Sanjaya Reviewed-by: Simon Horman Reviewed-by: Daniel Machon --- .../ethernet/mellanox/mlx5/devlink.rst | 36 ++++++++++--------- 1 file changed, 20 insertions(+), 16 deletions(-) diff --git a/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst b/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst index 0f0598caea145f..00687425d8b72d 100644 --- a/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst +++ b/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst @@ -265,22 +265,26 @@ It is responsible for querying the vnic diagnostic counters from fw and displayi them in realtime. Description of the vnic counters: -total_q_under_processor_handle: number of queues in an error state due to -an async error or errored command. -send_queue_priority_update_flow: number of QP/SQ priority/SL update -events. -cq_overrun: number of times CQ entered an error state due to an -overflow. -async_eq_overrun: number of times an EQ mapped to async events was -overrun. -comp_eq_overrun: number of times an EQ mapped to completion events was -overrun. -quota_exceeded_command: number of commands issued and failed due to quota -exceeded. -invalid_command: number of commands issued and failed dues to any reason -other than quota exceeded. -nic_receive_steering_discard: number of packets that completed RX flow -steering but were discarded due to a mismatch in flow table. + +- total_q_under_processor_handle + number of queues in an error state due to + an async error or errored command. +- send_queue_priority_update_flow + number of QP/SQ priority/SL update events. +- cq_overrun + number of times CQ entered an error state due to an overflow. +- async_eq_overrun + number of times an EQ mapped to async events was overrun. + comp_eq_overrun number of times an EQ mapped to completion events was + overrun. +- quota_exceeded_command + number of commands issued and failed due to quota exceeded. +- invalid_command + number of commands issued and failed dues to any reason other than quota + exceeded. +- nic_receive_steering_discard + number of packets that completed RX flow + steering but were discarded due to a mismatch in flow table. User commands examples: From patchwork Wed May 10 03:54:14 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 13236288 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 318D0C7EE2F for ; Wed, 10 May 2023 03:55:53 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235742AbjEJDzv (ORCPT ); Tue, 9 May 2023 23:55:51 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53566 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235889AbjEJDzF (ORCPT ); Tue, 9 May 2023 23:55:05 -0400 Received: from mail-pf1-x42d.google.com (mail-pf1-x42d.google.com [IPv6:2607:f8b0:4864:20::42d]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id DAC995B96; Tue, 9 May 2023 20:54:35 -0700 (PDT) Received: by mail-pf1-x42d.google.com with SMTP id d2e1a72fcca58-64115eef620so47259703b3a.1; Tue, 09 May 2023 20:54:35 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1683690875; x=1686282875; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=XXgB95iPLzJ/tlk3w3xSxODJBuQl2H1bImz8SZLBe2U=; b=fppuMHunGM3ALMUmv/eD3q1g4ZabQLzf4xTipRpcr9DrJbjJWNH/uZ40bTGb986QDg b0Q3Gb76I4mFqXrVqYs7TK+5itfDARNJmbWdBnfgJbVgcN+31OEEnGlOJEZ4qLE9QRyq YrMDkbkdOdymuiSlLiSPKBYsknIRdwvk1K+uuiFGihyR1nnpkUIK5HmgHNN4KR/xG1Ps cAmFC10sEOTV31W5224OK52gS4vbWsJN718DRyUR9u3LjXY+0PTHfid+r+SGnjRQfL02 2YvpumxK8dZOyYVksOI6tYlsVlvKHmXjqSHP47rkm10icKGEUoJUzkXDGKeYYCa4nMqG Rx4g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683690875; x=1686282875; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=XXgB95iPLzJ/tlk3w3xSxODJBuQl2H1bImz8SZLBe2U=; b=YX6PM3OnLz1rsMvqP1PfLR4RhgZinIzuZO/GVJBCpO+oDxCWNSkI/QrB4CxOBJEZHZ zOT9965rAQn7KviwWyJ7XLg+3xMEDkW3/PGCIsVfK+iPfhhrAHzf2bemqCx8A37CDYf9 H6379ZDv7XB0++g4MYtaB6QZX2MyKV76ZEt59x1/+nrrt3SLECVxmoLZ5AQWROAcqpz+ OFb7g5VxqPcJLOpG0IPbx4LNB99mkkWp4q+WU1P86t/msh7O0JP2o5MWrNbl2mclynTk dGA4KGQSqAwiieve3ItSa9TDJWVKJI3Eb/AF8Ci/yoZJmLAhTK94cyM2zt/1OhuGHGp+ zfYA== X-Gm-Message-State: AC+VfDyrufzi4VHEmF5OM7HESNmWRaMSZ4xql8j5l5ZvJoz9RAt4Y6TP PMTli2gPovBZdDZ4gTG2W9E= X-Google-Smtp-Source: ACHHUZ5+C8CORNN8mfRtmU81gVQChpXWShxrVMo3TdIHre4tjcD/02Nl2Yp0Br5jZ4aAj5/N3RREMg== X-Received: by 2002:a17:902:ecd0:b0:1ac:76a6:a1f with SMTP id a16-20020a170902ecd000b001ac76a60a1fmr11462613plh.16.1683690875346; Tue, 09 May 2023 20:54:35 -0700 (PDT) Received: from debian.me (subs32-116-206-28-21.three.co.id. [116.206.28.21]) by smtp.gmail.com with ESMTPSA id a2-20020a170902ecc200b0019cbe436b87sm2504224plh.81.2023.05.09.20.54.33 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 09 May 2023 20:54:34 -0700 (PDT) Received: by debian.me (Postfix, from userid 1000) id 38D00106AA2; Wed, 10 May 2023 10:54:29 +0700 (WIB) From: Bagas Sanjaya To: Linux Networking , Remote Direct Memory Access Kernel Subsystem , Linux Documentation , Linux Kernel Mailing List Cc: Saeed Mahameed , Leon Romanovsky , "David S. Miller" , Eric Dumazet , Jakub Kicinski , Paolo Abeni , Jonathan Corbet , Bagas Sanjaya , Gal Pressman , Rahul Rameshbabu , Maher Sanalla , Moshe Shemesh , Tariq Toukan , Leon Romanovsky Subject: [PATCH net v2 3/4] Documentation: net/mlx5: Add blank line separator before numbered lists Date: Wed, 10 May 2023 10:54:14 +0700 Message-Id: <20230510035415.16956-4-bagasdotme@gmail.com> X-Mailer: git-send-email 2.40.1 In-Reply-To: <20230510035415.16956-1-bagasdotme@gmail.com> References: <20230510035415.16956-1-bagasdotme@gmail.com> MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=1636; i=bagasdotme@gmail.com; h=from:subject; bh=lHfWy6PKdcXAMfDKFqmfoQvlo1/8l2cm35LI5C7u80A=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDCnRomlt174edNw8Q+xiQM70kyy/pV4UPeYO6I4WX2/Fo Ws0i9Oso5SFQYyLQVZMkWVSIl/T6V1GIhfa1zrCzGFlAhnCwMUpABNhSmFk+PSFVen/o38vY0rX H3goc0EwXXNhnMompaKFNhNUCg45f2b4X5E1+1yNochbcaG5bTvin+jM7vn2bO80trNKb2ZZT/v awAIA X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D Precedence: bulk List-ID: X-Mailing-List: linux-rdma@vger.kernel.org The doc forgets to add separator before numbered lists, which causes the lists to be appended to previous paragraph inline instead. Add the missing separator. Fixes: f2d51e579359b7 ("net/mlx5: Separate mlx5 driver documentation into multiple pages") Reviewed-by: Leon Romanovsky Signed-off-by: Bagas Sanjaya Reviewed-by: Simon Horman --- .../device_drivers/ethernet/mellanox/mlx5/devlink.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst b/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst index 00687425d8b72d..f962c0975d8428 100644 --- a/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst +++ b/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst @@ -40,6 +40,7 @@ flow_steering_mode: Device flow steering mode --------------------------------------------- The flow steering mode parameter controls the flow steering mode of the driver. Two modes are supported: + 1. 'dmfs' - Device managed flow steering. 2. 'smfs' - Software/Driver managed flow steering. @@ -99,6 +100,7 @@ between representors and stacked devices. By default metadata is enabled on the supported devices in E-switch. Metadata is applicable only for E-switch in switchdev mode and users may disable it when NONE of the below use cases will be in use: + 1. HCA is in Dual/multi-port RoCE mode. 2. VF/SF representor bonding (Usually used for Live migration) 3. Stacked devices From patchwork Wed May 10 03:54:15 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 13236286 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 97A20C7EE26 for ; Wed, 10 May 2023 03:55:50 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235987AbjEJDzr (ORCPT ); Tue, 9 May 2023 23:55:47 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53486 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235796AbjEJDzE (ORCPT ); Tue, 9 May 2023 23:55:04 -0400 Received: from mail-pf1-x436.google.com (mail-pf1-x436.google.com [IPv6:2607:f8b0:4864:20::436]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 8D4CD449E; Tue, 9 May 2023 20:54:35 -0700 (PDT) Received: by mail-pf1-x436.google.com with SMTP id d2e1a72fcca58-643990c5319so4739981b3a.2; Tue, 09 May 2023 20:54:35 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1683690875; x=1686282875; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=R13pX/DGcCdpBhTHhkY/bwvkemgqqVgL5MNqBdrIkZg=; b=N8pYwznN3q0/cFkfWSKza0gMaDhy49xdZcF4lJMjg7rhksfRPSi2RogyCuQ5AiszzL aXs0fdwIR1AgDPlA1pKhrSKC4CpeyjxvhGWOU9WSvgEciHjSrleoxDdpgkW/8eiPmZrT sbGO92hYspswPL7S0cQwhgy1+TBUWhq9++Mer52I9GdvG+Sq4Pl5bE4NMwrqNmk9hGow c4IaFtLN3DNPpe70tRVh35OXinZlmr1dEeDMYw6+nghqsjCyPYiLaAz/3w6z+wisn/Ih dbeoUxYZu7PVi8o0Sg0qc1vx9k1UNo3SgqY4qDak2+LgmnSTYNow7NwwYuXBItRXvFqG bsJw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683690875; x=1686282875; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=R13pX/DGcCdpBhTHhkY/bwvkemgqqVgL5MNqBdrIkZg=; b=c/2DB683SOWwmeuTko80jL3FRPO75R69p9sEujscVSI3o5TaHX7z5F9imc0R9ezrie fi8SuBw3271rno3OiXR/Nrie9dO4kKQ5YbUiMDFCt0pb7Ge7A11/FChwV5VAdZ8jfSde 1gkpTePFelUgwayxEB1xTiUYk69Cw43flIf3rMF1LqWz0/9yfygWfapCSeLIO0wmo6Q3 +l+vWituFzAmOn1eOrl5rwcVqYFgMctwSrhuishCpk/xbrZQy3AxZDY7jUU5FzqSntqn vjYeo6xFB5IN3RKWGoaqXNavTuXcOInoAZv/O/Fgp0bDGLUEku03KLVCvSwcBAhN/Ysw BfrA== X-Gm-Message-State: AC+VfDwxYWgoNAO4izk9knClwFQeesUUVhCQlTMLIG7tz5n84TSa9Wkt fJvu+waKtazkZ4X2FjZmm1A8Vh5VGQY= X-Google-Smtp-Source: ACHHUZ5W9wYsjCCZhsT/xp9lkRTManF2E6Q7o4gbGzsRoYrMq1jpzmmds9ChpKMC4gw4PwXdwR1hrg== X-Received: by 2002:a05:6a21:6d9d:b0:102:31fc:918c with SMTP id wl29-20020a056a216d9d00b0010231fc918cmr1805754pzb.45.1683690874840; Tue, 09 May 2023 20:54:34 -0700 (PDT) Received: from debian.me (subs32-116-206-28-21.three.co.id. [116.206.28.21]) by smtp.gmail.com with ESMTPSA id f5-20020a655505000000b0052c9998ec2asm2021286pgr.68.2023.05.09.20.54.33 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 09 May 2023 20:54:34 -0700 (PDT) Received: by debian.me (Postfix, from userid 1000) id 7FDD3106AA1; Wed, 10 May 2023 10:54:29 +0700 (WIB) From: Bagas Sanjaya To: Linux Networking , Remote Direct Memory Access Kernel Subsystem , Linux Documentation , Linux Kernel Mailing List Cc: Saeed Mahameed , Leon Romanovsky , "David S. Miller" , Eric Dumazet , Jakub Kicinski , Paolo Abeni , Jonathan Corbet , Bagas Sanjaya , Gal Pressman , Rahul Rameshbabu , Maher Sanalla , Moshe Shemesh , Tariq Toukan , Leon Romanovsky Subject: [PATCH net v2 4/4] Documentation: net/mlx5: Wrap notes in admonition blocks Date: Wed, 10 May 2023 10:54:15 +0700 Message-Id: <20230510035415.16956-5-bagasdotme@gmail.com> X-Mailer: git-send-email 2.40.1 In-Reply-To: <20230510035415.16956-1-bagasdotme@gmail.com> References: <20230510035415.16956-1-bagasdotme@gmail.com> MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=2454; i=bagasdotme@gmail.com; h=from:subject; bh=amgu7llNkvOpANFlqUZo94YkdrbPN8Lwojtmp8pNSjY=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDCnRomkpYt8bNs16aM+88Tlf87e2tA7ZTfYrOd+kXTgcf Nz29o+yjlIWBjEuBlkxRZZJiXxNp3cZiVxoX+sIM4eVCWQIAxenAEzEZz0jw9NZ0U8Ezz1vFlho mfhRz73oiPfuV0kWpbMn7VOyuW+o5MbwP/b/qfSbL+d7TV2YtvQnu/Mho+lThLh9Jffu2bzOmG2 VIxcA X-Developer-Key: i=bagasdotme@gmail.com; a=openpgp; fpr=701B806FDCA5D3A58FFB8F7D7C276C64A5E44A1D Precedence: bulk List-ID: X-Mailing-List: linux-rdma@vger.kernel.org Wrap note paragraphs in note:: directive as it better fit for the purpose of noting devlink commands. Fixes: f2d51e579359b7 ("net/mlx5: Separate mlx5 driver documentation into multiple pages") Fixes: cf14af140a5ad0 ("net/mlx5e: Add vnic devlink health reporter to representors") Reviewed-by: Leon Romanovsky Signed-off-by: Bagas Sanjaya --- .../ethernet/mellanox/mlx5/devlink.rst | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst b/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst index f962c0975d8428..3354ca3608ee67 100644 --- a/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst +++ b/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst @@ -182,7 +182,8 @@ User commands examples: $ devlink health diagnose pci/0000:82:00.0 reporter tx -NOTE: This command has valid output only when interface is up, otherwise the command has empty output. +.. note:: + This command has valid output only when interface is up, otherwise the command has empty output. - Show number of tx errors indicated, number of recover flows ended successfully, is autorecover enabled and graceful period from last recover:: @@ -234,8 +235,9 @@ User commands examples: $ devlink health dump show pci/0000:82:00.0 reporter fw -NOTE: This command can run only on the PF which has fw tracer ownership, -running it on other PF or any VF will return "Operation not permitted". +.. note:: + This command can run only on the PF which has fw tracer ownership, + running it on other PF or any VF will return "Operation not permitted". fw fatal reporter ----------------- @@ -258,7 +260,8 @@ User commands examples: $ devlink health dump show pci/0000:82:00.1 reporter fw_fatal -NOTE: This command can run only on PF. +.. note:: + This command can run only on PF. vnic reporter ------------- @@ -299,4 +302,5 @@ User commands examples: $ devlink health diagnose pci/0000:82:00.1/65537 reporter vnic -NOTE: This command can run over all interfaces such as PF/VF and representor ports. +.. note:: + This command can run over all interfaces such as PF/VF and representor ports.