[PATCH v2 31/59] docs/dyndbg: explain new delimiters: comma, percent

[Louis Chauvet]

Le 20/03/2025 à 19:52, Jim Cromie a écrit :
> Add mention of comma and percent delimiters into the respective
> paragraphs describing their equivalents: space and newline.
> 
> cc: linux-doc at vger.kernel.org
> Signed-off-by: Jim Cromie <jim.cromie at gmail.com>

I think this should go with the previous patches introducing the 
feature. (I don't know if doc should be in a separate patch, but I think 
you can at least split this patch and put them just after the feature 
itself)

Reviewed-by: Louis Chauvet <louis.chauvet at bootlin.com>

> ---
>   .../admin-guide/dynamic-debug-howto.rst       | 19 +++++++++++--------
>   1 file changed, 11 insertions(+), 8 deletions(-)
> 
> diff --git a/Documentation/admin-guide/dynamic-debug-howto.rst b/Documentation/admin-guide/dynamic-debug-howto.rst
> index 4ac18c0a1d95..8e2083605bd7 100644
> --- a/Documentation/admin-guide/dynamic-debug-howto.rst
> +++ b/Documentation/admin-guide/dynamic-debug-howto.rst
> @@ -78,16 +78,19 @@ Command Language Reference
>   ==========================
>   
>   At the basic lexical level, a command is a sequence of words separated
> -by spaces or tabs.  So these are all equivalent::
> +by spaces, tabs, or commas.  So these are all equivalent::
>   
>     :#> ddcmd file svcsock.c line 1603 +p
>     :#> ddcmd "file svcsock.c line 1603 +p"
>     :#> ddcmd '  file   svcsock.c     line  1603 +p  '
> +  :#> ddcmd file,svcsock.c,line,1603,+p
>   
> -Command submissions are bounded by a write() system call.
> -Multiple commands can be written together, separated by ``;`` or ``\n``::
> +Command submissions are bounded by a write() system call.  Multiple
> +commands can be written together, separated by ``%``, ``;`` or ``\n``::
>   
> -  :#> ddcmd "func pnpacpi_get_resources +p; func pnp_assign_mem +p"
> +  :#> ddcmd func foo +p % func bar +p
> +  :#> ddcmd func foo +p \; func bar +p
> +  :#> ddcmd "func foo +p ; func bar +p"
>     :#> ddcmd <<"EOC"
>     func pnpacpi_get_resources +p
>     func pnp_assign_mem +p
> @@ -109,7 +112,6 @@ The match-spec's select *prdbgs* from the catalog, upon which to apply
>   the flags-spec, all constraints are ANDed together.  An absent keyword
>   is the same as keyword "*".
>   
> -
>   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:::
> @@ -133,7 +135,6 @@ keywords are:::
>     ``line-range`` cannot contain space, e.g.
>     "1-30" is valid range but "1 - 30" is not.
>   
> -
>   The meanings of each keyword are:
>   
>   func
> @@ -158,9 +159,11 @@ module
>       The given string is compared against the module name
>       of each callsite.  The module name is the string as
>       seen in ``lsmod``, i.e. without the directory or the ``.ko``
> -    suffix and with ``-`` changed to ``_``.  Examples::
> +    suffix and with ``-`` changed to ``_``.
> +
> +    Examples::
>   
> -	module sunrpc
> +	module,sunrpc	# with ',' as token separator
>   	module nfsd
>   	module drm*	# both drm, drm_kms_helper
>   

-- 
Louis Chauvet, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com