Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Subject: Re: [PATCH v2 3/3] Documentation: dyndbg: Improve cli param examples
To:     Andrew Halaney <ahalaney@redhat.com>,
        Jonathan Corbet <corbet@lwn.net>,
        Jim Cromie <jim.cromie@gmail.com>
Cc:     linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
References: <20210913222440.731329-1-ahalaney@redhat.com>
 <20210913222440.731329-4-ahalaney@redhat.com>
From:   Jason Baron <jbaron@akamai.com>
Message-ID: <ff05cae4-8fa7-d1b6-795e-3bd85316774d@akamai.com>
Date:   Fri, 17 Sep 2021 15:50:35 -0400
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101
 Thunderbird/68.10.0
MIME-Version: 1.0
In-Reply-To: <20210913222440.731329-4-ahalaney@redhat.com>
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Transfer-Encoding: 7bit
Content-Language: en-US
Precedence: bulk


On 9/13/21 6:24 PM, Andrew Halaney wrote:
> Jim pointed out that using $module.dyndbg= is always a more flexible
> choice for using dynamic debug on the command line. The $module.dyndbg
> style is checked at boot and handles if $module is a builtin. If it is
> actually a loadable module, it is handled again later when the module is
> loaded.
>
> If you just use dyndbg="module $module +p" dynamic debug is only enabled
> when $module is a builtin.
>
> It was recommended to illustrate wildcard usage as well.
>
> Signed-off-by: Andrew Halaney <ahalaney@redhat.com>
> Suggested-by: Jim Cromie <jim.cromie@gmail.com>
> ---
>   Documentation/admin-guide/dynamic-debug-howto.rst | 7 +++++--
>   1 file changed, 5 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/admin-guide/dynamic-debug-howto.rst b/Documentation/admin-guide/dynamic-debug-howto.rst
> index d0911e7cc271..4bfb23ed64ec 100644
> --- a/Documentation/admin-guide/dynamic-debug-howto.rst
> +++ b/Documentation/admin-guide/dynamic-debug-howto.rst
> @@ -357,7 +357,10 @@ Examples
>     Kernel command line: ...
>       // see whats going on in dyndbg=value processing
>       dynamic_debug.verbose=1
> -    // enable pr_debugs in 2 builtins, #cmt is stripped
> -    dyndbg="module params +p #cmt ; module sys +p"
> +    // Enable pr_debugs in the params builtin
> +    params.dyndbg="+p"

If we are going out of our way to change this to indicate that it works 
for builtin and modules, it seems like the comment above should reflect 
that? IE, something like this?

'// Enable pr_debugs in the params module or if params is builtin.

The first two patches look fine to me, so if you agree maybe just 
re-spin this one?

Thanks,

-Jason

> +    // enable pr_debugs in all files under init/
> +    // and the function pc87360_init_device, #cmt is stripped
> +    dyndbg="file init/* +p #cmt ; func pc87360_init_device +p"
>       // enable pr_debugs in 2 functions in a module loaded later
>       pc87360.dyndbg="func pc87360_init_device +p; func pc87360_find +p"