From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 646ED41F45 for ; Wed, 26 Jun 2024 17:09:40 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 647F3402CC; Wed, 26 Jun 2024 17:09:40 +0200 (CEST) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mails.dpdk.org (Postfix) with ESMTP id 7AF91402CC for ; Wed, 26 Jun 2024 17:09:39 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1719414579; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=7IFGNWBGcrgLk++nn6fKAYASpSDlBxua+g0vHyPCito=; b=idMFe5/bX9EyRtVcawLPW/wNiJW7I61JJM4Jshisuz+wnHkTLfrYTX5/m0L+2qgwf8M9Y3 wpAuD8VpH7yVwDqjde3odkaiZilFGcVzPko0gPJokPaA743KEO60CbSP9cewqgtHZzD4Gl fWIi1Cp9pKNUCOsKRYGucTCwEPb2YNE= Received: from mx-prod-mc-04.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-357-LPANZA1BMQ2Fte5irhyvUA-1; Wed, 26 Jun 2024 11:09:35 -0400 X-MC-Unique: LPANZA1BMQ2Fte5irhyvUA-1 Received: from mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.17]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 16EE21944CD1; Wed, 26 Jun 2024 15:09:32 +0000 (UTC) Received: from dmarchan.redhat.com (unknown [10.45.225.3]) by mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 26E551956061; Wed, 26 Jun 2024 15:09:29 +0000 (UTC) From: David Marchand To: dev@dpdk.org Cc: Ilya Maximets , stable@dpdk.org, Anoob Joseph Subject: [PATCH] doc: enhance the global log level documentation Date: Wed, 26 Jun 2024 17:09:25 +0200 Message-ID: <20240626150926.1918948-1-david.marchand@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.17 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit Content-Type: text/plain; charset="US-ASCII"; x-default=true X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: stable-bounces@dpdk.org The current documentation is non intuitive in that the global log level can be understood as being a single knob controlling all components logs. On the contrary, all the global log level is for is to reduce verbosity globally. Remove examples of setting --log-level=8|debug, which is a noop. Cc: stable@dpdk.org Signed-off-by: David Marchand --- doc/guides/cryptodevs/octeontx.rst | 2 +- doc/guides/prog_guide/log_lib.rst | 10 ++++++---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/doc/guides/cryptodevs/octeontx.rst b/doc/guides/cryptodevs/octeontx.rst index a39f3f3d02..97e13514f3 100644 --- a/doc/guides/cryptodevs/octeontx.rst +++ b/doc/guides/cryptodevs/octeontx.rst @@ -114,7 +114,7 @@ OCTEON TX crypto PMD. .. code-block:: console - ./build/ipsec-secgw --log-level=8 -c 0xff -- -P -p 0x3 -u 0x2 --config + ./build/ipsec-secgw -c 0xff -- -P -p 0x3 -u 0x2 --config "(1,0,0),(0,0,0)" -f ep1.cfg Testing diff --git a/doc/guides/prog_guide/log_lib.rst b/doc/guides/prog_guide/log_lib.rst index ff9d1b54a2..965b7e9961 100644 --- a/doc/guides/prog_guide/log_lib.rst +++ b/doc/guides/prog_guide/log_lib.rst @@ -32,18 +32,20 @@ or by the user passing the ``--log-level`` parameter to the EAL via the applicat Setting Global Log Level ~~~~~~~~~~~~~~~~~~~~~~~~ -To adjust the global log level for an application, -just pass a numeric level or a level name to the ``--log-level`` EAL parameter. +By default, the global log level is set to ``RTE_LOG_DEBUG``. + +To reduce the verbosity of an application globally, +adjust the global log level by passing a numeric level or a level name to the ``--log-level`` EAL parameter. For example:: /path/to/app --log-level=error - /path/to/app --log-level=debug - /path/to/app --log-level=5 # warning Within an application, the log level can be similarly set using the ``rte_log_set_global_level`` API. +For setting per component log levels, see below. + Setting Log Level for a Component ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- 2.45.2