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

[PiyushPatle26]

Note: Please adhere to Contributing Guidelines.

Summary

Move the NuttX-specific debug.h header from the top-level include/
directory to include/nuttx/debug.h, and update in-tree includes to use the new path.

debug.h is not a POSIX or standard C header. Keeping it at the top level
creates avoidable naming conflicts with external projects that also provide a
debug.h. Moving it under include/nuttx/ aligns it with NuttX conventions for non-standard headers.

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.

Impact

• Moves the header to include/nuttx/debug.h.
• Updates in-tree references to include <nuttx/debug.h>.
• Keeps backward compatibility for existing code that still includes <debug.h>.
• Emits a deprecation warning for the old include path to encourage migration.
• No intended functional change beyond header location and include path cleanup.

Other PR for nuttx_apps

Testing

Tested on Ubuntu Linux in the local NuttX tree.

Host:

• Ubuntu Linux

Target:

• native NuttX

Test application:

• ostest

I have also tested with sim:nsh configuration:

./tools/configure.sh sim:nsh
make -j$(nproc)
./nuttx
>nsh ostest

Test logs

No board runtime testing was performed because this change is a mechanical
header relocation and include-path update.

Fixes #8986

[xiaoxiang781216]

could you use script or AI to make nuttx/xxx.h in the same group, e.g.:

#include <stdint.h>
#include <assert.h>

#include <nuttx/debug.h> 
#include <nuttx/irq.h>

[PiyushPatle26]

Done!

[PiyushPatle26]

@xiaoxiang781216 I have done the change you asked for! Can you help me with the CI

[linguini1]

Please test by enabling the debug features in Kconfig.

[PiyushPatle26]

@linguini1 I ran as you asked, I received a bunch of warnings:

nuttx/include/debug.h:28:2: warning: #warning "include <debug.h> is deprecated, use <nuttx/debug.h> instead" [-Wcpp]
   28 | #warning "include <debug.h> is deprecated, use <nuttx/debug.h> instead"
      |  ^~~~~~~
CC:  sim/sim_copyfullstate.c In file included from configfat.c:32:

nuttx/include/debug.h:28:2: warning: #warning "include <debug.h> is deprecated, use <nuttx/debug.h> instead" [-Wcpp]
   28 | #warning "include <debug.h> is deprecated, use <nuttx/debug.h> instead"
      |  ^~~~~~~
CC:  sim/sim_cpuinfo.c In file included from mkfatfs.c:34:

nuttx/include/debug.h:28:2: warning: #warning "include <debug.h> is deprecated, use <nuttx/debug.h> instead" [-Wcpp]
   28 | #warning "include <debug.h> is deprecated, use <nuttx/debug.h> instead"
      |  ^~~~~~~
CC:  sched/sched_get_tls.c In file included from writefat.c:34:

nuttx/include/debug.h:28:2: warning: #warning "include <debug.h> is deprecated, use <nuttx/debug.h> instead" [-Wcpp]
   28 | #warning "include <debug.h> is deprecated, use <nuttx/debug.h> instead"
      |  ^~~~~~~
In file included from nsh_console.c:39:

Now , I have removed the unconditional deprecation #warning from include/debug.h
This should fix the CI

[linguini1]

Doesn't the warning indicate that you haven't migrated all places to use the new header location?

[PiyushPatle26]

Doesn't the warning indicate that you haven't migrated all places to use the new header location?

No

[PiyushPatle26]

Doesn't the warning indicate that you haven't migrated all places to use the new header location?

@linguini1 I think the warning is from checkpatch on the modified files, not from a scan of remaining #include <debug.h> usages.

[linguini1]

Doesn't the warning indicate that you haven't migrated all places to use the new header location?

@linguini1 I think the warning is from checkpatch on the modified files, not from a scan of remaining #include <debug.h> usages.

No, the warnings you pasted in your last comment are from compilation.

If I understand correctly, this warning is inside the legacy debug.h header you kept for backwards compatibility? So if it's appearing, it means that header is still getting included somewhere.

One inclusion is in nsh_console.c. Maybe you can open a twin PR to nuttx-apps to replace the includes there too

[PiyushPatle26]

@linguini1 I’ve already submitted the PR for nuttx_apps. Regarding the warnings, you’re right.

My understanding is that the CI is failing because it checks against the current master of nuttx_apps, which doesn’t yet include the corresponding changes.

[linguini1]

@linguini1 I’ve already submitted the PR for nuttx_apps. Regarding the warnings, you’re right.

My bad, didn't realize! Could you please link to it in the description of this PR?

My understanding is that the CI is failing because it checks against the current master of nuttx_apps, which doesn’t yet include the corresponding changes.

Hmmm, usually warnings do not cause CI to fail, but I'm on mobile right now so I can't check to give a reason.

[PiyushPatle26]

@linguini1 I have updated the description