system/freebsd-src
system/freebsd-src
1
0
Fork 0
mirror of https://github.com/freebsd/freebsd-src synced 2024-10-03 07:04:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refine textdump comments slightly.

Browse source 
MFC after:	3 months
This commit is contained in:
Robert Watson 2008-01-10 00:26:47 +00:00
parent 15d0222f66
commit 9b0fce602a
Notes: svn2git 2020-12-20 02:59:44 +00:00 
svn path=/head/; revision=175199
1 changed files with 12 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
sys/ddb/db_textdump.c
View file

@ -25,12 +25,12 @@
*/
/*-
* Kernel text-dump support: allow a series of text files to be written to
* the dump partition for later recovery, including captured DDB output, the
* kernel configuration, message buffer, panic message, etc. This allows for
* a more compact representation of critical debugging information than
* traditional binary dumps, as well as allowing dump information to be used
* without access to kernel symbols, source code, etc.
* Kernel text-dump support: write a series of text files to the dump
* partition for later recovery, including captured DDB output, kernel
* configuration, message buffer, and panic message. This allows for a more
* compact representation of critical debugging information than traditional
* binary dumps, as well as allowing dump information to be used without
* access to kernel symbols, source code, etc.
*
* Storage Layout
* --------------
@ -46,9 +46,8 @@
* know to reverse the order of the blocks in order to produce a readable
* file.
*
* Data is written out in the 'tar' file format, as it provides the facility
* to write data incrementally as a stream without reference to previous
* files.
* Data is written out in the ustar file format so that we can write data
* incrementally as a stream without reference to previous files.
*
* TODO
* ----
@ -201,7 +200,7 @@ mkdumpheader(struct kerneldumpheader *kdh, uint32_t archver,
}
/*
* Calculate and fill in the checksum for a tar header.
* Calculate and fill in the checksum for a ustar header.
*/
static void
ustar_checksum(struct ustar_header *uhp)
@ -269,6 +268,9 @@ textdump_writeblock(struct dumperinfo *di, off_t offset, char *buffer)
* Interfaces to save and restore the dump offset, so that printers can go
* back to rewrite a header if required, while avoiding their knowing about
* the global layout of the blocks.
*
* If we ever want to support writing textdumps to tape or other
* stream-oriented target, we'll need to remove this.
*/
void
textdump_saveoff(off_t *offsetp)