linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	Thomas Gleixner <tglx@linutronix.de>,
	Andrew Morton <akpm@linux-foundation.org>,
	"Paul E. McKenney" <paulmck@kernel.org>,
	Pawan Gupta <pawan.kumar.gupta@linux.intel.com>,
	Juergen Gross <jgross@suse.com>,
	Mike Kravetz <mike.kravetz@oracle.com>,
	Masahiro Yamada <yamada.masahiro@socionext.com>,
	Daniel Jordan <daniel.m.jordan@oracle.com>,
	Mike Rapoport <rppt@linux.ibm.com>,
	Changbin Du <changbin.du@intel.com>,
	Randy Dunlap <rdunlap@infradead.org>,
	Stephen Rothwell <sfr@canb.auug.org.au>,
	Anshuman Khandual <anshuman.khandual@arm.com>,
	Krzysztof Kozlowski <krzk@kernel.org>
Subject: [PATCH 06/14] docs: debugging-via-ohci1394.txt: add it to the core-api book
Date: Fri,  1 May 2020 17:37:50 +0200	[thread overview]
Message-ID: <9b489d36d08ad89d3ad5aefef1f52a0715b29716.1588345503.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1588345503.git.mchehab+huawei@kernel.org>

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 <mchehab+huawei@kernel.org>
---
 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


  parent reply	other threads:[~2020-05-01 15:38 UTC|newest]

Thread overview: 37+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <cover.1588345503.git.mchehab+huawei@kernel.org>
2020-05-01 15:37 ` [PATCH 01/14] docs: move DMA kAPI to Documentation/core-api Mauro Carvalho Chehab
2020-05-15 17:52   ` Jonathan Corbet
2020-05-01 15:37 ` [PATCH 02/14] docs: add bus-virt-phys-mapping.txt to core-api Mauro Carvalho Chehab
2020-05-15 17:53   ` Jonathan Corbet
2020-05-22  4:22     ` Mauro Carvalho Chehab
2020-05-01 15:37 ` [PATCH 04/14] docs: move IPMI.txt to the driver API book Mauro Carvalho Chehab
2020-05-01 16:16   ` Corey Minyard
2020-05-15 17:56   ` Jonathan Corbet
2020-05-01 15:37 ` [PATCH 05/14] docs: fix references for ipmi.rst file Mauro Carvalho Chehab
2020-05-01 15:37 ` Mauro Carvalho Chehab [this message]
2020-05-15 18:00   ` [PATCH 06/14] docs: debugging-via-ohci1394.txt: add it to the core-api book Jonathan Corbet
2020-05-22  4:26     ` Mauro Carvalho Chehab
2020-05-01 15:37 ` [PATCH 07/14] docs: add IRQ documentation at " Mauro Carvalho Chehab
2020-05-02  7:41   ` Mike Rapoport
2020-05-02 10:16     ` Mauro Carvalho Chehab
2020-05-02 11:21       ` Mike Rapoport
2020-05-15 18:01   ` Jonathan Corbet
2020-05-01 15:37 ` [PATCH 08/14] docs: move kobject and kref docs into " Mauro Carvalho Chehab
2020-05-15 18:03   ` Jonathan Corbet
2020-05-01 15:37 ` [PATCH 09/14] docs: move digsig docs to the security book Mauro Carvalho Chehab
2020-05-15 18:04   ` Jonathan Corbet
2020-05-01 15:37 ` [PATCH 10/14] docs: move locking-specific documenta to locking/ directory Mauro Carvalho Chehab
2020-05-15 18:06   ` Jonathan Corbet
2020-05-22  4:39     ` Mauro Carvalho Chehab
2020-05-01 15:37 ` [PATCH 11/14] docs: move other kAPI documents to core-api Mauro Carvalho Chehab
2020-05-02  7:43   ` Mike Rapoport
2020-05-15 18:10   ` Jonathan Corbet
2020-05-01 15:37 ` [PATCH 12/14] docs: move remaining stuff under Documentation/*.txt to Documentation/staging Mauro Carvalho Chehab
2020-05-03 23:54   ` Masami Hiramatsu
2020-05-04  0:47     ` Joe Perches
2020-05-04  9:51     ` Naveen N. Rao
2020-05-01 15:37 ` [PATCH 13/14] docs: staging: don't use literalinclude Mauro Carvalho Chehab
2020-05-01 15:37 ` [PATCH 14/14] docs: staging: use small font for literal includes Mauro Carvalho Chehab
2020-05-02  0:10   ` Joe Perches
2020-05-02 10:27     ` Mauro Carvalho Chehab
2020-05-04  9:25 ` [PATCH 00/14] Move the ReST files from Documentation/*.txt Akira Yokosawa
2020-05-04  9:50   ` Mauro Carvalho Chehab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=9b489d36d08ad89d3ad5aefef1f52a0715b29716.1588345503.git.mchehab+huawei@kernel.org \
    --to=mchehab+huawei@kernel.org \
    --cc=akpm@linux-foundation.org \
    --cc=anshuman.khandual@arm.com \
    --cc=changbin.du@intel.com \
    --cc=corbet@lwn.net \
    --cc=daniel.m.jordan@oracle.com \
    --cc=jgross@suse.com \
    --cc=krzk@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mike.kravetz@oracle.com \
    --cc=paulmck@kernel.org \
    --cc=pawan.kumar.gupta@linux.intel.com \
    --cc=rdunlap@infradead.org \
    --cc=rppt@linux.ibm.com \
    --cc=sfr@canb.auug.org.au \
    --cc=tglx@linutronix.de \
    --cc=yamada.masahiro@socionext.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).