Received-SPF: pass (google.com: domain of linux-kernel+bounces-184920-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) client-ip=2604:1380:40f1:3f00::1;
Precedence: bulk
MIME-Version: 1.0
References: <20240516174357.26755-1-jim.cromie@gmail.com> <20240516174357.26755-28-jim.cromie@gmail.com>
In-Reply-To: <20240516174357.26755-28-jim.cromie@gmail.com>
From: =?UTF-8?Q?=C5=81ukasz_Bartosik?= <ukaszb@chromium.org>
Date: Tue, 21 May 2024 13:58:59 +0200
Message-ID: <CALwA+NYbp7Niky6r3HBhpxSeJdJMwJU=Vk-87L5vVKqd4RSfSQ@mail.gmail.com>
Subject: Re: [PATCH v8-RESEND 27/33] dyndbg-doc: explain flags parse 1st
To: Jim Cromie <jim.cromie@gmail.com>
Cc: jbaron@akamai.com, gregkh@linuxfoundation.org, 
	linux-kernel@vger.kernel.org, linux@rasmusvillemoes.dk, joe@perches.com, 
	mcgrof@kernel.org, daniel.vetter@ffwll.ch, tvrtko.ursulin@linux.intel.com, 
	jani.nikula@intel.com, ville.syrjala@linux.intel.com, seanpaul@chromium.org, 
	robdclark@gmail.com, groeck@google.com, yanivt@google.com, bleung@google.com
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable

On Thu, May 16, 2024 at 7:45=E2=80=AFPM Jim Cromie <jim.cromie@gmail.com> w=
rote:
>
> When writing queries to >control, flags are parsed 1st, since they are
> the only required field.  So if the flags draw an error, then keyword
> errors aren't reported.  This can be mildly confusing/annoying, so
> explain it instead.
>
> This note could be moved up to just after the grammar id's the flags,
> and before the match-spec is detailed.  Opinions ?
>

IMHO the localization of the note is ok.


> Signed-off-by: Jim Cromie <jim.cromie@gmail.com>
> ---
>  Documentation/admin-guide/dynamic-debug-howto.rst | 10 ++++++++++
>  1 file changed, 10 insertions(+)
>
> diff --git a/Documentation/admin-guide/dynamic-debug-howto.rst b/Document=
ation/admin-guide/dynamic-debug-howto.rst
> index 7b570f29ae98..ccf3704f2143 100644
> --- a/Documentation/admin-guide/dynamic-debug-howto.rst
> +++ b/Documentation/admin-guide/dynamic-debug-howto.rst
> @@ -106,6 +106,16 @@ The match-spec's select *prdbgs* from the catalog, u=
pon which to apply
>  the flags-spec, all constraints are ANDed together.  An absent keyword
>  is the same as keyword "*".
>
> +Note: because the match-spec can be empty, the flags are checked 1st,
> +then the pairs of keyword values.  Flag errs will hide keyword errs:
> +
> +  bash-5.2# ddcmd mod bar +foo
> +  dyndbg: read 13 bytes from userspace
> +  dyndbg: query 0: "mod bar +foo" mod:*
> +  dyndbg: unknown flag 'o'
> +  dyndbg: flags parse failed
> +  dyndbg: processed 1 queries, with 0 matches, 1 errs
> +
>  A match specification is a keyword, which selects the attribute of
>  the callsite to be compared, and a value to compare against.  Possible
>  keywords are:::
> --
> 2.45.0
>