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 06498457C6; Wed, 14 Aug 2024 20:50:16 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id F2064402C4; Wed, 14 Aug 2024 20:50:14 +0200 (CEST) Received: from mail-pj1-f47.google.com (mail-pj1-f47.google.com [209.85.216.47]) by mails.dpdk.org (Postfix) with ESMTP id 076094025F for ; Wed, 14 Aug 2024 20:50:14 +0200 (CEST) Received: by mail-pj1-f47.google.com with SMTP id 98e67ed59e1d1-2d3b4238c58so90992a91.2 for ; Wed, 14 Aug 2024 11:50:13 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=iol.unh.edu; s=unh-iol; t=1723661413; x=1724266213; darn=dpdk.org; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:from:to:cc:subject:date :message-id:reply-to; bh=hvjhOVt26k7UMXh7g997KZgJWE3arZ6LcsXxAfB/eIA=; b=LGSE7sntP2iVdMzRx7Gi3Bk/W/hWzs/urBaJSIYCD2l6fIYMDWZcchFbO2m7Vuuctf 7MjdY+BMpc18UFnvdFfpZGVTZasbTEY6rk3cS1Q6FLhiXneyogUvtzecsV6dtqXnBQbE Qby8C7Kv17JzmHwMckU9OOqS8YfFU0avMMvFM= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723661413; x=1724266213; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=hvjhOVt26k7UMXh7g997KZgJWE3arZ6LcsXxAfB/eIA=; b=empNTzUWTclu9cWy4G2AaJ1BOHk/oHqAwToJl0WzoJa/v1kxa4zG85F41umIa5eJHV fIks7PNQ5kucz6xSz49EI9R22dU1RjXLpR2Z/a0yyABRJudQLrzWgnIja37XsXQq0tDo yVN+v1U0p/2t7Vpsz1UzMuX7UJa4FooZtblVlO293jSPRnGRN8jMhE7PjqDUe3eM4A6K 6xB+UQLlz7ZqLeEevfUthskAAkgAeoCXe8vPq6/9xMnqID/9D4XSci2Vd9CPAY5Cy+4Y X7s88w1/CX/yng297tX9RbnbjA4Ce5Vn/4D4/hgJJp23S0EHntYbaXrHfyiw0jHA6rjq HW8w== X-Forwarded-Encrypted: i=1; AJvYcCXHfdkJydPZwS4pVNfLOh8jq0RcZ+6z3NLFdK8VbYGeXnASNmUQlCkoxHMVyDNIYs69cvU=@dpdk.org X-Gm-Message-State: AOJu0YwWS7bXk1QZqeIvsr50yGd5XH69nolnVMr9Xi+7+0kRWtMeMJAW QHD8PHA7B5THMreK+RUOxPRzwUB1LKLAo8o+KZg6lQClLM+5s+Tp99e7BGReLmufEc+quBh+1e0 TFWS0jdImm4l/kpglnK4JMngSFtHWcRpbHM2dlg== X-Google-Smtp-Source: AGHT+IES+kr2W9SP/IepNwrW1fhymyWSNts9WHUoKilp+gh7e3DdO55pdLAu9A9lOES7MXINPlfzd+u3YIeN1dxxSpI= X-Received: by 2002:a17:90a:741:b0:2d1:b37e:94b2 with SMTP id 98e67ed59e1d1-2d3aaa7aba6mr4349770a91.7.1723661412461; Wed, 14 Aug 2024 11:50:12 -0700 (PDT) MIME-Version: 1.0 References: <20231115133606.42081-1-juraj.linkes@pantheon.tech> <20240814150535.239547-1-juraj.linkes@pantheon.tech> <20240814150535.239547-2-juraj.linkes@pantheon.tech> In-Reply-To: <20240814150535.239547-2-juraj.linkes@pantheon.tech> From: Jeremy Spewock Date: Wed, 14 Aug 2024 14:50:01 -0400 Message-ID: Subject: Re: [PATCH v17 1/5] dts: update params and parser docstrings To: =?UTF-8?Q?Juraj_Linke=C5=A1?= Cc: thomas@monjalon.net, Honnappa.Nagarahalli@arm.com, bruce.richardson@intel.com, probb@iol.unh.edu, paul.szczepanek@arm.com, Luca.Vizzarro@arm.com, npratte@iol.unh.edu, dev@dpdk.org Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable 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 On Wed, Aug 14, 2024 at 11:05=E2=80=AFAM Juraj Linke=C5=A1 wrote: > > 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=C5=A1 > Reviewed-by: Luca Vizzarro > --- Reviewed-by: Jeremy Spewock