From patchwork Tue Apr 24 16:58:08 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Hemminger X-Patchwork-Id: 38835 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 931E25B1C; Tue, 24 Apr 2018 18:58:27 +0200 (CEST) Received: from mail-pf0-f194.google.com (mail-pf0-f194.google.com [209.85.192.194]) by dpdk.org (Postfix) with ESMTP id CB0F54F92 for ; Tue, 24 Apr 2018 18:58:19 +0200 (CEST) Received: by mail-pf0-f194.google.com with SMTP id f189so3659555pfa.7 for ; Tue, 24 Apr 2018 09:58:19 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=bBfh4aWZijzCdCpMQfl8QOexxAyooxRImWr91sQQFN0=; b=XiTCRX/mSy25470lr+dCcCY9DYWurLqyXO4hjdnreY37WK9Ya6YavA9w3C/XxizkhK RdW3UbT3ze3zPs2id0fE4wGt7FMxWzb13fr4NV80dFMsFArc44GeUISasZK8mJujLluq V0aeZJ7Yjc62gcimaKQSmdmRK1+UUqfY3e8qQTPYZw7TrUAuyOWSZDJUoCbHbdC20HR1 QhwphHJjmWQPbrpDDLRKynwdwcLkgUmFXgMnc0pbunBi0MQx4U3/uh9+m1V/jwGBfCwN PlX2B/5aI4vRXTOn95PIOWYDzsH0FktsH10dmRZ5MpD9lZw+DHJZ5N+jfWi3g8Q3nrqK uTaA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=bBfh4aWZijzCdCpMQfl8QOexxAyooxRImWr91sQQFN0=; b=KxOVnAeI4Qhj2P2iFIU/EhlJ3PsGr0lXmjzeu2bdlQCj2kyO1rEGv6BMIPST02XHDX NLfV4TwASckmmHbCLHK3mkwmxDur5dgnt659gXih95P0CQKFd/VI483Jvmh/1ZH5Rna8 ryG2kx6Vzu9PElff+r1Zh8m+B1NomciijRaHmI8sRwoDWvfFEdYkZmG0Dk7qZFR9rLvS 5RmjDrzvoq36ejkUQ6Z8Sdoki8bgVLpi6PmLelnP2APtKUbiX0tAlJBqMhT1EvC7qbYs qjL2KT0nHLGsZxov2fStvt7MnQ1t6sdtCoPWorgUA4ehprOS58ltVxwr3OI4PodJAfkE nOzg== X-Gm-Message-State: ALQs6tBRmGc1Gy8t+i+3UB3YdVOkpvvkALMqWAA0QnJEet3b7JdJJNAI XXEoPaoBu6Xw3Znow8v39048F3qBTEs= X-Google-Smtp-Source: AIpwx49g9k7PiIg6WLgqNy+AzQQDMCFPQuGKBzWJjZGDjJUsVHUV4mbw6jSG/TYVkzz2hmyHECXQ9w== X-Received: by 10.99.137.74 with SMTP id v71mr21476503pgd.423.1524589098589; Tue, 24 Apr 2018 09:58:18 -0700 (PDT) Received: from xeon-e3.lan (204-195-71-95.wavecable.com. [204.195.71.95]) by smtp.gmail.com with ESMTPSA id a28sm19851114pfl.86.2018.04.24.09.58.17 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 24 Apr 2018 09:58:17 -0700 (PDT) From: Stephen Hemminger To: dev@dpdk.org Cc: Stephen Hemminger Date: Tue, 24 Apr 2018 09:58:08 -0700 Message-Id: <20180424165808.23292-6-stephen@networkplumber.org> X-Mailer: git-send-email 2.17.0 In-Reply-To: <20180424165808.23292-1-stephen@networkplumber.org> References: <20180424165808.23292-1-stephen@networkplumber.org> Subject: [dpdk-dev] [PATCH v2 5/5] doc: update guides for current preferrred log level syntax X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Use symbolic names and match rather than numbers and regex in the guides. Signed-off-by: Stephen Hemminger --- doc/guides/cryptodevs/dpaa2_sec.rst | 2 +- doc/guides/cryptodevs/dpaa_sec.rst | 2 +- doc/guides/faq/faq.rst | 23 ++++++++++------------- doc/guides/nics/dpaa2.rst | 4 ++-- doc/guides/nics/qede.rst | 2 +- doc/guides/nics/sfc_efx.rst | 12 ++++++------ doc/guides/nics/tap.rst | 2 +- 7 files changed, 22 insertions(+), 25 deletions(-) diff --git a/doc/guides/cryptodevs/dpaa2_sec.rst b/doc/guides/cryptodevs/dpaa2_sec.rst index 5558ea593e10..fcea48375912 100644 --- a/doc/guides/cryptodevs/dpaa2_sec.rst +++ b/doc/guides/cryptodevs/dpaa2_sec.rst @@ -211,7 +211,7 @@ For enabling logs, use the following EAL parameter: .. code-block:: console - ./your_crypto_application --log-level=pmd.crypto.dpaa2, + ./your_crypto_application --log-level=pmd.crypto.dpaa2: Using ``crypto.dpaa2`` as log matching criteria, all Crypto PMD logs can be enabled which are lower than logging ``level``. diff --git a/doc/guides/cryptodevs/dpaa_sec.rst b/doc/guides/cryptodevs/dpaa_sec.rst index 2964e83572eb..caf3d9cab2ac 100644 --- a/doc/guides/cryptodevs/dpaa_sec.rst +++ b/doc/guides/cryptodevs/dpaa_sec.rst @@ -154,7 +154,7 @@ For enabling logs, use the following EAL parameter: .. code-block:: console - ./your_crypto_application --log-level=pmd.crypto.dpaa, + ./your_crypto_application --log-level=pmd.crypto.dpaa: Using ``pmd.crypto.dpaa`` as log matching criteria, all Crypto PMD logs can be enabled which are lower than logging ``level``. diff --git a/doc/guides/faq/faq.rst b/doc/guides/faq/faq.rst index c1132fb4162f..f19c1389b6af 100644 --- a/doc/guides/faq/faq.rst +++ b/doc/guides/faq/faq.rst @@ -62,19 +62,16 @@ the wrong socket, the application simply will not start. On application startup, there is a lot of EAL information printed. Is there any way to reduce this? --------------------------------------------------------------------------------------------------- -Yes, the option ``--log-level=`` accepts one of these numbers: - -.. code-block:: c - - #define RTE_LOG_EMERG 1U /* System is unusable. */ - #define RTE_LOG_ALERT 2U /* Action must be taken immediately. */ - #define RTE_LOG_CRIT 3U /* Critical conditions. */ - #define RTE_LOG_ERR 4U /* Error conditions. */ - #define RTE_LOG_WARNING 5U /* Warning conditions. */ - #define RTE_LOG_NOTICE 6U /* Normal but significant condition. */ - #define RTE_LOG_INFO 7U /* Informational. */ - #define RTE_LOG_DEBUG 8U /* Debug-level messages. */ - +Yes, the option ``--log-level=`` accepts either symbolic names (or numbers): + +1. emergency +2. alert +3. critical +4. error +5. warning +6. notice +7. info +8. debug How can I tune my network application to achieve lower latency? --------------------------------------------------------------- diff --git a/doc/guides/nics/dpaa2.rst b/doc/guides/nics/dpaa2.rst index 8e38efff4a27..85d26503f325 100644 --- a/doc/guides/nics/dpaa2.rst +++ b/doc/guides/nics/dpaa2.rst @@ -547,7 +547,7 @@ For enabling logging for DPAA2 PMD, following log-level prefix can be used: .. code-block:: console - --log-level=bus.fslmc, -- ... + --log-level=bus.fslmc: -- ... Using ``bus.fslmc`` as log matching criteria, all FSLMC bus logs can be enabled which are lower than logging ``level``. @@ -556,7 +556,7 @@ which are lower than logging ``level``. .. code-block:: console - --log-level=pmd.net.dpaa2, -- ... + --log-level=pmd.net.dpaa2: -- ... Using ``pmd.dpaa2`` as log matching criteria, all PMD logs can be enabled which are lower than logging ``level``. diff --git a/doc/guides/nics/qede.rst b/doc/guides/nics/qede.rst index 42dd70db39df..f6fb548155a3 100644 --- a/doc/guides/nics/qede.rst +++ b/doc/guides/nics/qede.rst @@ -193,7 +193,7 @@ This section provides instructions to configure SR-IOV with Linux OS. #. Running testpmd - (Supply ``--log-level="pmd.net.qede.driver:7`` to view informational messages): + (Supply ``--log-level="pmd.net.qede.driver:info`` to view informational messages): Refer to the document :ref:`compiling and testing a PMD for a NIC ` to run diff --git a/doc/guides/nics/sfc_efx.rst b/doc/guides/nics/sfc_efx.rst index abaed67f52b6..07ccafaaf750 100644 --- a/doc/guides/nics/sfc_efx.rst +++ b/doc/guides/nics/sfc_efx.rst @@ -356,26 +356,26 @@ Dynamic Logging Parameters One may leverage EAL option "--log-level" to change default levels for the log types supported by the driver. The option is used with -an argument typically consisting of two parts separated by a comma. +an argument typically consisting of two parts separated by a colon. -Level value is the last part which takes an integer greater than 0. -Log type is the former part which may contain a regular expression. +Level value is the last part which takes a symbolic name (or integer). +Log type is the former part which may shell match syntax. Depending on the choice of the expression, the given log level may be used either for some specific log type or for a subset of types. SFC EFX PMD provides the following log types available for control: -- ``pmd.net.sfc.driver`` (default level is **6** - ``RTE_LOG_NOTICE``) +- ``pmd.net.sfc.driver`` (default level is **notice**) Affects driver-wide messages unrelated to any particular devices. -- ``pmd.net.sfc.main`` (default level is **6** - ``RTE_LOG_NOTICE``) +- ``pmd.net.sfc.main`` (default level is **notice**) Matches a subset of per-port log types registered during runtime. A full name for a particular type may be obtained by appending a dot and a PCI device identifier (``XXXX:XX:XX.X``) to the prefix. -- ``pmd.net.sfc.mcdi`` (default level is **6** - ``RTE_LOG_NOTICE``) +- ``pmd.net.sfc.mcdi`` (default level is **notice**) Extra logging of the communication with the NIC's management CPU. The format of the log is consumed by the Solarflare netlogdecode diff --git a/doc/guides/nics/tap.rst b/doc/guides/nics/tap.rst index c97786acaa53..3e038cc5eec1 100644 --- a/doc/guides/nics/tap.rst +++ b/doc/guides/nics/tap.rst @@ -166,7 +166,7 @@ Run pktgen from the pktgen directory in a terminal with a commandline like the following:: sudo ./app/app/x86_64-native-linuxapp-gcc/app/pktgen -l 1-5 -n 4 \ - --proc-type auto --log-level 8 --socket-mem 512,512 --file-prefix pg \ + --proc-type auto --log-level debug --socket-mem 512,512 --file-prefix pg \ --vdev=net_tap0 --vdev=net_tap1 -b 05:00.0 -b 05:00.1 \ -b 04:00.0 -b 04:00.1 -b 04:00.2 -b 04:00.3 \ -b 81:00.0 -b 81:00.1 -b 81:00.2 -b 81:00.3 \