Commit graph

100 commits

Author SHA1 Message Date
Benedict Reuschling
a14d3c3c2e Rewrite my previous change to use a <variablelist>. That way, it is much
clearer to understand and easier to read than having it all in one long
sentence.

Suggested by:	wblock@
Sponsored by:	Essen Hackathon 2016
2016-04-24 21:23:28 +00:00
Benedict Reuschling
b3f817219a Replace some colons in a long sentence with
semi-colons to make a list which contains
regular commas more readable.

PR:		203345
Submitted by:	munshs@rpi.edu
Sponsored by:	Essen Hackathon 2016
2016-04-24 09:07:06 +00:00
Glen Barber
fcb1ca095f Wrap lines, spacing nits, etc. following previous change.
Translators please ignore.

Sponsored by:	The FreeBSD Foundation
2015-03-12 01:25:02 +00:00
Glen Barber
03c9037828 Fix a few grammatical nits.
Change wording referencing the previous section of the
kerneldebug book.
Reword the 'Add these options' sentence.
Consistify spacing in the KERNCONF addition list.
Fix a typo.

Sponsored by:	The FreeBSD Foundation
2015-03-12 01:23:06 +00:00
Warren Block
21115a05b8 Restore lost <replaceable> tags. 2014-04-28 20:13:07 +00:00
Glen Barber
211922b979 Add WITNESS_SKIPSPIN to the list of kernel debugging options
that should be enabled.

Reviewed by:	sbruno (earlier version), kib
Sponsored by:	The FreeBSD Foundation
2014-01-12 05:08:10 +00:00
Gabor Kovesdan
24d129e8d1 - Definitively upgrade to DocBook 5.0 2013-11-07 15:39:28 +00:00
Gabor Kovesdan
821f9bab5d - MFH 2013-04-11 10:34:45 +00:00
David E. O'Brien
210c653946 Update for uart(4) (FreeBSD 8.0+). 2013-03-23 00:01:14 +00:00
Gabor Kovesdan
a06603e1e8 - MFH 2013-02-05 09:14:34 +00:00
Gabor Kovesdan
d95165dc16 - Make the English documentation valid XML 2013-01-21 17:37:33 +00:00
Isabell Long
2498002187 Add a new section to the developer's handbook about kernel debugging with
Dcons.

Converted from the wiki page [1] by myself as part of Google Code-In 2011.

[1] http://wiki.freebsd.org/DebugWithDcons

Reviewed by:	gavin
Approved by:	gabor (mentor)
2012-10-04 11:04:11 +00:00
Gabor Kovesdan
b4346b9b2d - Rename .sgml files to .xml
- Reflect the rename in referencing files

Approved by:	doceng (implicit)
2012-10-01 09:53:01 +00:00
Gabor Kovesdan
9c243757ef - XML declarations should use IANA encoding names
Pointed out by:	hrs
2012-09-14 17:47:48 +00:00
Gabor Kovesdan
2e51ec7022 - Strip unnecessary trailing spaces
Approved by:	doceng (implicit)
2012-08-21 19:16:02 +00:00
Gabor Kovesdan
7ba98a21ad MFH
Approved by:	doceng (implicit)
2012-08-19 23:05:52 +00:00
Gabor Kovesdan
74586f38c6 - Remove PSGML comments since they are not very useful after the XML
migration

Approved by:		doceng (implicit)
No objection from:	doc@, www@
2012-08-07 23:31:39 +00:00
Isabell Long
e5c7e3910a Describe remote GDB configuration in greater depth in the developer's handbook.
PR:		docs/170013
Submitted by:	Carl Delsey (carl.r.delsey (at) intel.com)
Reviewed by:	gavin
Approved by:	gjb (mentor)
2012-07-20 14:46:08 +00:00
Gabor Kovesdan
3cdf4e4922 - XMLify English books
Approved by:	doceng (implicit)
2012-06-21 16:04:40 +00:00
Ryusuke SUZUKI
3dbe1e3852 PR: docs/159650
Update the description about the dumpdev variable in rc.conf.

Reported by:	Jeremy Chadwick <freebsd _at_ jdc dot parodius dot com>
Reviewed by:	bcr, wblock, freebsd-doc
2012-01-20 15:56:00 +00:00
Alex Dupre
c0b6644e0c Fix 'ddd' command-line parameters for kernel debug.
PR:		docs/127253
Submitted by:	Fritz Katz <frtzkatz@yahoo.com>
2010-12-02 14:53:45 +00:00
Benedict Reuschling
9c4c826a5f Remove two sections about kerneldebugging (post mortem analysis and
loadable modules using gdb) because the steps described in them are
not necessary anymore for quite a long time.

A rewrite would be in order, but since this goes beyond the scope of
the PR, I'll just remove them for now.

PR:             docs/143342
Submitted by:   trasz@
Reviewed by:    jhb@ via trasz@
2010-09-19 18:15:03 +00:00
Murray Stokely
cce21e8660 The config dump syntax for hard-coding the dump location before
dumpon(8) can be executed has been deprecated since FreeBSD 4.x and no
longer works.  Use the loader instead.

PR:    	       docs/129263
2008-12-15 01:04:07 +00:00
Robert Watson
d29331a2ea Textdumps have been merged to RELENG_7, and so should appear in 7.1 and
higher.
2008-04-11 08:11:08 +00:00
Tom Rhodes
7738652c36 Replace 'debug.debugger_on_panic=1' with 'debug.kdb.enter=1' which actually
exists.  Add a note on forcing a panic using 'debug.kdb.panic=1'.

PR:	111781
2008-01-22 17:47:05 +00:00
Robert Watson
21c0c8925b Mention full memor dumps, minidumps, and textdumps in the introduction
to kernel debugging, with consequences for debugging.

Mention that the default in more recent FreeBSD versions is to
automatically select a swap partition and use it as a dump partition,
and don't suggest changing the default.

This chapter could use rather serious updating.
2007-12-26 12:56:46 +00:00
Marc Fonvieille
75131fca35 Add a missing P in a kernel option
PR:		docs/108270
Submitted by:	Micah <micahjon@ywave.com>
2007-01-23 17:52:10 +00:00
Robert Watson
2ce1741cd1 Correct spelling of "show alllocks" from "show all locks".
Submitted by:	Ben Kaduk <minimarmot@gmail.com>
2007-01-02 19:02:00 +00:00
Robert Watson
286446c1d8 Correct some minor spelling and content errors in the remainder of the
kernel debugging chapter that I noticed while adding the glossary.
2006-12-31 14:27:17 +00:00
Ceri Davies
403d49b0c2 Correct minor typos. 2006-12-31 12:23:45 +00:00
Robert Watson
06360975af Add a glossary of compile-time kernel debugging options. 2006-12-31 11:24:34 +00:00
Marc Fonvieille
e13bdf2a4b Various typo and punctuation fixes. 2006-08-28 18:59:16 +00:00
Tom Rhodes
17ff867e1c Change "option" to "options" since we have two.
Fix options list to those in the manual page.
Fix description of "continue."
2006-07-16 18:41:52 +00:00
Tom Rhodes
cc2a284275 MFp4: Bring the kernel debugging section up to reality.
Requested by:	rwatson
2006-07-12 02:18:19 +00:00
Joel Dahl
d5140b068d Improve wording and grammar.
Reviewed by:	brd
2006-06-16 20:47:14 +00:00
Konstantin Belousov
283f123ffc Document the procedure to obtain the debugging information
when the system deadlocks.

Approved by: pjd (mentor)
2006-06-13 10:48:58 +00:00
Xin LI
e140896ec8 Escape <, >, &'s, plus some cleanups against the SGML. There should not
be any content changes involved in this commit, however, localization
teams are encouraged to catch up with this change.

Requested by:	intron at intron ac
Reviewed by:	Niclas Zeising <lothrandil at n00b apagnu se>
Glanced by:	simon
2006-01-05 20:03:39 +00:00
Xin LI
bd9dc44478 Remove a duplicated "line". 2006-01-02 13:18:55 +00:00
Christian Brueffer
ec04638a2f dumpdir is correct here, not dumpdev.
PR:		81361
Submitted by:	Marius Nuennerich <marius.nuennerich@gmx.net>
2005-05-22 14:27:30 +00:00
Simon L. B. Nielsen
1caa123f8e Correct path to kernel.debug.
Submitted by:	yunweb@yunweb.homeunix.org
2005-05-01 08:23:12 +00:00
Marc Fonvieille
1d3fa1bf1e Add a missing word.
PR:		docs/79311
Submitted by:	Linus Nordberg <linus@nordberg.se>
2005-03-28 18:01:41 +00:00
Tom Rhodes
991f86250f Add a note about what versions of FreeBSD use kgdb and what versions do not.
Suggested by:	simon
2005-03-01 07:00:29 +00:00
Peter Pentchev
b8168a63b9 Fix a typo - 'ouput' -> 'output'.
PR:		78007
Submitted by:	"Jesus R. Camou" <jcamou@cox.net>
2005-02-24 13:21:55 +00:00
Tom Rhodes
c235a5efeb Update for reality: kgdb not gdb -k.
PR:	75536 and 72925
2005-02-24 04:45:43 +00:00
Simon L. B. Nielsen
ed68a6151d - Remove a few contractions.
PR:		docs/77778
Submitted by:	Joel Dahl <joel@automatvapen.se>
2005-02-20 14:53:33 +00:00
Simon L. B. Nielsen
3fe2ada25c Fixup of whitespace from last commit.
Translators can ignore this commit.
2004-12-12 12:29:42 +00:00
Simon L. B. Nielsen
e02a5ba50a Improve mark-up a bit:
- Use a manual page reference for gdb(1).
- Use <replaceable>.
- Do not embed <screen> sections in <para> sections.
2004-12-12 12:21:49 +00:00
Denis Peplin
c12c11040e Use url entities for links between docs 2004-08-05 10:04:31 +00:00
Josef El-Rayes
6d05c0410f Modify the author information into standard used through out the handbook.
Discussed on:	freebsd-doc@
2004-05-16 21:28:34 +00:00
Sean Chittenden
10be000a0a Update the section on debugging a kernel with GDB to include a recent
dump and the basics of what most developers would like to see in reports
of a panic where a dump is available.  Also trim a few lines from the
previous dump example (still included) and sync up some of the gdb
commands for the sake of consistency.

Inspired by:	Recent exchange with jhb
2003-12-04 01:46:33 +00:00