From patchwork Thu Aug 8 08:54:48 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Juraj_Linke=C5=A1?= X-Patchwork-Id: 143018 X-Patchwork-Delegate: juraj.linkes@pantheon.tech Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 55B6245769; Thu, 8 Aug 2024 10:55:04 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 92300427BC; Thu, 8 Aug 2024 10:54:57 +0200 (CEST) Received: from mail-ej1-f44.google.com (mail-ej1-f44.google.com [209.85.218.44]) by mails.dpdk.org (Postfix) with ESMTP id 356704279E for ; Thu, 8 Aug 2024 10:54:56 +0200 (CEST) Received: by mail-ej1-f44.google.com with SMTP id a640c23a62f3a-a7ac469e4c4so114822466b.0 for ; Thu, 08 Aug 2024 01:54:56 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pantheon.tech; s=google; t=1723107296; x=1723712096; darn=dpdk.org; 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=NO2UZ+LLMKW3UrDhN9eC/Bfrt3jHMMG2THTaBf2mSkQ=; b=KQtvsT3FT15TLy42R59KUjbYWa+zpF/nYQFzQstq7CNzRbYlFWsfHp1C9wp7WBhKFW kITboPgsl2JCgWQNsZW8zN5EBqSYfE0oMdMXrG9CKhxbEsgztliyVn8SnHLc4Ej0xL5T N4LimWQg76HQhzcW1CYCl2Q4y673PeVotBGl9MLTdpuVAL06w48GcoKm+gBhhw1awLrp mc+pVQMGOEY8LlK0xJr5dV1sS618B4j/0WQCcD/qoAXD0WNnX42OpI6Fz3b5hqwV1SlJ tnP8Mr5x02hHKtZJLT35Ygm0ZiM3CdZ9tT959tWO0TRhu5cpmsyzUxnin+gtYh5/3PfA 1o3g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723107296; x=1723712096; 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=NO2UZ+LLMKW3UrDhN9eC/Bfrt3jHMMG2THTaBf2mSkQ=; b=XgMPuzIhWpyTvLKpkdDcajVlJGjqCR1RqwHzmsQ/9XzYlQlbwgk+afQXcAMRRw4liS itliaaZv33tzFiFo53i892GCapyG0AqiapKnU6g15YJM7l8tu31/SU+pS57f7F6YinhI 8iwWaNLZIMC2P3IK1Hl7P/N5ImOo/lIWMALjnAte9ud8eYqH8W57NsgZEJdWkdouLR0P yfaB87wV2I3z2a3ZTDVd2R4SSGoGPAlSU4xtp/ynjx5oOFOOeBQoUEk9cTA9zaRLlAMU rSuQFNtI2MubRGtmoAGQsT701nfgeL9gyh3DzzJgSZNATuSi/5vzzAGdM21X3AK0m9ra P2RQ== X-Gm-Message-State: AOJu0Yy3sEguVaPSztwCKm07emcpZZSbbE+zrmf56UzbUkzX53JrEIsI Ert524TQD2pRl9MtnLr8gXy0akBe9/qJHWpN0XJQZCLJ/b/2RPErM82X8z6JNLM= X-Google-Smtp-Source: AGHT+IGIDQ7DcY3wU7PNIvDDUABjoJWiKejXzIG+P9PinGk6t5i3Ze/tesbz0Mc4WfydqnO08UzK8Q== X-Received: by 2002:a17:907:9448:b0:a75:1923:eb2e with SMTP id a640c23a62f3a-a8091f004b4mr77729166b.14.1723107295697; Thu, 08 Aug 2024 01:54:55 -0700 (PDT) Received: from jlinkes-PT-Latitude-5530.pantheon.local ([84.245.121.236]) by smtp.gmail.com with ESMTPSA id a640c23a62f3a-a7dc9ec8879sm719996266b.211.2024.08.08.01.54.54 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 08 Aug 2024 01:54:55 -0700 (PDT) From: =?utf-8?q?Juraj_Linke=C5=A1?= To: thomas@monjalon.net, Honnappa.Nagarahalli@arm.com, bruce.richardson@intel.com, jspewock@iol.unh.edu, probb@iol.unh.edu, paul.szczepanek@arm.com, Luca.Vizzarro@arm.com, npratte@iol.unh.edu Cc: dev@dpdk.org, =?utf-8?q?Juraj_Linke=C5=A1?= , luca.vizzarro@arm.com Subject: [PATCH v16 1/5] dts: update params and parser docstrings Date: Thu, 8 Aug 2024 10:54:48 +0200 Message-Id: <20240808085452.426702-2-juraj.linkes@pantheon.tech> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240808085452.426702-1-juraj.linkes@pantheon.tech> References: <20231115133606.42081-1-juraj.linkes@pantheon.tech> <20240808085452.426702-1-juraj.linkes@pantheon.tech> MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Address a few errors reported by Sphinx when generating documentation: framework/params/__init__.py:docstring of framework.params.modify_str:3: WARNING: Inline interpreted text or phrase reference start-string without end-string. framework/params/eal.py:docstring of framework.params.eal.EalParams:35: WARNING: Definition list ends without a blank line; unexpected unindent. framework/params/types.py:docstring of framework.params.types:8: WARNING: Inline strong start-string without end-string. framework/params/types.py:docstring of framework.params.types:9: WARNING: Inline strong start-string without end-string. framework/parser.py:docstring of framework.parser.TextParser:33: ERROR: Unexpected indentation. framework/parser.py:docstring of framework.parser.TextParser:43: ERROR: Unexpected indentation. framework/parser.py:docstring of framework.parser.TextParser:49: ERROR: Unexpected indentation. framework/parser.py:docstring of framework.parser.TextParser.wrap:8: ERROR: Unexpected indentation. framework/parser.py:docstring of framework.parser.TextParser.wrap:9: WARNING: Block quote ends without a blank line; unexpected unindent. Fixes: 87ba4cdc0dbb ("dts: use Unpack for type checking and hinting") Fixes: d70159cb62f5 ("dts: add params manipulation module") Fixes: 967fc62b0a43 ("dts: refactor EAL parameters class") Fixes: 818fe14e3422 ("dts: add parsing utility module") Cc: luca.vizzarro@arm.com Signed-off-by: Juraj Linkeš Reviewed-by: Luca Vizzarro Reviewed-by: Jeremy Spewock --- dts/framework/params/__init__.py | 4 ++-- dts/framework/params/eal.py | 7 +++++-- dts/framework/params/types.py | 3 ++- dts/framework/parser.py | 4 ++-- 4 files changed, 11 insertions(+), 7 deletions(-) diff --git a/dts/framework/params/__init__.py b/dts/framework/params/__init__.py index 5a6fd93053..1ae227d7b4 100644 --- a/dts/framework/params/__init__.py +++ b/dts/framework/params/__init__.py @@ -53,9 +53,9 @@ def reduced_fn(value): def modify_str(*funcs: FnPtr) -> Callable[[T], T]: - """Class decorator modifying the ``__str__`` method with a function created from its arguments. + r"""Class decorator modifying the ``__str__`` method with a function created from its arguments. - The :attr:`FnPtr`s fed to the decorator are executed from left to right in the arguments list + The :attr:`FnPtr`\s fed to the decorator are executed from left to right in the arguments list order. Args: diff --git a/dts/framework/params/eal.py b/dts/framework/params/eal.py index 8d7766fefc..cf1594353a 100644 --- a/dts/framework/params/eal.py +++ b/dts/framework/params/eal.py @@ -26,13 +26,16 @@ class EalParams(Params): prefix: Set the file prefix string with which to start DPDK, e.g.: ``prefix="vf"``. no_pci: Switch to disable PCI bus, e.g.: ``no_pci=True``. vdevs: Virtual devices, e.g.:: + vdevs=[ VirtualDevice('net_ring0'), VirtualDevice('net_ring1') ] + ports: The list of ports to allow. - other_eal_param: user defined DPDK EAL parameters, e.g.: - ``other_eal_param='--single-file-segments'`` + other_eal_param: user defined DPDK EAL parameters, e.g.:: + + ``other_eal_param='--single-file-segments'`` """ lcore_list: LogicalCoreList | None = field(default=None, metadata=Params.short("l")) diff --git a/dts/framework/params/types.py b/dts/framework/params/types.py index e668f658d8..d77c4625fb 100644 --- a/dts/framework/params/types.py +++ b/dts/framework/params/types.py @@ -6,7 +6,8 @@ TypedDicts can be used in conjunction with Unpack and kwargs for type hinting on function calls. Example: - ..code:: python + .. code:: python + def create_testpmd(**kwargs: Unpack[TestPmdParamsDict]): params = TestPmdParams(**kwargs) """ diff --git a/dts/framework/parser.py b/dts/framework/parser.py index 741dfff821..7254c75b71 100644 --- a/dts/framework/parser.py +++ b/dts/framework/parser.py @@ -46,7 +46,7 @@ class TextParser(ABC): Example: The following example makes use of and demonstrates every parser function available: - ..code:: python + .. code:: python from dataclasses import dataclass, field from enum import Enum @@ -90,7 +90,7 @@ def wrap(parser_fn: ParserFn, wrapper_fn: Callable) -> ParserFn: """Makes a wrapped parser function. `parser_fn` is called and if a non-None value is returned, `wrapper_function` is called with - it. Otherwise the function returns early with None. In pseudo-code: + it. Otherwise the function returns early with None. In pseudo-code:: intermediate_value := parser_fn(input) if intermediary_value is None then