Some entries for macros missing in generated docs #2129

New issue

Open

opened 2024-12-06 22:25:56 -06:00 by magy00 · 4 comments

magy00 commented

2024-12-06 22:25:56 -06:00

(Migrated from github.com)

It looks like some macro entries like for __not_in_flash(group) or __not_in_flash_func(func_name) are missing in the online and PDF docs. Actually, their example entries are there but under __scratch_x(group) and __no_inline_not_in_flash_func(func_name) instead:

https://www.raspberrypi.com/documentation/pico-sdk/runtime.html#macros-3
https://www.raspberrypi.com/documentation/pico-sdk/runtime.html#group_pico_platform_1gad8b78e068558946081789ce1935528bf
https://www.raspberrypi.com/documentation/pico-sdk/runtime.html#group_pico_platform_1gad9ab05c9a8f0ab455a5e11773d610787

It looks like some macro entries like for `__not_in_flash(group)` or `__not_in_flash_func(func_name)` are missing in the online and PDF docs. Actually, their _example_ entries are there but under `__scratch_x(group)` and `__no_inline_not_in_flash_func(func_name)` instead: https://www.raspberrypi.com/documentation/pico-sdk/runtime.html#macros-3 https://www.raspberrypi.com/documentation/pico-sdk/runtime.html#group_pico_platform_1gad8b78e068558946081789ce1935528bf https://www.raspberrypi.com/documentation/pico-sdk/runtime.html#group_pico_platform_1gad9ab05c9a8f0ab455a5e11773d610787

magy00 commented

2024-12-07 02:36:08 -06:00

(Migrated from github.com)

It looks like the description of __uninitialized_ram(group) should have dash and/or closing parenthesis somehow changed and the description of parameter group extended that it would also specify the name of the variable itself.

It looks like the description of [`__uninitialized_ram(group)`](https://www.raspberrypi.com/documentation/pico-sdk/runtime.html#group_pico_platform_1ga118d39a4ebb425b8bef29e7a1f8731c2) should have dash and/or closing parenthesis somehow changed and the description of parameter `group` extended that it would also specify the name of the variable itself.

peternlewis commented

2026-03-10 18:36:31 -05:00

(Migrated from github.com)

I came here to report this as an issue. I'd try to figure out what the actual mistake is, but the doc generation is a complex system I can't really run myself.

My guess is that that unclosed { are the issue. and that the three lines like:

void __not_in_flash_func(my_func)(int some_arg) {

should be changed to

void __not_in_flash_func(my_func)(int some_arg);

I came here to report this as an issue. I'd try to figure out what the actual mistake is, but the doc generation is a complex system I can't really run myself. My guess is that that unclosed `{` are the issue. and that the three lines like: ``` void __not_in_flash_func(my_func)(int some_arg) { ``` should be changed to ``` void __not_in_flash_func(my_func)(int some_arg); ```

lurch commented

2026-03-10 19:17:22 -05:00

(Migrated from github.com)

but the doc generation is a complex system I can't really run myself.

Have a look at Appendix B of https://pip.raspberrypi.com/documents/RP-009085-KB if you haven't already seen it.

> but the doc generation is a complex system I can't really run myself. Have a look at Appendix B of https://pip.raspberrypi.com/documents/RP-009085-KB if you haven't already seen it.

peternlewis commented

2026-03-11 01:47:13 -05:00

(Migrated from github.com)

My point about the doc generation was simply that I am unable to generate the docs myself and thus try to figure out what in particular is causing the error in parsing, but my guess is it is the unmatched { as I could not see anything else in there that looked clearly different to other sections.

Yes, I refer to that document regularly, it is excellent, which is why I am reporting the minor error in the handling of that specific area. Indeed in the PDF linked, it has the same issue (see section 5.5.16.4.13) - it is a mishmash of `__not_in_flash_func`, `_no_inline_not_in_flash_func`, and `__time_critical_func`, all in the `5.5.16.4.13. __no_inline_not_in_flash_func` section because of the mis-parsing of the header file. My point about the doc generation was simply that I am unable to generate the docs myself and thus try to figure out what in particular is causing the error in parsing, but my guess is it is the unmatched `{` as I could not see anything else in there that looked clearly different to other sections.