Re: [PATCH v3 1/2] docs: Add debugging section to process

From: Randy Dunlap
Date: Wed Nov 20 2024 - 22:59:58 EST




On 11/17/24 11:03 PM, 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@xxxxxxxxxxxxx>
> ---
> .../driver_development_debugging_guide.rst | 223 ++++++++++++++++
> Documentation/process/debugging/index.rst | 65 +++++
> .../debugging/userspace_debugging_guide.rst | 280 +++++++++++++++++++++
> Documentation/process/index.rst | 8 +-
> 4 files changed, 573 insertions(+), 3 deletions(-)
>

> diff --git a/Documentation/process/debugging/index.rst b/Documentation/process/debugging/index.rst
> new file mode 100644
> index 000000000000..10fa673f0fe3
> --- /dev/null
> +++ b/Documentation/process/debugging/index.rst
> @@ -0,0 +1,65 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +

[snip]

> +
> +How to do a simple analysis with linux tools?

Linux

> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +


Reviewed-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

Thanks.

--
~Randy