include/debug.h: Move to include/nuttx/debug.h

debug.h is a NuttX-specific, non-POSIX header. Placing it in the
top-level include/ directory creates naming conflicts with external
projects that define their own debug.h.
This commit moves the canonical header to include/nuttx/debug.h,
following the NuttX convention for non-POSIX/non-standard headers,
and updates all in-tree references.

A backward-compatibility shim is left at include/debug.h that
emits a deprecation #warning and re-includes <nuttx/debug.h>,
allowing out-of-tree code to continue building while migrating.

Signed-off-by: Piyush Patle <piyushpatle228@gmail.com>
This commit is contained in:
Piyush Patle
2026-04-01 05:11:15 +05:30
committed by Alan C. Assis
parent 900998fe20
commit 0dccc8ba21
5719 changed files with 7189 additions and 7161 deletions
@@ -97,7 +97,7 @@ Debug Interfaces
In NuttX, syslog output is really synonymous to debug output and, In NuttX, syslog output is really synonymous to debug output and,
therefore, the debugging interface macros defined in the header therefore, the debugging interface macros defined in the header
file ``include/debug.h`` are also syslogging interfaces. Those file ``include/nuttx/debug.h`` are also syslogging interfaces. Those
macros are simply wrappers around ``syslog()``. The debugging macros are simply wrappers around ``syslog()``. The debugging
interfaces differ from the syslog interfaces in that: interfaces differ from the syslog interfaces in that:
+1 -1
View File
@@ -68,7 +68,7 @@ There is also a ``misc/`` subdirectory that contains various internal functions
and interfaces from header files that are too few to warrant their own sub- and interfaces from header files that are too few to warrant their own sub-
directory:: directory::
misc - Nonstandard "glue" logic, debug.h, crc32.h, dirent.h misc - Nonstandard "glue" logic, nuttx/debug.h, crc32.h, dirent.h
Library Database Library Database
================ ================
@@ -936,7 +936,7 @@ Appendix : out-of-tree code
+ +
+#include <nuttx/config.h> +#include <nuttx/config.h>
+ +
+#include <debug.h> +#include <nuttx/debug.h>
+ +
+#include <nuttx/board.h> +#include <nuttx/board.h>
+#include <arch/board/board.h> +#include <arch/board/board.h>
@@ -368,7 +368,7 @@ NOTES:
for this. for this.
- /dev/console still exists and still refers to the serial port. So - /dev/console still exists and still refers to the serial port. So
you can still use certain kinds of debug output (see include/debug.h, all you can still use certain kinds of debug output (see include/nuttx/debug.h, all
of the debug output from interrupt handlers will be lost. of the debug output from interrupt handlers will be lost.
- But don't enable USB debug output! Since USB is console is used for - But don't enable USB debug output! Since USB is console is used for
@@ -504,7 +504,7 @@ NOTES:
for this. for this.
- /dev/console still exists and still refers to the serial port. So - /dev/console still exists and still refers to the serial port. So
you can still use certain kinds of debug output (see include/debug.h, all you can still use certain kinds of debug output (see include/nuttx/debug.h, all
debug output from interrupt handlers will be lost. debug output from interrupt handlers will be lost.
- But don't enable USB debug output! Since USB is console is used for - But don't enable USB debug output! Since USB is console is used for
@@ -1644,7 +1644,7 @@ NOTES:
for this. for this.
- /dev/console still exists and still refers to the serial port. So - /dev/console still exists and still refers to the serial port. So
you can still use certain kinds of debug output (see include/debug.h, all you can still use certain kinds of debug output (see include/nuttx/debug.h, all
of the debug output from interrupt handlers will be lost. of the debug output from interrupt handlers will be lost.
- But don't enable USB debug output! Since USB is console is used for - But don't enable USB debug output! Since USB is console is used for
+3 -3
View File
@@ -27,7 +27,7 @@ following options:
You can then select from the subsystems that are available, Network, Scheduler, USB, etc. Note that you will need to You can then select from the subsystems that are available, Network, Scheduler, USB, etc. Note that you will need to
separately enable the subsystem elsewhere in the ``menuconfig`` system. To see the ``CONFIG`` define that is set, separately enable the subsystem elsewhere in the ``menuconfig`` system. To see the ``CONFIG`` define that is set,
use the arrow keys to highlight the subsystem (for instance, :menuselection:`Network Debug Features`) and type :kbd:`?`. This will show use the arrow keys to highlight the subsystem (for instance, :menuselection:`Network Debug Features`) and type :kbd:`?`. This will show
you that the C macro that is set is called ``CONFIG_DEBUG_NET``. ``debug.h`` defines the ``netinfo()`` logging you that the C macro that is set is called ``CONFIG_DEBUG_NET``. ``nuttx/debug.h`` defines the ``netinfo()`` logging
function that will log output if this macro is set. You can search the source code for ``netinfo`` to see how it is function that will log output if this macro is set. You can search the source code for ``netinfo`` to see how it is
used. used.
@@ -39,13 +39,13 @@ used.
Note that enabling all these will produce an incredible amount of logging output. Enable the level you want and Note that enabling all these will produce an incredible amount of logging output. Enable the level you want and
the area you're interested in, and leave the rest disabled, save the config, and then recompile. You can see the full the area you're interested in, and leave the rest disabled, save the config, and then recompile. You can see the full
list of debug feature logging functions in the file list of debug feature logging functions in the file
`debug.h <https://github.com/apache/nuttx/blob/master/include/debug.h>`__. `debug.h <https://github.com/apache/nuttx/blob/master/include/nuttx/debug.h>`__.
Syslog timestamps can be enabled in the configuration in :menuselection:`Device Drivers --> System Logging --> Prepend Syslog timestamps can be enabled in the configuration in :menuselection:`Device Drivers --> System Logging --> Prepend
timestamp to syslog message` (``CONFIG_SYSLOG_TIMESTAMP``). timestamp to syslog message` (``CONFIG_SYSLOG_TIMESTAMP``).
You may need to do a little bit of experimenting to find the combination of logging settings that work for the problem You may need to do a little bit of experimenting to find the combination of logging settings that work for the problem
you're trying to solve. See the file `debug.h <https://github.com/apache/nuttx/blob/master/include/debug.h>`_ you're trying to solve. See the file `debug.h <https://github.com/apache/nuttx/blob/master/include/nuttx/debug.h>`_
for available debug settings that are available. for available debug settings that are available.
There are also subsystems that enable USB trace debugging, and you can log to memory too, if you need the logging to be There are also subsystems that enable USB trace debugging, and you can log to memory too, if you need the logging to be
+1 -1
View File
@@ -29,8 +29,8 @@
#include <stdint.h> #include <stdint.h>
#include <assert.h> #include <assert.h>
#include <errno.h> #include <errno.h>
#include <debug.h>
#include <nuttx/debug.h>
#include <nuttx/irq.h> #include <nuttx/irq.h>
#include <nuttx/arch.h> #include <nuttx/arch.h>
+1 -1
View File
@@ -29,8 +29,8 @@
#include <stdint.h> #include <stdint.h>
#include <time.h> #include <time.h>
#include <errno.h> #include <errno.h>
#include <debug.h>
#include <nuttx/debug.h>
#include <nuttx/irq.h> #include <nuttx/irq.h>
#include <nuttx/arch.h> #include <nuttx/arch.h>
#include <arch/board/board.h> #include <arch/board/board.h>
+1 -1
View File
@@ -34,7 +34,7 @@
#include <string.h> #include <string.h>
#include <assert.h> #include <assert.h>
#include <errno.h> #include <errno.h>
#include <debug.h> #include <nuttx/debug.h>
#ifdef CONFIG_SERIAL_TERMIOS #ifdef CONFIG_SERIAL_TERMIOS
# include <termios.h> # include <termios.h>
#endif #endif
+1 -1
View File
@@ -28,7 +28,7 @@
#include <stdint.h> #include <stdint.h>
#include <assert.h> #include <assert.h>
#include <debug.h> #include <nuttx/debug.h>
#include <nuttx/cache.h> #include <nuttx/cache.h>
#ifdef CONFIG_LEGACY_PAGING #ifdef CONFIG_LEGACY_PAGING
+1 -1
View File
@@ -45,7 +45,7 @@
#include <string.h> #include <string.h>
#include <assert.h> #include <assert.h>
#include <errno.h> #include <errno.h>
#include <debug.h> #include <nuttx/debug.h>
#include <nuttx/video/edid.h> #include <nuttx/video/edid.h>
+1 -1
View File
@@ -33,7 +33,7 @@
#include <stdbool.h> #include <stdbool.h>
#include <assert.h> #include <assert.h>
#include <errno.h> #include <errno.h>
#include <debug.h> #include <nuttx/debug.h>
#include <nuttx/arch.h> #include <nuttx/arch.h>
#include <nuttx/irq.h> #include <nuttx/irq.h>
+1 -1
View File
@@ -45,7 +45,7 @@
#include <string.h> #include <string.h>
#include <assert.h> #include <assert.h>
#include <errno.h> #include <errno.h>
#include <debug.h> #include <nuttx/debug.h>
#include <nuttx/arch.h> #include <nuttx/arch.h>
#include <nuttx/video/fb.h> #include <nuttx/video/fb.h>
+1 -1
View File
@@ -33,7 +33,7 @@
#include <string.h> #include <string.h>
#include <assert.h> #include <assert.h>
#include <errno.h> #include <errno.h>
#include <debug.h> #include <nuttx/debug.h>
#ifdef CONFIG_SERIAL_TERMIOS #ifdef CONFIG_SERIAL_TERMIOS
# include <termios.h> # include <termios.h>
#endif #endif
+1 -1
View File
@@ -30,7 +30,7 @@
#include <stdbool.h> #include <stdbool.h>
#include <assert.h> #include <assert.h>
#include <errno.h> #include <errno.h>
#include <debug.h> #include <nuttx/debug.h>
#include <nuttx/sched.h> #include <nuttx/sched.h>
+1 -1
View File
@@ -28,7 +28,7 @@
#include <stdint.h> #include <stdint.h>
#include <assert.h> #include <assert.h>
#include <debug.h> #include <nuttx/debug.h>
#include <nuttx/sched.h> #include <nuttx/sched.h>
#include <nuttx/page.h> #include <nuttx/page.h>
+1 -1
View File
@@ -29,8 +29,8 @@
#include <inttypes.h> #include <inttypes.h>
#include <stdint.h> #include <stdint.h>
#include <assert.h> #include <assert.h>
#include <debug.h>
#include <nuttx/debug.h>
#include <nuttx/irq.h> #include <nuttx/irq.h>
#include "sched/sched.h" #include "sched/sched.h"
+1 -1
View File
@@ -26,7 +26,7 @@
#include <nuttx/config.h> #include <nuttx/config.h>
#include <debug.h> #include <nuttx/debug.h>
#include <nuttx/sched.h> #include <nuttx/sched.h>
#include <nuttx/page.h> #include <nuttx/page.h>
+1 -1
View File
@@ -29,8 +29,8 @@
#include <inttypes.h> #include <inttypes.h>
#include <stdint.h> #include <stdint.h>
#include <assert.h> #include <assert.h>
#include <debug.h>
#include <nuttx/debug.h>
#include <nuttx/irq.h> #include <nuttx/irq.h>
#ifdef CONFIG_LEGACY_PAGING #ifdef CONFIG_LEGACY_PAGING
# include <nuttx/page.h> # include <nuttx/page.h>
+1 -1
View File
@@ -28,8 +28,8 @@
#include <stdint.h> #include <stdint.h>
#include <sched.h> #include <sched.h>
#include <debug.h>
#include <nuttx/debug.h>
#include <nuttx/irq.h> #include <nuttx/irq.h>
#include <nuttx/arch.h> #include <nuttx/arch.h>
+1 -1
View File
@@ -29,8 +29,8 @@
#include <stdint.h> #include <stdint.h>
#include <sched.h> #include <sched.h>
#include <assert.h> #include <assert.h>
#include <debug.h>
#include <nuttx/debug.h>
#include <nuttx/irq.h> #include <nuttx/irq.h>
#include <nuttx/arch.h> #include <nuttx/arch.h>
#include <nuttx/board.h> #include <nuttx/board.h>
+1 -1
View File
@@ -28,7 +28,7 @@
#include <stdint.h> #include <stdint.h>
#include <assert.h> #include <assert.h>
#include <debug.h> #include <nuttx/debug.h>
#include <syscall.h> #include <syscall.h>
#include <nuttx/addrenv.h> #include <nuttx/addrenv.h>
+1 -1
View File
@@ -28,7 +28,7 @@
#include <stdint.h> #include <stdint.h>
#include <assert.h> #include <assert.h>
#include <debug.h> #include <nuttx/debug.h>
#include <nuttx/arch.h> #include <nuttx/arch.h>
#include <sched/sched.h> #include <sched/sched.h>
+1 -1
View File
@@ -28,7 +28,7 @@
#include <stdint.h> #include <stdint.h>
#include <assert.h> #include <assert.h>
#include <debug.h> #include <nuttx/debug.h>
#include <nuttx/sched.h> #include <nuttx/sched.h>
#include <nuttx/page.h> #include <nuttx/page.h>
+1 -1
View File
@@ -27,8 +27,8 @@
#include <nuttx/config.h> #include <nuttx/config.h>
#include <nuttx/coredump.h> #include <nuttx/coredump.h>
#include <sys/types.h> #include <sys/types.h>
#include <debug.h>
#include <nuttx/debug.h>
#include <nuttx/irq.h> #include <nuttx/irq.h>
#include "arm_internal.h" #include "arm_internal.h"
+1 -1
View File
@@ -29,7 +29,7 @@
#include <stdint.h> #include <stdint.h>
#include <string.h> #include <string.h>
#include <assert.h> #include <assert.h>
#include <debug.h> #include <nuttx/debug.h>
#include <arch/irq.h> #include <arch/irq.h>
+1 -1
View File
@@ -27,8 +27,8 @@
#include <nuttx/config.h> #include <nuttx/config.h>
#include <errno.h> #include <errno.h>
#include <debug.h>
#include <nuttx/debug.h>
#include <nuttx/irq.h> #include <nuttx/irq.h>
#include <nuttx/arch.h> #include <nuttx/arch.h>
#include <nuttx/spinlock.h> #include <nuttx/spinlock.h>
+1 -1
View File
@@ -27,7 +27,7 @@
#include <nuttx/config.h> #include <nuttx/config.h>
#include <assert.h> #include <assert.h>
#include <debug.h> #include <nuttx/debug.h>
#include <inttypes.h> #include <inttypes.h>
#include <nuttx/arch.h> #include <nuttx/arch.h>
+1 -1
View File
@@ -29,8 +29,8 @@
#include <stdint.h> #include <stdint.h>
#include <sched.h> #include <sched.h>
#include <assert.h> #include <assert.h>
#include <debug.h>
#include <nuttx/debug.h>
#include <nuttx/irq.h> #include <nuttx/irq.h>
#include <nuttx/arch.h> #include <nuttx/arch.h>
+1 -1
View File
@@ -29,8 +29,8 @@
#include <stdint.h> #include <stdint.h>
#include <sched.h> #include <sched.h>
#include <assert.h> #include <assert.h>
#include <debug.h>
#include <nuttx/debug.h>
#include <nuttx/irq.h> #include <nuttx/irq.h>
#include <nuttx/arch.h> #include <nuttx/arch.h>
#include <nuttx/board.h> #include <nuttx/board.h>
+1 -1
View File
@@ -30,7 +30,7 @@
#include <stdint.h> #include <stdint.h>
#include <string.h> #include <string.h>
#include <assert.h> #include <assert.h>
#include <debug.h> #include <nuttx/debug.h>
#include <syscall.h> #include <syscall.h>
#include <arch/irq.h> #include <arch/irq.h>
+1 -1
View File
@@ -97,7 +97,7 @@
#include <string.h> #include <string.h>
#include <assert.h> #include <assert.h>
#include <debug.h> #include <nuttx/debug.h>
#include <nuttx/arch.h> #include <nuttx/arch.h>
#include <nuttx/pgalloc.h> #include <nuttx/pgalloc.h>
+1 -1
View File
@@ -98,7 +98,7 @@
#include <errno.h> #include <errno.h>
#include <assert.h> #include <assert.h>
#include <debug.h> #include <nuttx/debug.h>
#include <nuttx/sched.h> #include <nuttx/sched.h>
#include <nuttx/kmalloc.h> #include <nuttx/kmalloc.h>
+1 -1
View File
@@ -81,7 +81,7 @@
#include <string.h> #include <string.h>
#include <assert.h> #include <assert.h>
#include <debug.h> #include <nuttx/debug.h>
#include <nuttx/arch.h> #include <nuttx/arch.h>
#include <nuttx/sched.h> #include <nuttx/sched.h>
+1 -1
View File
@@ -29,7 +29,7 @@
#include <string.h> #include <string.h>
#include <assert.h> #include <assert.h>
#include <errno.h> #include <errno.h>
#include <debug.h> #include <nuttx/debug.h>
#include <nuttx/pgalloc.h> #include <nuttx/pgalloc.h>
#include <nuttx/irq.h> #include <nuttx/irq.h>
+1 -1
View File
@@ -30,7 +30,7 @@
#include <stdbool.h> #include <stdbool.h>
#include <assert.h> #include <assert.h>
#include <errno.h> #include <errno.h>
#include <debug.h> #include <nuttx/debug.h>
#include <nuttx/sched.h> #include <nuttx/sched.h>
+1 -1
View File
@@ -28,7 +28,7 @@
#include <stdint.h> #include <stdint.h>
#include <assert.h> #include <assert.h>
#include <debug.h> #include <nuttx/debug.h>
#include <nuttx/sched.h> #include <nuttx/sched.h>
#include <nuttx/page.h> #include <nuttx/page.h>
+1 -1
View File
@@ -25,7 +25,7 @@
***************************************************************************/ ***************************************************************************/
#include <nuttx/config.h> #include <nuttx/config.h>
#include <debug.h> #include <nuttx/debug.h>
#include <assert.h> #include <assert.h>
#include <nuttx/arch.h> #include <nuttx/arch.h>
#include <arch/irq.h> #include <arch/irq.h>
+1 -1
View File
@@ -28,7 +28,7 @@
#include <stdint.h> #include <stdint.h>
#include <assert.h> #include <assert.h>
#include <debug.h> #include <nuttx/debug.h>
#include <nuttx/arch.h> #include <nuttx/arch.h>
#include <nuttx/sched.h> #include <nuttx/sched.h>
+1 -1
View File
@@ -28,8 +28,8 @@
#include <stdint.h> #include <stdint.h>
#include <assert.h> #include <assert.h>
#include <debug.h>
#include <nuttx/debug.h>
#include <nuttx/irq.h> #include <nuttx/irq.h>
#include "mmu.h" #include "mmu.h"
+1 -1
View File
@@ -28,7 +28,7 @@
#include <stdint.h> #include <stdint.h>
#include <assert.h> #include <assert.h>
#include <debug.h> #include <nuttx/debug.h>
#include <nuttx/addrenv.h> #include <nuttx/addrenv.h>
#include <nuttx/irq.h> #include <nuttx/irq.h>
+1 -1
View File
@@ -28,7 +28,7 @@
#include <stdint.h> #include <stdint.h>
#include <syslog.h> #include <syslog.h>
#include <debug.h> #include <nuttx/debug.h>
#include "arm_internal.h" #include "arm_internal.h"
#include "gic.h" #include "gic.h"
+1 -1
View File
@@ -30,7 +30,7 @@
#include <stdint.h> #include <stdint.h>
#include <string.h> #include <string.h>
#include <assert.h> #include <assert.h>
#include <debug.h> #include <nuttx/debug.h>
#include <arch/armv7-a/cp14.h> #include <arch/armv7-a/cp14.h>
/**************************************************************************** /****************************************************************************
+1 -1
View File
@@ -35,8 +35,8 @@
#include <stdint.h> #include <stdint.h>
#include <sys/param.h> #include <sys/param.h>
#include <assert.h> #include <assert.h>
#include <debug.h>
#include <nuttx/debug.h>
#include <nuttx/irq.h> #include <nuttx/irq.h>
#include <nuttx/spinlock.h> #include <nuttx/spinlock.h>
+1 -1
View File
@@ -29,8 +29,8 @@
#include <string.h> #include <string.h>
#include <assert.h> #include <assert.h>
#include <errno.h> #include <errno.h>
#include <debug.h>
#include <nuttx/debug.h>
#include <nuttx/irq.h> #include <nuttx/irq.h>
#include <nuttx/sched.h> #include <nuttx/sched.h>
#include <nuttx/arch.h> #include <nuttx/arch.h>
+1 -1
View File
@@ -26,7 +26,7 @@
#include <nuttx/config.h> #include <nuttx/config.h>
#include <debug.h> #include <nuttx/debug.h>
#include <nuttx/sched.h> #include <nuttx/sched.h>
#include <nuttx/page.h> #include <nuttx/page.h>
+1 -1
View File
@@ -28,7 +28,7 @@
#include <sys/types.h> #include <sys/types.h>
#include <assert.h> #include <assert.h>
#include <debug.h> #include <nuttx/debug.h>
#include <nuttx/arch.h> #include <nuttx/arch.h>
#include <nuttx/addrenv.h> #include <nuttx/addrenv.h>
+1 -1
View File
@@ -28,8 +28,8 @@
#include <stdint.h> #include <stdint.h>
#include <assert.h> #include <assert.h>
#include <debug.h>
#include <nuttx/debug.h>
#include <nuttx/irq.h> #include <nuttx/irq.h>
#ifdef CONFIG_LEGACY_PAGING #ifdef CONFIG_LEGACY_PAGING
# include <nuttx/page.h> # include <nuttx/page.h>
+1 -1
View File
@@ -29,8 +29,8 @@
#include <stdint.h> #include <stdint.h>
#include <sched.h> #include <sched.h>
#include <assert.h> #include <assert.h>
#include <debug.h>
#include <nuttx/debug.h>
#include <nuttx/irq.h> #include <nuttx/irq.h>
#include <nuttx/arch.h> #include <nuttx/arch.h>

Some files were not shown because too many files have changed in this diff Show More