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 69A844577C; Fri, 9 Aug 2024 20:31:45 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 4FB8242E54; Fri, 9 Aug 2024 20:31:45 +0200 (CEST) Received: from mail-pj1-f45.google.com (mail-pj1-f45.google.com [209.85.216.45]) by mails.dpdk.org (Postfix) with ESMTP id 4F2AB42DE9 for ; Fri, 9 Aug 2024 20:31:44 +0200 (CEST) Received: by mail-pj1-f45.google.com with SMTP id 98e67ed59e1d1-2cf11b91813so1859885a91.1 for ; Fri, 09 Aug 2024 11:31:44 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=iol.unh.edu; s=unh-iol; t=1723228303; x=1723833103; 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=9EvHC5JeH6q5twcrcpMnrYrI55l4DzPQ8sVAk5g7NgQ=; b=HTGUby5/1mqnPPvVt+wCM/k0U+fHL4ewlfbOcdTzOLwygx+AW0xbDuOn7rognil7eA dLOPoMF0kWt2zpWyoqeGzkGfoHRkFemwopNZH6UT0iTkIBdOIOsabppJwgWY8m59z/sA rG1I9ead4yCj/NLWsnIilFl5EBUhPML7FBgPE= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723228303; x=1723833103; 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=9EvHC5JeH6q5twcrcpMnrYrI55l4DzPQ8sVAk5g7NgQ=; b=a8yeSZDSoRmb/05Ofi0cgfICvN56e7vn1rPjpvLes48sQIXCINZzhNVd8jH2urSPo4 rzeHdnOtk5z8k88pDsjOJiLBKbDpBSKFPPRUHmI7e4gDvBwdyQseWJuAyzBdZSkk48xN rm9T2OBojGqqMoBQhsj2AvZ+LKPjbYBItlRZl6DpoIMixtmRpNl02cVaW7K8dKM4lXB+ 4Rymy+L6Bt5d+4h0wbSzIMRr2FrgyP14ZmI9D3fIQpMYWNmFCidbbUgjVlNoYJ+nBSfD Qd1caxtiLUg/OzgfVPE+yEwrvUG4uPmj7tKq/Mgf81ppei66leP1Z9hQ+X3bpE9tBSrs /Mbw== X-Forwarded-Encrypted: i=1; AJvYcCUt6P+5+3yL6q6xVUmQUg1FL1NnmlmHyR1Gvrn2kbsWwTxTfv1kc3oaGnlMHZb33Uk9v78cOC9DW/It7bY= X-Gm-Message-State: AOJu0YwvvAYttBISFylxXwZCze09O9IcXzE24ZY37jvwJlcWfyLoZZzz hxfelsAbHj1qhZJQdIRJbh7TwcTc/Zw7XKUdSEF5FNOGzyt2mfHIcRhOh/e6aThKKcP2Cj+pH/Q k8C58AUNJqgrAgb8u64yNhymaAJftIp5tYyuHIg== X-Google-Smtp-Source: AGHT+IEwly5uKHiPD46yKMlBPnQ5IxN3KlXF4RTa5z7ZLHP2s8USCKIslNhrJy+5iZ36tkPqTOu3IqfLCGZqAU88Rgc= X-Received: by 2002:a17:90a:6fa4:b0:2cb:f9e:3bfb with SMTP id 98e67ed59e1d1-2d1e805124cmr2449430a91.32.1723228303342; Fri, 09 Aug 2024 11:31:43 -0700 (PDT) MIME-Version: 1.0 References: <20231115133606.42081-1-juraj.linkes@pantheon.tech> <20240808085452.426702-1-juraj.linkes@pantheon.tech> <20240808085452.426702-2-juraj.linkes@pantheon.tech> In-Reply-To: <20240808085452.426702-2-juraj.linkes@pantheon.tech> From: Jeremy Spewock Date: Fri, 9 Aug 2024 14:31:32 -0400 Message-ID: Subject: Re: [PATCH v16 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 Thu, Aug 8, 2024 at 4:54=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