lwn.git/Documentation/dev-tools/kgdb.rst, branch docs-6.8-2

Documentation: kgdb: Replace deprecated remotebaud

2022-01-07T16:33:13+00:00

Using set remotebaud to set the baud rate was deprecated in gdb-7.7 and completely removed from the command parser in gdb-7.8 (released in 2014). Adopt set serial baud instead. Signed-off-by: Christian Loehle Reviewed-by: Daniel Thompson Link: https://lore.kernel.org/r/4050689967ed46baaa3bfadda53a0e73@hyperstone.com Signed-off-by: Jonathan Corbet

Documentation: kgdb: properly capitalize the MAGIC_SYSRQ config

2022-01-03T22:54:00+00:00

Most readers are probably going to figure out that the config is actually all upper-case letters, as all Kconfig symbols are this way. Properly capitalizing makes the script ./scripts/checkkconfigsymbols.py happy, which otherwise would report this as a reference to a non-existing Kconfig symbol. So, use the right capitalization for the MAGIC_SYSRQ config in the kgdb documentation. Signed-off-by: Lukas Bulwahn Link: https://lore.kernel.org/r/20211230172423.30430-1-lukas.bulwahn@gmail.com Signed-off-by: Jonathan Corbet

Documentation: kgdb: Fix a typo

2020-11-18T20:47:17+00:00

"to into" -> "into" Reported-by: Sergei Shtylyov Signed-off-by: Tiezhu Yang Acked-by: Daniel Thompson Link: https://lore.kernel.org/r/1605519767-25502-1-git-send-email-yangtiezhu@loongson.cn Signed-off-by: Jonathan Corbet

docs: kgdb.rst: fix :c:type: usages

2020-10-15T05:49:44+00:00

Which Sphinx 3, :c:type: can't be used anymore for structs, as this should be used only for typedefs. Rely on automarkup.py for struct references. This file has an special case, though: it uses the tag also to point to an array. Let's use, instead, :c:expr: for such purpose, as it should do the right thing. This should fix this warning: ./Documentation/dev-tools/kgdb.rst:875: WARNING: Unparseable C cross-reference: 'kdb_poll_funcs[]' Invalid C declaration: Expected end of definition. [error at 14] kdb_poll_funcs[] --------------^ Acked-by: Daniel Thompson Signed-off-by: Mauro Carvalho Chehab

Dev-tools: Documentation: Replace deprecated :c:func: Usage

2020-08-11T16:24:10+00:00

Replace :c:func: with func() as the previous usage is deprecated. Signed-off-by: Puranjay Mohan Link: https://lore.kernel.org/r/20200810183613.25643-1-puranjay12@gmail.com Signed-off-by: Jonathan Corbet

Documentation: kgdb: eliminate duplicated word

2020-07-13T15:44:06+00:00

Drop the doubled word "driver". Signed-off-by: Randy Dunlap Reviewed-by: Douglas Anderson Acked-by: Daniel Thompson Cc: Jonathan Corbet Cc: linux-doc@vger.kernel.org Cc: Jason Wessel Cc: Daniel Thompson Cc: Douglas Anderson Cc: kgdb-bugreport@lists.sourceforge.net Link: https://lore.kernel.org/r/20200707180414.10467-5-rdunlap@infradead.org Signed-off-by: Jonathan Corbet

Documentation: kgdboc: Document new kgdboc_earlycon parameter

2020-06-02T14:15:45+00:00

The recent patch ("kgdboc: Add kgdboc_earlycon to support early kgdb using boot consoles") adds a new kernel command line parameter. Document it. Note that the patch adding the feature does some comparing/contrasting of "kgdboc_earlycon" vs. the existing "ekgdboc". See that patch for more details, but briefly "ekgdboc" can be used _instead_ of "kgdboc" and just makes "kgdboc" do its normal initialization early (only works if your tty driver is already ready). The new "kgdboc_earlycon" works in combination with "kgdboc" and is backed by boot consoles. Signed-off-by: Douglas Anderson Reviewed-by: Greg Kroah-Hartman Reviewed-by: Daniel Thompson Link: https://lore.kernel.org/r/20200507130644.v4.9.I7d5eb42c6180c831d47aef1af44d0b8be3fac559@changeid Signed-off-by: Daniel Thompson

docs: disable KASLR when debugging kernel

2017-07-17T20:40:40+00:00

commit 6807c84652b0 ("x86: Enable KASLR by default") enables KASLR by default on x86. While KASLR will confuse gdb which resolve kernel symbol address from symbol table of vmlinux. We should turn off KASLR for kernel debugging. Signed-off-by: Zhouyi Zhou Signed-off-by: Jonathan Corbet

kgdb.rst: Adjust ReST markups

2017-05-16T11:44:04+00:00

The automatic conversion didn't work too well for this file. It added weird html blocks inside it, and did some weird things for literals. Manually fix it, in order to present a nice display at html/pdf outputs. Signed-off-by: Mauro Carvalho Chehab

docs-rst: convert kgdb DocBook to ReST

2017-05-16T11:44:04+00:00

Use pandoc to convert documentation to ReST by calling Documentation/sphinx/tmplcvt script. Signed-off-by: Mauro Carvalho Chehab