printk: Move the printk() kerneldoc comment to its new home
Commit3370155737
("printk: Userspace format indexing support") turned printk() into a macro, but left the kerneldoc comment for it with the (now) _printk() function, resulting in this docs-build warning: kernel/printk/printk.c:1: warning: 'printk' not found Move the kerneldoc comment back next to the (now) macro it's meant to describe and have the docs build find it there. Fixes:3370155737
("printk: Userspace format indexing support") Signed-off-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Petr Mladek <pmladek@suse.com> Link: https://lore.kernel.org/r/87o8aqt7qn.fsf@meer.lwn.net
This commit is contained in:
Родитель
0f0aa84850
Коммит
7d9e2661f2
|
@ -107,9 +107,6 @@ also ``CONFIG_DYNAMIC_DEBUG`` in the case of pr_debug()) is defined.
|
|||
Function reference
|
||||
==================
|
||||
|
||||
.. kernel-doc:: kernel/printk/printk.c
|
||||
:functions: printk
|
||||
|
||||
.. kernel-doc:: include/linux/printk.h
|
||||
:functions: pr_emerg pr_alert pr_crit pr_err pr_warn pr_notice pr_info
|
||||
:functions: printk pr_emerg pr_alert pr_crit pr_err pr_warn pr_notice pr_info
|
||||
pr_fmt pr_debug pr_devel pr_cont
|
||||
|
|
|
@ -431,6 +431,30 @@ struct pi_entry {
|
|||
})
|
||||
|
||||
|
||||
/**
|
||||
* printk - print a kernel message
|
||||
* @fmt: format string
|
||||
*
|
||||
* This is printk(). It can be called from any context. We want it to work.
|
||||
*
|
||||
* If printk indexing is enabled, _printk() is called from printk_index_wrap.
|
||||
* Otherwise, printk is simply #defined to _printk.
|
||||
*
|
||||
* We try to grab the console_lock. If we succeed, it's easy - we log the
|
||||
* output and call the console drivers. If we fail to get the semaphore, we
|
||||
* place the output into the log buffer and return. The current holder of
|
||||
* the console_sem will notice the new output in console_unlock(); and will
|
||||
* send it to the consoles before releasing the lock.
|
||||
*
|
||||
* One effect of this deferred printing is that code which calls printk() and
|
||||
* then changes console_loglevel may break. This is because console_loglevel
|
||||
* is inspected when the actual printing occurs.
|
||||
*
|
||||
* See also:
|
||||
* printf(3)
|
||||
*
|
||||
* See the vsnprintf() documentation for format string extensions over C99.
|
||||
*/
|
||||
#define printk(fmt, ...) printk_index_wrap(_printk, fmt, ##__VA_ARGS__)
|
||||
#define printk_deferred(fmt, ...) \
|
||||
printk_index_wrap(_printk_deferred, fmt, ##__VA_ARGS__)
|
||||
|
|
|
@ -2183,30 +2183,6 @@ int vprintk_default(const char *fmt, va_list args)
|
|||
}
|
||||
EXPORT_SYMBOL_GPL(vprintk_default);
|
||||
|
||||
/**
|
||||
* _printk - print a kernel message
|
||||
* @fmt: format string
|
||||
*
|
||||
* This is _printk(). It can be called from any context. We want it to work.
|
||||
*
|
||||
* If printk indexing is enabled, _printk() is called from printk_index_wrap.
|
||||
* Otherwise, printk is simply #defined to _printk.
|
||||
*
|
||||
* We try to grab the console_lock. If we succeed, it's easy - we log the
|
||||
* output and call the console drivers. If we fail to get the semaphore, we
|
||||
* place the output into the log buffer and return. The current holder of
|
||||
* the console_sem will notice the new output in console_unlock(); and will
|
||||
* send it to the consoles before releasing the lock.
|
||||
*
|
||||
* One effect of this deferred printing is that code which calls printk() and
|
||||
* then changes console_loglevel may break. This is because console_loglevel
|
||||
* is inspected when the actual printing occurs.
|
||||
*
|
||||
* See also:
|
||||
* printf(3)
|
||||
*
|
||||
* See the vsnprintf() documentation for format string extensions over C99.
|
||||
*/
|
||||
asmlinkage __visible int _printk(const char *fmt, ...)
|
||||
{
|
||||
va_list args;
|
||||
|
|
Загрузка…
Ссылка в новой задаче