Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.39%. Comparing base (77f08b7) to head (fa5994b).

@@           Coverage Diff           @@
##           master   #14076   +/-   ##
=======================================
  Coverage   98.39%   98.39%           
=======================================
  Files         161      161           
  Lines       21156    21156           
=======================================
  Hits        20816    20816           
  Misses        340      340           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Code size report:

   bare-arm:  +560 +0.989% 
minimal x86: +2853 +1.527% [incl +16(data)]
   unix x64:    +0 +0.000% standard
      stm32:    +0 +0.000% PYBV10
     mimxrt:    +0 +0.000% TEENSY40
        rp2:    +0 +0.000% RPI_PICO
       samd:    +0 +0.000% ADAFRUIT_ITSYBITSY_M4_EXPRESS

Can we consider adding -ggdb3 to include macro definitions ? Without those you have to calculate register addresses (some base + some other base + offset) manually and then cast just to get a register value.

Can we consider adding -ggdb3

You mean in the same way, e.g DEBUG=1 -> -g, DEBUG=2 -> -ggdb3 ?

Without those you have to calculate register addresses (some base + some other base + offset) manually

Does that also work with -g3? I'm not sure we want to hardcode gdb here.

How about an additional compile flags option, which csn be set at the make command line. Maybe it exists already. Seem you can use CFLAGS for that purpose, since all settings for CFLAGS in makefile are CFLAGS +=.

You mean in the same way, e.g DEBUG=1 -> -g, DEBUG=2 -> -ggdb3 ?

I'm not sure, maybe, but if you use O0 it's likely you also want macros.

Does that also work with -g3? I'm not sure we want to hardcode gdb here.

The manual says:
Level 3 includes extra information, such as all the macro definitions present in the program. Some debuggers support macro expansion when you use -g3.

How about an additional compile flags option, which csn be set at the make command line. Maybe it exists already. Seem you can use CFLAGS for that purpose, since all settings for CFLAGS in makefile are CFLAGS +=.

Since the docs say

If you use multiple -g options, with or without level numbers, the last such option is the one that is effective.

then that's probably not going to work since the ones passed on the commandline come first?

Can we just use COPT to override the optimization consistently across ports to allow any optimization rather than trying to make new options to try to cover all cases?

I'm already used to doing make DEBUG=1 COPT=-O0 for the unix port.

Just to be clear: is the idea behing COPT that it stands for `C optimization options'? Then yes implementing that consistently is probably the way to go.

And why is -g in CFLAGS not COPT? Does the build process use the debug information somewhere perhaps, because it seems silly to first add it then remove it again.

is the idea behing COPT that it stands for `C optimization options'?

Yes, that is the idea. Basically, just the -O flag.

And why is -g in CFLAGS not COPT?

Because it isn't the -O flag.

I think the simplest thing is to make more consistent use of COPT across the ports, allow it to be overridden on the command line, and document it.

And, I'm happy to change -g to -g3 in the relevant Makefile's. But I think -ggdb3 should be specified by the user on the command line if they need that.

I think the simplest thing is to make more consistent use of COPT across the ports, allow it to be overridden on the command line

Ok, changed that already.

and document it.

In gettingstarted.rst?

It's now only in unix/README.md but that also seems to be the only one which documents DEBUG=1 whereas most ports have that.

But I think -ggdb3 should be specified by the user on the command line if they need that.

Sounds reasonable but that should be via CFLAGS_EXTRA then I guess, which not all ports have now and the ones which do have it do not use it consistently as 'append to CFLAGS', making it impossible to override -g (e.g. unix Makefile does a CFLAGS += -g after the line where it appends CFLAGS_EXTRA to CFLAGS)