linux-kernel - Re: [PATCH v2 1/2] docs: Add debugging section to process

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <06bb8d73-ba52-440a-be95-42977145c026@infradead.org>
Date: Thu, 14 Nov 2024 22:28:51 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: Sebastian Fricke <sebastian.fricke@...labora.com>
Cc: Jonathan Corbet <corbet@....net>, bagasdotme@...il.com,
 linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
 linux-media@...r.kernel.org, laurent.pinchart@...asonboard.com,
 hverkuil-cisco@...all.nl, mchehab@...nel.org, kernel@...labora.com,
 bob.beckett@...labora.com, nicolas.dufresne@...labora.com
Subject: Re: [PATCH v2 1/2] docs: Add debugging section to process



On 11/14/24 10:05 PM, Sebastian Fricke wrote:
> Hey Randy,
> 
> Thank you for the review, I'll apply these changes, I just found one
> advice below not terribly helpful maybe you can clarify ...
> 
> On 14.11.2024 21:06, Randy Dunlap wrote:
>>
>>
>> On 11/13/24 3:17 AM, Sebastian Fricke wrote:
>>> This idea was formed after noticing that new developers experience
>>> certain difficulty to navigate within the multitude of different
>>> debugging options in the Kernel and while there often is good
>>> documentation for the tools, the developer has to know first that they
>>> exist and where to find them.
>>> Add a general debugging section to the Kernel documentation, as an
>>> easily locatable entry point to other documentation and as a general
>>> guideline for the topic.
>>>
>>> Signed-off-by: Sebastian Fricke <sebastian.fricke@...labora.com>
>>> ---
>>>  .../driver_development_debugging_guide.rst         | 214 ++++++++++++++++
>>>  Documentation/process/debugging/index.rst          |  65 +++++
>>>  .../debugging/userspace_debugging_guide.rst        | 278 +++++++++++++++++++++
>>>  Documentation/process/index.rst                    |   8 +-
>>>  4 files changed, 562 insertions(+), 3 deletions(-)
>>>
>>
>>
>>> diff --git a/Documentation/process/debugging/userspace_debugging_guide.rst b/Documentation/process/debugging/userspace_debugging_guide.rst
>>> new file mode 100644
>>> index 000000000000..a7c94407bcae
>>> --- /dev/null
>>> +++ b/Documentation/process/debugging/userspace_debugging_guide.rst
>>> @@ -0,0 +1,278 @@
>>> +.. SPDX-License-Identifier: GPL-2.0
>>> +
>>> +==========================
>>> +Userspace debugging advice
>>> +==========================
>>> +
>>> +A brief overview of common tools to debug the Linux Kernel from userspace.
>>
>> Make that a sentence?
> 
> Can you clarify this?
> 
> This could either mean:
> - What you even bother to make a sentence out of that?
> - Please make a proper sentence out of this because it is hard to
>   understand
> - Please go into more detail because this is too brief
> 
> Or maybe something completely different :)

Sorry for my brevity.
I just meant "do you want to make that line a sentence, because it is not a sentence
in its current form." But I'm not going to lose any sleep over it.

Thanks.

-- 
~Randy