From patchwork Wed May 3 09:42:46 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 13229982 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 4EB70C77B7F for ; Wed, 3 May 2023 09:43:38 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229729AbjECJnh (ORCPT ); Wed, 3 May 2023 05:43:37 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:41894 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229873AbjECJnb (ORCPT ); Wed, 3 May 2023 05:43:31 -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 3F1AA5263; Wed, 3 May 2023 02:43:10 -0700 (PDT) Received: by mail-pj1-x1032.google.com with SMTP id 98e67ed59e1d1-24df4ecdb87so2530739a91.0; Wed, 03 May 2023 02:43:10 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1683106989; x=1685698989; 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=lf1muhsbXKVkAwjXlKT/F7FUM0glVIhlYmlwBoDu1aY=; b=YM2916vWfm7x9AMOkdWOmzG7o1YqSh7s6l13OGUlMKGKTJyEHUVKWOM8ufj9V5kGxG SMyufMgf0+DpWUzDcvkWrZ/H4Itx+Xcwm2u9Jh5Z2iDrVhq+0vnevfZPzuPAfqwDYkph tBQ2mUauBjlpMdfihD3aFsniVPRxhu16sPa35HS/wX3yG/3+lG/jnKSCx4HHDp/Ma5Ad WQHWHtcwWoXShw824+Hx3TQ9GNlX2a6VZgV1Z6WQDGDdu+Zj7cQXrl0YC6tj8dFHLFN+ EGgXcikNnR5N52veoo3UmYAG5+CUK6cmw+Ohkfiafw4mg+nDVOUJmo1vcxiqhwwgthIy CzUQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683106989; x=1685698989; 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=lf1muhsbXKVkAwjXlKT/F7FUM0glVIhlYmlwBoDu1aY=; b=WUbW//fzFsMc0J/GDRZsi+lGI/ckEYZUehzLj1b6rXyUfaCLoA0L9GgIhpwuQhbK7J Iwvd3Bq/vVysp3WHyxsCmovcFAzUvufp8YsPyTQwP+STx+HAmmRaSNTwP6YfZeXyWBgy nbeE3iK9UVaSMuEwISOldoGXenzfxZBx1zsbC5P/qjFD8an8tkAAyS6pme5t8mgn+Tm/ HUgKLQRLkX7AvlOTj/anfkY5j5yvbrXSyFhGB15tmTNfFKuzd42ZH85vSRpk2XImgVB2 UqhJe+ILLwFK3yaJlL3A7RQY+TRrULVmlgjPJVicjDxyl9jOMa06ybm6wLYp+2yCfD95 gYjw== X-Gm-Message-State: AC+VfDwDYtNNNpKwxtreQxGefeXtlG110Ri/G2CvnitDmkz9OLLsUGPe fCTfyAbdUC50o4kMs7u45DM= X-Google-Smtp-Source: ACHHUZ6D3bEwAna5pJ35KiqvNz1/3tcxtz47rD6lwT8t6NI81BCMEJ7K454Tv1UfL8Rgdp0GnF9Xkw== X-Received: by 2002:a17:90a:7f82:b0:23a:ad68:25a7 with SMTP id m2-20020a17090a7f8200b0023aad6825a7mr20214530pjl.2.1683106989559; Wed, 03 May 2023 02:43:09 -0700 (PDT) Received: from debian.me (subs03-180-214-233-11.three.co.id. [180.214.233.11]) by smtp.gmail.com with ESMTPSA id pf8-20020a17090b1d8800b00247abbb157fsm942966pjb.31.2023.05.03.02.43.08 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 03 May 2023 02:43:08 -0700 (PDT) Received: by debian.me (Postfix, from userid 1000) id A25321055AC; Wed, 3 May 2023 16:43:04 +0700 (WIB) From: Bagas Sanjaya To: Linux Networking , Linux Random Direct Memory Access , Linux Documentation , Linux Networking Cc: Saeed Mahameed , Leon Romanovsky , "David S. Miller" , Eric Dumazet , Jakub Kicinski , Paolo Abeni , Jonathan Corbet , Bagas Sanjaya , Gal Pressman , Tariq Toukan , Maher Sanalla , Rahul Rameshbabu , Moshe Shemesh Subject: [PATCH net 1/4] Documentation: net/mlx5: Wrap vnic reporter devlink commands in code blocks Date: Wed, 3 May 2023 16:42:46 +0700 Message-Id: <20230503094248.28931-2-bagasdotme@gmail.com> X-Mailer: git-send-email 2.40.1 In-Reply-To: <20230503094248.28931-1-bagasdotme@gmail.com> References: <20230503094248.28931-1-bagasdotme@gmail.com> MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=2073; i=bagasdotme@gmail.com; h=from:subject; bh=tMWudNgiUasGarVpCzAepBusDqbWwgKJHD+hWHPr4uY=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDClBOtMEvaW5Txo2aX94pLHw1pwXE+R+/np0NVBwkYSE1 Kzl0w24O0pZGMS4GGTFFFkmJfI1nd5lJHKhfa0jzBxWJpAhDFycAjCRqc4M/2OcC4RdFe7dFnE/ 670zTYTvotamKcni+QFFfydv2HcpUZWRYeexBza9y8Ryz6r/9P2UtIrdNHjR8g2ianyTTFzecl5 I5AQA 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") Signed-off-by: Bagas Sanjaya Reviewed-by: Leon Romanovsky --- .../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 3 09:42:47 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 13229979 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 36DA5C77B7F for ; Wed, 3 May 2023 09:43:35 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229964AbjECJnd (ORCPT ); Wed, 3 May 2023 05:43:33 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:41948 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229721AbjECJn3 (ORCPT ); Wed, 3 May 2023 05:43:29 -0400 Received: from mail-pf1-x42f.google.com (mail-pf1-x42f.google.com [IPv6:2607:f8b0:4864:20::42f]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id B48444EEA; Wed, 3 May 2023 02:43:09 -0700 (PDT) Received: by mail-pf1-x42f.google.com with SMTP id d2e1a72fcca58-643557840e4so125396b3a.2; Wed, 03 May 2023 02:43:09 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1683106989; x=1685698989; 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=YDPdE1XfunQuIWf3y/jI9wckA1ok4K+KpzHULl9/uio=; b=HL/GfVZ1j0oM8h89CjN4LkrI5tvOMRtAg/+7+kXwp1OWEq8ugwhTv/zxOsUSPPsz1J 0sRhx2D1DKB+BswYH9qJxd/DDgsbyZXHlQgWN7oLD79MkxoI032udyTMzkBrgtrB6o50 gd9ZZaz9OpLG3gWTbkkXn+31f1GTXo0nrHxp31RVvPR7MvciYHYJrJ8EVEpSCxf/zFKl W/q8aUN7NG/0zL62+N6TZWSlFSnFBjwAian6Bg/xj7WgG54+5KFJ6U6Wzw6+6whxMRCR 6K9K31f3eWQDumMdikCjGk+wC4KZ1jcG7y8XkXZWlFLqnIsiyXXQvhDtCnOKqEoND7eg b/wQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683106989; x=1685698989; 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=YDPdE1XfunQuIWf3y/jI9wckA1ok4K+KpzHULl9/uio=; b=K2mnyg49GZS1D2ngYoTZI+PBdjcgh8r3gEuqnvs597mK8iEuoQ/o2Pi3vvYITYqhgX wiGg/vVpWJWA2IC+4L0IKzeg0pgzm1yZuDvsbDIby+6G2DZLcuOWYAyr72g7MdOpNUqO NICKnEERgM9U9EXeMkK3imfb+EOxKu1o3OTxJL1n5FoRHy/NfNT+mEk1rGt+X9DPEhoU IEGfyypDS9GK5+SCsHFvL4OI6ReJk1PfoHRBQArsUp5j2wDFYdUMXNbVACHKVbGHUBGp TmIUlwjydSFsUVQ6nYqPpzK43wGBIX/FKm0uNaXBGxehbpSL8e5SmsoSHtxvLl+7LUm8 9K0g== X-Gm-Message-State: AC+VfDw9IHvaGWRetdgBacWFrEOYgLAFLDu3mKzp7qO6MAIwcAoKECih qCDr+czY9iJe8kb5aX18kKM= X-Google-Smtp-Source: ACHHUZ6xRNyfm7gpGVKaUHMZJ7cSmuq4Z8ooUCKyV4KAI7QHB/0nJ6BiXsACOMDXzMYCIJ7kwjsjxg== X-Received: by 2002:a05:6a00:2d1b:b0:63b:854c:e0f6 with SMTP id fa27-20020a056a002d1b00b0063b854ce0f6mr30151178pfb.21.1683106989056; Wed, 03 May 2023 02:43:09 -0700 (PDT) Received: from debian.me (subs03-180-214-233-11.three.co.id. [180.214.233.11]) by smtp.gmail.com with ESMTPSA id g10-20020a62f94a000000b00640df8c536csm16903809pfm.12.2023.05.03.02.43.08 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 03 May 2023 02:43:08 -0700 (PDT) Received: by debian.me (Postfix, from userid 1000) id 0857D10624F; Wed, 3 May 2023 16:43:04 +0700 (WIB) From: Bagas Sanjaya To: Linux Networking , Linux Random Direct Memory Access , Linux Documentation , Linux Networking Cc: Saeed Mahameed , Leon Romanovsky , "David S. Miller" , Eric Dumazet , Jakub Kicinski , Paolo Abeni , Jonathan Corbet , Bagas Sanjaya , Gal Pressman , Tariq Toukan , Maher Sanalla , Rahul Rameshbabu , Moshe Shemesh Subject: [PATCH net 2/4] Documentation: net/mlx5: Use bullet and definition lists for vnic counters description Date: Wed, 3 May 2023 16:42:47 +0700 Message-Id: <20230503094248.28931-3-bagasdotme@gmail.com> X-Mailer: git-send-email 2.40.1 In-Reply-To: <20230503094248.28931-1-bagasdotme@gmail.com> References: <20230503094248.28931-1-bagasdotme@gmail.com> MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=2727; i=bagasdotme@gmail.com; h=from:subject; bh=o+hJBFwjrfn3zz2fGYB3tCdijJYNrT6XMKn3YVD2Ts4=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDClBOtM5w48VX3rWwS4yYemDwhrD01LnNvXGfPVmOW81f eFStoAlHaUsDGJcDLJiiiyTEvmaTu8yErnQvtYRZg4rE8gQBi5OAZjIOTmG/xFlUvv2dh87Pl3n y5rZbyxKWt+pyKTd/h7Oei8lYN/zaWcY/hczM95pvsSxUUrj8v2W9dXsJ7+0Z7GXae0w2cq781W NExMA 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") Signed-off-by: Bagas Sanjaya Reviewed-by: Leon Romanovsky --- .../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 3 09:42:48 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 13229980 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 38867C7EE26 for ; Wed, 3 May 2023 09:43:36 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229967AbjECJne (ORCPT ); Wed, 3 May 2023 05:43:34 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:41950 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229741AbjECJn3 (ORCPT ); Wed, 3 May 2023 05:43:29 -0400 Received: from mail-pf1-x429.google.com (mail-pf1-x429.google.com [IPv6:2607:f8b0:4864:20::429]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 393D9525E; Wed, 3 May 2023 02:43:10 -0700 (PDT) Received: by mail-pf1-x429.google.com with SMTP id d2e1a72fcca58-63b60366047so3517270b3a.1; Wed, 03 May 2023 02:43:10 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1683106989; x=1685698989; 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=VdsI+hHV1SMet6yGeXUXOJdAJPqVlRG1VZCMzWt5U/M=; b=RUGLltaJzJHfMlOrUd7mLzmkL+OCnUg8YTR4vdy9KmncZFHMf27GhuScl9aFI9cpnX oMEIOWxz8M4uAnRbiA8JjcTtzC2hFo1oO9FSaCtXniYO2Qtv536bGWmI+ps3pKSbhtDZ 4GAouanyptWEIWyES8oGEbJdBucmuRMzp9gqTBGuOSD6NLQSoSuwyhs4BYzxa1zmHP+S l5DIBFZyuQ6aFGk5YxjTgrb+uvndEMdaE8Yk27OppRECTHaVuEci/88lqt1X1R541kdU XAmgjhlZIRc9qMG6gOobcg/41yA6xj+bwEmRlVSCipW1uiAIvbqU9avyMPXACuv9zfbF JabA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683106989; x=1685698989; 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=VdsI+hHV1SMet6yGeXUXOJdAJPqVlRG1VZCMzWt5U/M=; b=gfkZrfEeTNJYVVsuJIN/QAviBAihwH+juOXS7YLwmhqid8l2dw7to5NrhipQeiU8Jk 2Qbl8qK/zUCdWzr6ztJsr5aUf83RQOl9a6hEjB3gCq4iAvARqDtVLtqNvpW8itUXQeN/ 9awH3Xfda7ceSHiPU+BIbvw4s5fPuvhMf0woPeZBviAfmfVzbXFJy3/VyGRiztL1U+xP op12S2QtSAur/x6sm/7dlwHEpv2pBTNGApR1/7X3Pysc0/pEXESCL5BbZYNfR3WBbzwZ gdEnRNNPKRChh/qppwnHRMNoTZU+VgBeJpmZhjwnsWP5X3USnhIztcHYMZTZuBicdSfV rRVQ== X-Gm-Message-State: AC+VfDymNdDez5o8T4TJbSu9KweCespIGDRRShMwnxWoQwYcIpeJf/2T ArCjaEXPP1M8QSvF2sUi4Ag= X-Google-Smtp-Source: ACHHUZ5IqNxLGOmjmTTtU8NedjrsbKCHPIyEkw64UhHFJJMJAy5lwynVr/PZaidTFYzXNcSTzEfHVw== X-Received: by 2002:a05:6a00:1a55:b0:63b:7ac8:1be4 with SMTP id h21-20020a056a001a5500b0063b7ac81be4mr29927714pfv.25.1683106989398; Wed, 03 May 2023 02:43:09 -0700 (PDT) Received: from debian.me (subs03-180-214-233-11.three.co.id. [180.214.233.11]) by smtp.gmail.com with ESMTPSA id j12-20020a056a00174c00b00634b91326a9sm23972464pfc.143.2023.05.03.02.43.08 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 03 May 2023 02:43:08 -0700 (PDT) Received: by debian.me (Postfix, from userid 1000) id DBE1A10624C; Wed, 3 May 2023 16:43:04 +0700 (WIB) From: Bagas Sanjaya To: Linux Networking , Linux Random Direct Memory Access , Linux Documentation , Linux Networking Cc: Saeed Mahameed , Leon Romanovsky , "David S. Miller" , Eric Dumazet , Jakub Kicinski , Paolo Abeni , Jonathan Corbet , Bagas Sanjaya , Gal Pressman , Tariq Toukan , Maher Sanalla , Rahul Rameshbabu , Moshe Shemesh Subject: [PATCH net 3/4] Documentation: net/mlx5: Add blank line separator before numbered lists Date: Wed, 3 May 2023 16:42:48 +0700 Message-Id: <20230503094248.28931-4-bagasdotme@gmail.com> X-Mailer: git-send-email 2.40.1 In-Reply-To: <20230503094248.28931-1-bagasdotme@gmail.com> References: <20230503094248.28931-1-bagasdotme@gmail.com> MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=1586; i=bagasdotme@gmail.com; h=from:subject; bh=cqUxta75B9+HXP24ZKCVQuvthnc3qFBlG7NEmCz80qo=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDClBOtNF3U1EZXzdRfxevsi99FO5cGf6/CW3rK5++H2e4 Qa/R65rRykLgxgXg6yYIsukRL6m07uMRC60r3WEmcPKBDKEgYtTACZyUpnhn+3XVNfrgR4iRba6 LMuLjbmCv570XD5bP0gw9tDUydLeLYwM051yVz4tSxWZu3mPUuNRgzcMu/O/1hsfEzkqJXqT30m IDwA= 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") Signed-off-by: Bagas Sanjaya Reviewed-by: Leon Romanovsky --- .../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 3 09:42:49 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 13229983 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 68B8FC7EE2F for ; Wed, 3 May 2023 09:43:39 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229993AbjECJnh (ORCPT ); Wed, 3 May 2023 05:43:37 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:41976 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229944AbjECJnb (ORCPT ); Wed, 3 May 2023 05:43:31 -0400 Received: from mail-pf1-x431.google.com (mail-pf1-x431.google.com [IPv6:2607:f8b0:4864:20::431]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 047784EEC; Wed, 3 May 2023 02:43:11 -0700 (PDT) Received: by mail-pf1-x431.google.com with SMTP id d2e1a72fcca58-643557840e4so125413b3a.2; Wed, 03 May 2023 02:43:10 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1683106990; x=1685698990; 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=0VT+PW1nO1R4tbtjQ+6VtJRHvR6DUPI/6keo1qQXgds=; b=EPuarUAyUlqvUaDzHr6GrG4a4tL+2ZIF4xM80RmPeqWLVNfnTiRxn82GfYUhEfagai wJw8ORzY03w0R6zdN8ToafRrgBNek0cYB4LMFLfOF2WnhhGAcb7IT2Jlw8xe6JnF/S0n vO32sxJgdQfRfPhoGmOXgJMd1OkmDgNyCwWf366382fratxHTLyqrjqsKdjPAWyvKTYG QIJ/mEEcdQTe+wnorS2oi5qmTtRWaB6XS/kbUSScgkOI1MBoB7mA8gnJLklbK/6mM3T9 eZRR21usZ988+muYdL0kxRYpqv3VdxG04JLTDeLn8p9GCDxxNZHDrw63pOFolObAqh9W LBbA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683106990; x=1685698990; 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=0VT+PW1nO1R4tbtjQ+6VtJRHvR6DUPI/6keo1qQXgds=; b=DPc4CV7WsQMAXllBsylCsVH9GxWxi64wLAz+Gh2G2MjVejRRpZny7RjgCcMKNhsUuI +YEeC34l30R7Su6+F+RbwQpqq5HDg6j8QTCZC6gbgQ1HLUymhgX3n8wTQ9cx3hI33m4+ es335S7C4OiC+6jqfhJTC6DdbvmqSGr785/t1C8TapWNsddAvoiPMk4Hvavk9e9ffqhR 1uJ8w7AW5us6oKS3/Z1H+nXtqClzKgOA0IZrhX+vXlbEuvNzPuWAM4BsKZuig2AomoMu ThaDkn/v+NOGkD8asPkWbGPFvZgedfYOGjHWfAVG8bIma/A6wMB6FlvkqRtRK+LDRVM4 JIyQ== X-Gm-Message-State: AC+VfDwjyV7FIfq9iSnujKE9ShjyE2a9YbKH1ZFGa8B+LwfBxKaJBbKP qF+VoIGe643snLTiq7sIlmo= X-Google-Smtp-Source: ACHHUZ7azennRTEMmDQZzC7RF31mRJNNMNHg8ghhGKKriy+OXImzVMZjCi09fcePVE2svjrD/G4uFA== X-Received: by 2002:aa7:888f:0:b0:63d:254a:3900 with SMTP id z15-20020aa7888f000000b0063d254a3900mr26121053pfe.5.1683106990331; Wed, 03 May 2023 02:43:10 -0700 (PDT) Received: from debian.me (subs03-180-214-233-11.three.co.id. [180.214.233.11]) by smtp.gmail.com with ESMTPSA id y189-20020a62cec6000000b00640defda6d2sm16512867pfg.207.2023.05.03.02.43.08 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 03 May 2023 02:43:08 -0700 (PDT) Received: by debian.me (Postfix, from userid 1000) id 210D610624E; Wed, 3 May 2023 16:43:04 +0700 (WIB) From: Bagas Sanjaya To: Linux Networking , Linux Random Direct Memory Access , Linux Documentation , Linux Networking Cc: Saeed Mahameed , Leon Romanovsky , "David S. Miller" , Eric Dumazet , Jakub Kicinski , Paolo Abeni , Jonathan Corbet , Bagas Sanjaya , Gal Pressman , Tariq Toukan , Maher Sanalla , Rahul Rameshbabu , Moshe Shemesh Subject: [PATCH net 4/4] Documentation: net/mlx5: Wrap notes in admonition blocks Date: Wed, 3 May 2023 16:42:49 +0700 Message-Id: <20230503094248.28931-5-bagasdotme@gmail.com> X-Mailer: git-send-email 2.40.1 In-Reply-To: <20230503094248.28931-1-bagasdotme@gmail.com> References: <20230503094248.28931-1-bagasdotme@gmail.com> MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=2404; i=bagasdotme@gmail.com; h=from:subject; bh=z7BlSEzjQe903TqQZUDLwk/+XO0cRAPBx+0vN2jCDQs=; b=owGbwMvMwCX2bWenZ2ig32LG02pJDClBOtO15qdsdy7eYSozd5lemVv8bvll782kWCOMgnq/L lB0DEjvKGVhEONikBVTZJmUyNd0epeRyIX2tY4wc1iZQIYwcHEKwETc1RgZFl/5kNLYVl4SnxW/ aonWbvdp6ppzmyf6ytwUVdHbqDBJlZHhTOybe0uec6qeeaO8Z6J4i9qc1mj+JaKnumdtY65Z6Rz CDwA= 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") Signed-off-by: Bagas Sanjaya Reviewed-by: Leon Romanovsky --- .../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.