lk/linux-kernel-test
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

[PATCH] DocBook: include printk documentation

Browse Source 
Add printk documentation to kernel-api.

Signed-off-by: Martin Waitz <tali@admingilde.org>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>
This commit is contained in:
Martin Waitz
2005-11-13 16:08:14 -08:00
committed by Linus Torvalds
parent aeec46b97a
commit ddad86c2d6
2 changed files with 15 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/DocBook/kernel-api.tmpl
View File

@@ -68,9 +68,7 @@ X!Iinclude/linux/kobject.h
<sect1><title>Kernel utility functions</title> <sect1><title>Kernel utility functions</title>
!Iinclude/linux/kernel.h !Iinclude/linux/kernel.h
<!-- This needs to clean up to make kernel-doc happy !Ekernel/printk.c
X!Ekernel/printk.c
-->
!Ekernel/panic.c !Ekernel/panic.c
!Ekernel/sys.c !Ekernel/sys.c
!Ekernel/rcupdate.c !Ekernel/rcupdate.c

16
kernel/printk.c
View File

@@ -491,7 +491,10 @@ __attribute__((weak)) unsigned long long printk_clock(void)
return sched_clock(); return sched_clock();
} }
/* /**
* printk - print a kernel message
* @fmt: format string
*
* This is printk. It can be called from any context. We want it to work. * This is printk. It can be called from any context. We want it to work.
* *
* We try to grab the console_sem. If we succeed, it's easy - we log the output and * We try to grab the console_sem. If we succeed, it's easy - we log the output and
@@ -503,6 +506,9 @@ __attribute__((weak)) unsigned long long printk_clock(void)
* One effect of this deferred printing is that code which calls printk() and * One effect of this deferred printing is that code which calls printk() and
* then changes console_loglevel may break. This is because console_loglevel * then changes console_loglevel may break. This is because console_loglevel
* is inspected when the actual printing occurs. * is inspected when the actual printing occurs.
*
* See also:
* printf(3)
*/ */
asmlinkage int printk(const char *fmt, ...) asmlinkage int printk(const char *fmt, ...)
@@ -655,6 +661,9 @@ static void call_console_drivers(unsigned long start, unsigned long end)
/** /**
* add_preferred_console - add a device to the list of preferred consoles. * add_preferred_console - add a device to the list of preferred consoles.
* @name: device name
* @idx: device index
* @options: options for this console
* *
* The last preferred console added will be used for kernel messages * The last preferred console added will be used for kernel messages
* and stdin/out/err for init. Normally this is used by console_setup * and stdin/out/err for init. Normally this is used by console_setup
@@ -764,7 +773,8 @@ void release_console_sem(void)
} }
EXPORT_SYMBOL(release_console_sem); EXPORT_SYMBOL(release_console_sem);
/** console_conditional_schedule - yield the CPU if required /**
* console_conditional_schedule - yield the CPU if required
* *
* If the console code is currently allowed to sleep, and * If the console code is currently allowed to sleep, and
* if this CPU should yield the CPU to another task, do * if this CPU should yield the CPU to another task, do
@@ -976,6 +986,8 @@ EXPORT_SYMBOL(unregister_console);
/** /**
* tty_write_message - write a message to a certain tty, not just the console. * tty_write_message - write a message to a certain tty, not just the console.
* @tty: the destination tty_struct
* @msg: the message to write
* *
* This is used for messages that need to be redirected to a specific tty. * This is used for messages that need to be redirected to a specific tty.
* We don't put it into the syslog queue right now maybe in the future if * We don't put it into the syslog queue right now maybe in the future if