Skip to content

Commit 2d88fc6

Browse files
puranjaymohanJonathan Corbet
authored andcommitted
Dev-tools: Documentation: Replace deprecated :c:func: Usage
Replace :c:func: with func() as the previous usage is deprecated. Signed-off-by: Puranjay Mohan <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
1 parent 7caf3e3 commit 2d88fc6

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

Documentation/dev-tools/kgdb.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@ driver as a loadable kernel module kgdbwait will not do anything.
316316
Kernel parameter: ``kgdbcon``
317317
-----------------------------
318318

319-
The ``kgdbcon`` feature allows you to see :c:func:`printk` messages inside gdb
319+
The ``kgdbcon`` feature allows you to see printk() messages inside gdb
320320
while gdb is connected to the kernel. Kdb does not make use of the kgdbcon
321321
feature.
322322

@@ -432,7 +432,7 @@ This is a quick example of how to use kdb.
432432
``ps`` Displays only the active processes
433433
``ps A`` Shows all the processes
434434
``summary`` Shows kernel version info and memory usage
435-
``bt`` Get a backtrace of the current process using :c:func:`dump_stack`
435+
``bt`` Get a backtrace of the current process using dump_stack()
436436
``dmesg`` View the kernel syslog buffer
437437
``go`` Continue the system
438438
=========== =================================================================
@@ -724,7 +724,7 @@ The kernel debugger is organized into a number of components:
724724
The arch-specific portion implements:
725725

726726
- contains an arch-specific trap catcher which invokes
727-
:c:func:`kgdb_handle_exception` to start kgdb about doing its work
727+
kgdb_handle_exception() to start kgdb about doing its work
728728

729729
- translation to and from gdb specific packet format to :c:type:`pt_regs`
730730

@@ -769,7 +769,7 @@ The kernel debugger is organized into a number of components:
769769
config. Later run ``modprobe kdb_hello`` and the next time you
770770
enter the kdb shell, you can run the ``hello`` command.
771771

772-
- The implementation for :c:func:`kdb_printf` which emits messages directly
772+
- The implementation for kdb_printf() which emits messages directly
773773
to I/O drivers, bypassing the kernel log.
774774

775775
- SW / HW breakpoint management for the kdb shell
@@ -875,7 +875,7 @@ kernel when ``CONFIG_KDB_KEYBOARD=y`` is set in the kernel configuration.
875875
The core polled keyboard driver for PS/2 type keyboards is in
876876
``drivers/char/kdb_keyboard.c``. This driver is hooked into the debug core
877877
when kgdboc populates the callback in the array called
878-
:c:type:`kdb_poll_funcs[]`. The :c:func:`kdb_get_kbd_char` is the top-level
878+
:c:type:`kdb_poll_funcs[]`. The kdb_get_kbd_char() is the top-level
879879
function which polls hardware for single character input.
880880

881881
kgdboc and kms
@@ -887,10 +887,10 @@ that you have a video driver which has a frame buffer console and atomic
887887
kernel mode setting support.
888888

889889
Every time the kernel debugger is entered it calls
890-
:c:func:`kgdboc_pre_exp_handler` which in turn calls :c:func:`con_debug_enter`
890+
kgdboc_pre_exp_handler() which in turn calls con_debug_enter()
891891
in the virtual console layer. On resuming kernel execution, the kernel
892-
debugger calls :c:func:`kgdboc_post_exp_handler` which in turn calls
893-
:c:func:`con_debug_leave`.
892+
debugger calls kgdboc_post_exp_handler() which in turn calls
893+
con_debug_leave().
894894

895895
Any video driver that wants to be compatible with the kernel debugger
896896
and the atomic kms callbacks must implement the ``mode_set_base_atomic``,

0 commit comments

Comments
 (0)