There is an special chapter inside the core-api book about
some debug infrastructure like tracepoints and debug objects.
It sounded to me that this is the best place to add a chapter
explaining how to use a FireWire controller to do remote
kernel debugging, as explained on this document.
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/admin-guide/kernel-parameters.txt | 2 +-
.../debugging-via-ohci1394.rst} | 0
Documentation/core-api/index.rst | 1 +
lib/Kconfig.debug | 2 +-
4 files changed, 3 insertions(+), 2 deletions(-)
rename Documentation/{debugging-via-ohci1394.txt => core-api/debugging-via-ohci1394.rst} (100%)
diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
index 25644daa36ea..d9b61da7809d 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -3350,7 +3350,7 @@
See Documentation/admin-guide/sysctl/vm.rst for details.
ohci1394_dma=early [HW] enable debugging via the ohci1394 driver.
- See Documentation/debugging-via-ohci1394.txt for more
+ See Documentation/core-api/debugging-via-ohci1394.rst for more
info.
olpc_ec_timeout= [OLPC] ms delay when issuing EC commands
diff --git a/Documentation/debugging-via-ohci1394.txt b/Documentation/core-api/debugging-via-ohci1394.rst
similarity index 100%
rename from Documentation/debugging-via-ohci1394.txt
rename to Documentation/core-api/debugging-via-ohci1394.rst
diff --git a/Documentation/core-api/index.rst b/Documentation/core-api/index.rst
index b70039d458a7..ab056b3626f4 100644
--- a/Documentation/core-api/index.rst
+++ b/Documentation/core-api/index.rst
@@ -99,6 +99,7 @@ Interfaces for kernel debugging
debug-objects
tracepoint
+ debugging-via-ohci1394
Everything else
===============
diff --git a/lib/Kconfig.debug b/lib/Kconfig.debug
index 8e4aded46281..4e631f294737 100644
--- a/lib/Kconfig.debug
+++ b/lib/Kconfig.debug
@@ -1552,7 +1552,7 @@ config PROVIDE_OHCI1394_DMA_INIT
This code (~1k) is freed after boot. By then, the firewire stack
in charge of the OHCI-1394 controllers should be used instead.
- See Documentation/debugging-via-ohci1394.txt for more information.
+ See Documentation/core-api/debugging-via-ohci1394.rst for more information.
source "samples/Kconfig"
--
2.25.4
On Fri, 1 May 2020 17:37:50 +0200
Mauro Carvalho Chehab <[email protected]> wrote:
> There is an special chapter inside the core-api book about
> some debug infrastructure like tracepoints and debug objects.
>
> It sounded to me that this is the best place to add a chapter
> explaining how to use a FireWire controller to do remote
> kernel debugging, as explained on this document.
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
I've applied this, but core-api really seems like the wrong place for
this. It would be good to rethink our layout a bit at some point in the
near future...
Thanks,
jon
Em Fri, 15 May 2020 12:00:16 -0600
Jonathan Corbet <[email protected]> escreveu:
> On Fri, 1 May 2020 17:37:50 +0200
> Mauro Carvalho Chehab <[email protected]> wrote:
>
> > There is an special chapter inside the core-api book about
> > some debug infrastructure like tracepoints and debug objects.
> >
> > It sounded to me that this is the best place to add a chapter
> > explaining how to use a FireWire controller to do remote
> > kernel debugging, as explained on this document.
> >
> > Signed-off-by: Mauro Carvalho Chehab <[email protected]>
>
> I've applied this, but core-api really seems like the wrong place for
> this. It would be good to rethink our layout a bit at some point in the
> near future...
Yeah, agreed. Debug functionality should likely deserve a separate
chapter outside core-api.
Now that we'll have all docs converted, it should be easier to view
the hole picture and re-design the doc organization.
Thanks,
Mauro