Re: [PATCH] Documentation: move dev-tools debugging files to process/debugging/

[Randy Dunlap <rdunlap@infradead.org>]

On 12/4/24 3:07 PM, Doug Anderson wrote:
> Hi,
> 
> On Wed, Dec 4, 2024 at 2:17 PM Randy Dunlap <rdunlap@infradead.org> wrote:
>>
>> Move gdb and kgdb debugging documentation to the dedicated
>> debugging directory (Documentation/process/debugging/).
>> Adjust the index.rst files to follow the file movement.
>> Update location of kgdb.rst in MAINTAINERS file.
>>
>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>> Cc: Sebastian Fricke <sebastian.fricke@collabora.com>
>> Cc: Jonathan Corbet <corbet@lwn.net>
>> Cc: workflows@vger.kernel.org
>> Cc: Jason Wessel <jason.wessel@windriver.com>
>> Cc: Daniel Thompson <danielt@kernel.org>
>> Cc: Douglas Anderson <dianders@chromium.org>
>> Cc: linux-debuggers@vger.kernel.org
>> Cc: kgdb-bugreport@lists.sourceforge.net
>> ---
>>  Documentation/dev-tools/index.rst                                       | 2 --
>>  Documentation/{dev-tools => process/debugging}/gdb-kernel-debugging.rst | 0
> 
> After applying your patch and doing `git grep
> gdb-kernel-debugging.rst`, I still see several references to the old
> location. Those should be updated as part of this patch, right?
> 
> 
> 
>>  Documentation/process/debugging/index.rst                               | 2 ++
>>  Documentation/{dev-tools => process/debugging}/kgdb.rst                 | 0
> 
> Similarly `git grep kgdb.rst` still has several references to the old location.


Thanks. I should have done that.  :(

>>  MAINTAINERS                                                             | 2 +-
>>  5 files changed, 3 insertions(+), 3 deletions(-)
>>
>> diff --git a/Documentation/dev-tools/index.rst b/Documentation/dev-tools/index.rst
>> index 3c0ac08b2709..c1e73e75f551 100644
>> --- a/Documentation/dev-tools/index.rst
>> +++ b/Documentation/dev-tools/index.rst
>> @@ -27,8 +27,6 @@ Documentation/dev-tools/testing-overview.rst
>>     kmemleak
>>     kcsan
>>     kfence
>> -   gdb-kernel-debugging
>> -   kgdb
>>     kselftest
>>     kunit/index
>>     ktap
>> diff --git a/Documentation/dev-tools/gdb-kernel-debugging.rst b/Documentation/process/debugging/gdb-kernel-debugging.rst
>> similarity index 100%
>> rename from Documentation/dev-tools/gdb-kernel-debugging.rst
>> rename to Documentation/process/debugging/gdb-kernel-debugging.rst
>> diff --git a/Documentation/process/debugging/index.rst b/Documentation/process/debugging/index.rst
>> index f6e4a00dfee3..bc4a816e3d32 100644
>> --- a/Documentation/process/debugging/index.rst
>> +++ b/Documentation/process/debugging/index.rst
>> @@ -12,6 +12,8 @@ general guides
>>
>>     driver_development_debugging_guide
>>     userspace_debugging_guide
>> +   gdb-kernel-debugging
>> +   kgdb
> 
> Should the list above be kept alphabetical. The list you removed these
> entries from was _almost_ alphabetical...

Not that I know of.  I'll listen for other opinions though.

Thanks.

-- 
~Randy