Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doccheck: avoid generating dot or html #19228

Merged
merged 2 commits into from
Feb 1, 2023
Merged

Conversation

kfessel
Copy link
Contributor

@kfessel kfessel commented Jan 31, 2023

Contribution description

doccheck without generating dot or html

this also has some new generated lines for exclude_pattern (some of them where broke so I regenerated the block)

Testing procedure

doccheck

Issues/PRs references

@github-actions github-actions bot added Area: doc Area: Documentation Area: tools Area: Supplementary tools labels Jan 31, 2023
@kfessel kfessel force-pushed the p-doccheck-fast branch 2 times, most recently from 54fe8ef to cc2afda Compare January 31, 2023 18:26
@kfessel kfessel added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Jan 31, 2023
@kaspar030
Copy link
Contributor

this also has some new generated lines for exclude_pattern (some of them where broke so I regenerated the block)

that takes the option of just comparing the warnings master / PR. also the doccheck commit also modifies exclude_patterns, so revert of the fixed patterns won't work.

After git co master -- dist/tools/doccheck/exclude_patterns, I do get less warnings with this PR compared to master. Is that expected?

@kaspar030
Copy link
Contributor

otherwise, works as expected. and less warnings might be better. :)

@riot-ci
Copy link

riot-ci commented Jan 31, 2023

Murdock results

✔️ PASSED

3de68c7 doccheck: check without building

Success Failures Total Runtime
1 0 1 59s

Artifacts

@kaspar030
Copy link
Contributor

bors merge

bors bot added a commit that referenced this pull request Jan 31, 2023
19228: doccheck: avoid generating dot or html r=kaspar030 a=kfessel

### Contribution description

doccheck without generating dot or html

this also has some new generated lines for exclude_pattern (some of them where broke so I regenerated the block)

### Testing procedure

doccheck 

### Issues/PRs references



Co-authored-by: Karl Fessel <karl.fessel@ovgu.de>
@bors
Copy link
Contributor

bors bot commented Jan 31, 2023

Build failed:

@benpicco
Copy link
Contributor

benpicco commented Feb 1, 2023

bors merge

@kfessel
Copy link
Contributor Author

kfessel commented Feb 1, 2023

this also has some new generated lines for exclude_pattern (some of them where broke so I regenerated the block)

that takes the option of just comparing the warnings master / PR. also the doccheck commit also modifies exclude_patterns, so revert of the fixed patterns won't work.

the patterns modified with the first commit where broken (opened groups without closing, used lists where they should not be used in exclude patterns and had unescaped .)

the pattern added by the second commit is necessary for the check build target for that reason it is in the same commit.

warning: No output formats selected! Set at least one of the main GENERATE_* options to YES.

After git co master -- dist/tools/doccheck/exclude_patterns, I do get less warnings with this PR compared to master. Is that expected?

i will have an other look at these (maybe some warning-errors are only happening when html and dot are build)

these are types of warnings that might be missed with the check build:

error: md5 hash does not match for two different runs of RIOT/doc/doxygen/html/3_2include_2arduino__board__common_8h__incl.dot !
 warning: found documented return type for *** that does not return anything
 warning: explicit link request to *** could not be resolved
 warning: unable to resolve reference to *** for \ref command

de compact diff:

--- html.log	2023-02-01 13:15:18.910006761 +0100
+++ check.log	2023-02-01 13:14:07.445041559 +0100
+warning: No output formats selected! Set at least one of the main GENERATE_* options to YES.
-error: md5 hash does not match for two different runs of RIOT/doc/doxygen/html/3_2include_2arduino__board__common_8h__incl.dot !
-RIOT/core/lib/include/panic.h:61: warning: found documented return type for core_panic that does not return anything
-[generated]:20: warning: explicit link request to 'esp32_application_specific_configurations' could not be resolved
-[generated]:16: warning: explicit link request to 'esp32_application_specific_configurations' could not be resolved
-[generated]:32: warning: explicit link request to 'esp32_application_specific_configurations' could not be resolved
-RIOT/sys/posix/pthread/include/pthread_threading.h:52: warning: found documented return type for pthread_exit that does not return anything
-RIOT/sys/include/bloom.h:180: warning: found documented return type for bloom_add that does not return anything
-RIOT/sys/include/bloom.h:171: warning: found documented return type for bloom_del that does not return anything
-RIOT/drivers/include/cc2420.h:160: warning: found documented return type for cc2420_get_addr_long that does not return anything
-RIOT/drivers/include/cc2420.h:102: warning: found documented return type for cc2420_setup that does not return anything
-RIOT/cpu/cc26xx_cc13xx/doc.txt:27: warning: unable to resolve reference to 'cc26xx_cc13xx_ccfg' for \ref command
-RIOT/cpu/cc26xx_cc13xx/doc.txt:113: warning: unable to resolve reference to 'cc26xx_cc13xx_uniflash' for \ref command
-RIOT/drivers/include/motor_driver.h:227: warning: found documented return type for motor_disable that does not return anything
-RIOT/drivers/include/motor_driver.h:217: warning: found documented return type for motor_enable that does not return anything
-RIOT/boards/esp32-wrover-kit/doc.txt:302: warning: explicit link request to 'esp32_local_toolchain_installation' could not be resolved
-RIOT/cpu/esp32/doc.txt:163: warning: unable to resolve reference to 'esp32_esp_qemu' for \ref command
-RIOT/cpu/esp32/doc.txt:776: warning: explicit link request to 'esp32_application_specific_configurations' could not be resolved
-RIOT/cpu/esp32/doc.txt:848: warning: explicit link request to 'esp32_application_specific_configurations' could not be resolved
-RIOT/cpu/esp32/doc.txt:971: warning: explicit link request to 'esp32_application_specific_configurations' could not be resolved
-RIOT/cpu/esp32/doc.txt:1735: warning: explicit link request to 'esp32_application_specific_board_configuration' could not be resolved
-RIOT/cpu/esp32/doc_esp32.txt:216: warning: explicit link request to 'esp32_application_specific_configurations' could not be resolved
-RIOT/cpu/esp32/doc_esp32c3.txt:159: warning: explicit link request to 'esp32_application_specific_configurations' could not be resolved
-RIOT/boards/esp32c3-devkit/doc.txt:49: warning: unable to resolve reference to 'esp32c3_devkit_optional_hardware' for \ref command
-RIOT/boards/esp32-ethernet-kit-v1_0/doc_common.txt:129: warning: explicit link request to 'esp32_local_toolchain_installation' could not be resolved
-RIOT/boards/esp32-ethernet-kit-v1_1/doc.txt:21: warning: unable to resolve reference to 'esp32_ethernet_kit_v1_1_overview' for \ref command
-RIOT/boards/esp32-ethernet-kit-v1_1/doc.txt:22: warning: unable to resolve reference to 'esp32_ethernet_kit_v1_1_hardware' for \ref command
-RIOT/boards/esp32-ethernet-kit-v1_1/doc.txt:23: warning: unable to resolve reference to 'esp32_ethernet_kit_v1_1_board_configuration' for \ref command
-RIOT/boards/esp32-ethernet-kit-v1_1/doc.txt:24: warning: unable to resolve reference to 'esp32_ethernet_kit_v1_1_pinout' for \ref command
-RIOT/boards/esp32-ethernet-kit-v1_1/doc.txt:25: warning: unable to resolve reference to 'esp32_ethernet_kit_v1_1_other-resources' for \ref command
-RIOT/boards/esp32-ethernet-kit-v1_1/doc.txt:39: warning: unable to resolve reference to 'esp32_ethernet_kit_v1_1_toc' for \ref command
-RIOT/boards/esp32-ethernet-kit-v1_1/doc.txt:45: warning: unable to resolve reference to 'esp32_ethernet_kit_v1_1_board_configuration' for \ref command
-RIOT/boards/esp32-ethernet-kit-v1_1/doc.txt:46: warning: unable to resolve reference to 'esp32_ethernet_kit_v1_1_pinout' for \ref command
-RIOT/boards/esp32-ethernet-kit-v1_1/doc.txt:48: warning: unable to resolve reference to 'esp32_ethernet_kit_v1_1_toc' for \ref command
-RIOT/boards/esp32-ethernet-kit-v1_1/doc.txt:83: warning: unable to resolve reference to 'esp32_ethernet_kit_v1_1_toc' for \ref command
-RIOT/boards/esp32-ethernet-kit-v1_1/doc.txt:93: warning: unable to resolve reference to 'esp32_ethernet_kit_v1_1_toc' for \ref command
-RIOT/boards/esp32-ethernet-kit-v1_1/doc.txt:99: warning: unable to resolve reference to 'esp32_ethernet_kit_v1_1_toc' for \ref command
-RIOT/cpu/esp32/doc_esp32s2.txt:257: warning: explicit link request to 'esp32_application_specific_configurations' could not be resolved
-RIOT/boards/esp32s2-devkit/doc.txt:89: warning: unable to resolve reference to 'esp32s2_devkit_optional_hardware' for \ref command
-RIOT/cpu/esp32/doc_esp32s3.txt:267: warning: explicit link request to 'esp32_application_specific_configurations' could not be resolved
-RIOT/boards/esp32s3-devkit/doc.txt:95: warning: unable to resolve reference to 'esp32s3_devkit_optional_hardware' for \ref command
-RIOT/boards/esp32-heltec-lora32-v2/doc.txt:26: warning: explicit link request to 'esp32_heltec_lora32_v2_optional_hardware' could not be resolved
-RIOT/cpu/kinetis/include/mcg.h:22: warning: unable to resolve reference to 'clock_config_t' for \ref command
-RIOT/cpu/kinetis/include/mcg.h:145: warning: unable to resolve reference to 'clock_config_t::clkdiv1' for \ref command
-RIOT/cpu/kinetis/include/mcg.h:138: warning: unable to resolve reference to 'clock_config_t::clkdiv1' for \ref command
-RIOT/drivers/include/l3gxxxx.h:34: warning: explicit link request to 'l3gxxxx_data_interrupt' could not be resolved
-RIOT/drivers/include/l3gxxxx.h:36: warning: explicit link request to 'l3gxxxx_event_interrupt' could not be resolved
-RIOT/drivers/include/l3gxxxx.h:1184: warning: explicit link request to 'l3gxxxx_odr_filters' could not be resolved
-RIOT/drivers/include/mcp47xx.h:295: warning: found documented return type for mcp47xx_dac_get that does not return anything
-RIOT/drivers/include/mcp47xx.h:320: warning: found documented return type for mcp47xx_dac_poweroff that does not return anything
-RIOT/drivers/include/mcp47xx.h:309: warning: found documented return type for mcp47xx_dac_poweron that does not return anything
-RIOT/drivers/include/mcp47xx.h:279: warning: found documented return type for mcp47xx_dac_set that does not return anything
-RIOT/boards/esp32-mh-et-live-minikit/doc.txt:25: warning: explicit link request to 'esp32_mh_et_live_minikit_optional_hardware' could not be resolved
-RIOT/drivers/include/sx127x.h:340: warning: found documented return type for sx127x_set_state that does not return anything
-RIOT/sys/include/senml.h:454: warning: found documented return type for senml_set_duration_ms that does not return anything
-RIOT/sys/include/senml.h:477: warning: found documented return type for senml_set_duration_us that does not return anything
-RIOT/boards/esp32-ttgo-t-beam/doc.txt:24: warning: unable to resolve reference to 'esp32_ttgo_t_beam_optional_hardware' for \ref command
-RIOT/boards/esp32-ttgo-t-beam/doc.txt:52: warning: unable to resolve reference to 'esp32_ttgo_t_beam_optional_hardware' for \ref command
-RIOT/boards/esp32-wemos-lolin-d32-pro/doc.txt:25: warning: explicit link request to 'esp32_wemos_lolin_d32_pro_optional_hardware' could not be resolved
-RIOT/drivers/include/xbee.h:179: warning: found documented return type for xbee_setup that does not return anything
-RIOT/boards/nrf52840dongle/doc.txt:10: warning: unable to resolve reference to 'nrf52840dongle_flash' for \ref command


de diff:

--- html.log	2023-02-01 13:15:18.910006761 +0100
+++ check.log	2023-02-01 13:14:07.445041559 +0100
@@ -6,2 +6,3 @@
          To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
+warning: No output formats selected! Set at least one of the main GENERATE_* options to YES.
 warning: source 'RIOT/build/pkg/ccn-lite/doc/internal/README.md' is not a readable file or directory... skipping.
@@ -27,3 +28,2 @@
 RIOT/boards/common/cc2538/include/cfg_clk_default.h:74: warning: Member CLOCK_IO (macro definition) of file cfg_clk_default.h is not documented.
-error: md5 hash does not match for two different runs of RIOT/doc/doxygen/html/3_2include_2arduino__board__common_8h__incl.dot !
 RIOT/boards/common/cc2538/include/cfg_timer_default.h:58: warning: Member TIMER_NUMOF (macro definition) of file cfg_timer_default.h is not documented.
@@ -3861,3 +3861,2 @@
 RIOT/pkg/mynewt-core/include/log/log.h:35: warning: Member log_register(__X, __Y, __Z, __A, __B) (macro definition) of file log.h is not documented.
-RIOT/core/lib/include/panic.h:61: warning: found documented return type for core_panic that does not return anything
 RIOT/cpu/arm7_common/include/arm7_common.h:37: warning: Member PCTIM0 (macro definition) of group cpu_arm7_common is not documented.
@@ -8296,5 +8295,2 @@
 RIOT/cpu/esp32/include/periph_cpu.h:82: warning: Member gpio_t (typedef) of file periph_cpu.h is not documented.
-[generated]:20: warning: explicit link request to 'esp32_application_specific_configurations' could not be resolved
-[generated]:16: warning: explicit link request to 'esp32_application_specific_configurations' could not be resolved
-[generated]:32: warning: explicit link request to 'esp32_application_specific_configurations' could not be resolved
 RIOT/cpu/esp32/include/periph_cpu.h:759: warning: Member TIMER_CHANNEL_NUMOF (macro definition) of file periph_cpu.h is not documented.
@@ -14306,3 +14302,2 @@
 RIOT/sys/posix/pthread/include/pthread_mutex_attr.h:184: warning: Member pthread_mutexattr_setprioceiling(pthread_mutexattr_t *attr, int prioceiling) (function) of file pthread_mutex_attr.h is not documented.
-RIOT/sys/posix/pthread/include/pthread_threading.h:52: warning: found documented return type for pthread_exit that does not return anything
 RIOT/sys/include/net/sixlowpan/nd.h:40: warning: Member SIXLOWPAN_ND_OPT_6CTX_LEN_MIN (macro definition) of group net_sixlowpan_nd is not documented.
@@ -14501,4 +14496,2 @@
 RIOT/boards/bastwan/include/board.h:67: warning: Member LED0_TOGGLE (macro definition) of group boards_bastwan is not documented.
-RIOT/sys/include/bloom.h:180: warning: found documented return type for bloom_add that does not return anything
-RIOT/sys/include/bloom.h:171: warning: found documented return type for bloom_del that does not return anything
 RIOT/drivers/include/cc2420.h:45: warning: Member CC2420_CHAN_MIN (macro definition) of group drivers_cc2420 is not documented.
@@ -14509,4 +14502,2 @@
 RIOT/drivers/include/cc2420.h:56: warning: Member CC2420_TXPOWER_DEFAULT (macro definition) of group drivers_cc2420 is not documented.
-RIOT/drivers/include/cc2420.h:160: warning: found documented return type for cc2420_get_addr_long that does not return anything
-RIOT/drivers/include/cc2420.h:102: warning: found documented return type for cc2420_setup that does not return anything
 RIOT/cpu/cc2538/include/cc2538_gpio.h:250: warning: Member cc2538_ioc_sel_t (enumeration) of group cpu_cc2538_gpio is not documented.
@@ -14572,4 +14563,2 @@
 RIOT/cpu/cc26xx_cc13xx/include/cc26xx_cc13xx_uart.h:120: warning: Member UART_IFLS_RXSEL_7_8 (macro definition) of group cpu_cc26xx_cc13xx_definitions is not documented.
-RIOT/cpu/cc26xx_cc13xx/doc.txt:27: warning: unable to resolve reference to 'cc26xx_cc13xx_ccfg' for \ref command
-RIOT/cpu/cc26xx_cc13xx/doc.txt:113: warning: unable to resolve reference to 'cc26xx_cc13xx_uniflash' for \ref command
 RIOT/cpu/cc26xx_cc13xx/include/cpu_conf_cc26xx_cc13xx.h:51: warning: Member CPU_IRQ_NUMOF (macro definition) of group cpu_cc26xx_cc13xx is not documented.
@@ -14673,4 +14662,2 @@
 RIOT/boards/common/arduino-zero/include/board.h:52: warning: Member LED0_TOGGLE (macro definition) of group boards_common_arduino_zero is not documented.
-RIOT/drivers/include/motor_driver.h:227: warning: found documented return type for motor_disable that does not return anything
-RIOT/drivers/include/motor_driver.h:217: warning: found documented return type for motor_enable that does not return anything
 RIOT/sys/include/usb/dfu.h:42: warning: Member USB_DFU_DETACH_TIMEOUT_MS (macro definition) of group usb_dfu is not documented.
@@ -14692,28 +14679,2 @@
 RIOT/drivers/include/dose.h:118: warning: Member dose_signal_t (enumeration) of group drivers_dose is not documented.
-RIOT/boards/esp32-wrover-kit/doc.txt:302: warning: explicit link request to 'esp32_local_toolchain_installation' could not be resolved
-RIOT/cpu/esp32/doc.txt:163: warning: unable to resolve reference to 'esp32_esp_qemu' for \ref command
-RIOT/cpu/esp32/doc.txt:776: warning: explicit link request to 'esp32_application_specific_configurations' could not be resolved
-RIOT/cpu/esp32/doc.txt:848: warning: explicit link request to 'esp32_application_specific_configurations' could not be resolved
-RIOT/cpu/esp32/doc.txt:971: warning: explicit link request to 'esp32_application_specific_configurations' could not be resolved
-RIOT/cpu/esp32/doc.txt:1735: warning: explicit link request to 'esp32_application_specific_board_configuration' could not be resolved
-RIOT/cpu/esp32/doc_esp32.txt:216: warning: explicit link request to 'esp32_application_specific_configurations' could not be resolved
-RIOT/cpu/esp32/doc_esp32c3.txt:159: warning: explicit link request to 'esp32_application_specific_configurations' could not be resolved
-RIOT/boards/esp32c3-devkit/doc.txt:49: warning: unable to resolve reference to 'esp32c3_devkit_optional_hardware' for \ref command
-RIOT/boards/esp32-ethernet-kit-v1_0/doc_common.txt:129: warning: explicit link request to 'esp32_local_toolchain_installation' could not be resolved
-RIOT/boards/esp32-ethernet-kit-v1_1/doc.txt:21: warning: unable to resolve reference to 'esp32_ethernet_kit_v1_1_overview' for \ref command
-RIOT/boards/esp32-ethernet-kit-v1_1/doc.txt:22: warning: unable to resolve reference to 'esp32_ethernet_kit_v1_1_hardware' for \ref command
-RIOT/boards/esp32-ethernet-kit-v1_1/doc.txt:23: warning: unable to resolve reference to 'esp32_ethernet_kit_v1_1_board_configuration' for \ref command
-RIOT/boards/esp32-ethernet-kit-v1_1/doc.txt:24: warning: unable to resolve reference to 'esp32_ethernet_kit_v1_1_pinout' for \ref command
-RIOT/boards/esp32-ethernet-kit-v1_1/doc.txt:25: warning: unable to resolve reference to 'esp32_ethernet_kit_v1_1_other-resources' for \ref command
-RIOT/boards/esp32-ethernet-kit-v1_1/doc.txt:39: warning: unable to resolve reference to 'esp32_ethernet_kit_v1_1_toc' for \ref command
-RIOT/boards/esp32-ethernet-kit-v1_1/doc.txt:45: warning: unable to resolve reference to 'esp32_ethernet_kit_v1_1_board_configuration' for \ref command
-RIOT/boards/esp32-ethernet-kit-v1_1/doc.txt:46: warning: unable to resolve reference to 'esp32_ethernet_kit_v1_1_pinout' for \ref command
-RIOT/boards/esp32-ethernet-kit-v1_1/doc.txt:48: warning: unable to resolve reference to 'esp32_ethernet_kit_v1_1_toc' for \ref command
-RIOT/boards/esp32-ethernet-kit-v1_1/doc.txt:83: warning: unable to resolve reference to 'esp32_ethernet_kit_v1_1_toc' for \ref command
-RIOT/boards/esp32-ethernet-kit-v1_1/doc.txt:93: warning: unable to resolve reference to 'esp32_ethernet_kit_v1_1_toc' for \ref command
-RIOT/boards/esp32-ethernet-kit-v1_1/doc.txt:99: warning: unable to resolve reference to 'esp32_ethernet_kit_v1_1_toc' for \ref command
-RIOT/cpu/esp32/doc_esp32s2.txt:257: warning: explicit link request to 'esp32_application_specific_configurations' could not be resolved
-RIOT/boards/esp32s2-devkit/doc.txt:89: warning: unable to resolve reference to 'esp32s2_devkit_optional_hardware' for \ref command
-RIOT/cpu/esp32/doc_esp32s3.txt:267: warning: explicit link request to 'esp32_application_specific_configurations' could not be resolved
-RIOT/boards/esp32s3-devkit/doc.txt:95: warning: unable to resolve reference to 'esp32s3_devkit_optional_hardware' for \ref command
 RIOT/cpu/esp8266/include/cpu_conf.h:66: warning: Member THREAD_EXTRA_STACKSIZE_PRINTF (macro definition) of group cpu_esp8266_conf is not documented.
@@ -14966,3 +14927,2 @@
 RIOT/sys/include/usb/hid.h:83: warning: Member USB_HID_REQUEST_SET_PROTOCOL (macro definition) of group usb_hid is not documented.
-RIOT/boards/esp32-heltec-lora32-v2/doc.txt:26: warning: explicit link request to 'esp32_heltec_lora32_v2_optional_hardware' could not be resolved
 RIOT/sys/include/net/iana/portrange.h:34: warning: Member IANA_SYSTEM_PORTRANGE_MIN (macro definition) of group net_iana_portrange is not documented.
@@ -15023,8 +14983,2 @@
 RIOT/drivers/include/kw41zrf.h:74: warning: Member KW41ZRF_MAX_CHANNEL (macro definition) of group drivers_kw41zrf is not documented.
-RIOT/cpu/kinetis/include/mcg.h:22: warning: unable to resolve reference to 'clock_config_t' for \ref command
-RIOT/cpu/kinetis/include/mcg.h:145: warning: unable to resolve reference to 'clock_config_t::clkdiv1' for \ref command
-RIOT/cpu/kinetis/include/mcg.h:138: warning: unable to resolve reference to 'clock_config_t::clkdiv1' for \ref command
-RIOT/drivers/include/l3gxxxx.h:34: warning: explicit link request to 'l3gxxxx_data_interrupt' could not be resolved
-RIOT/drivers/include/l3gxxxx.h:36: warning: explicit link request to 'l3gxxxx_event_interrupt' could not be resolved
-RIOT/drivers/include/l3gxxxx.h:1184: warning: explicit link request to 'l3gxxxx_odr_filters' could not be resolved
 RIOT/drivers/include/lis2dh12.h:251: warning: Member lis2dh12_saul_temp_driver (variable) of group drivers_lis2dh12 is not documented.
@@ -15121,7 +15075,2 @@
 RIOT/drivers/include/candev_mcp2515.h:82: warning: Member MCP2515_FILTERS (macro definition) of group drivers_mcp2515 is not documented.
-RIOT/drivers/include/mcp47xx.h:295: warning: found documented return type for mcp47xx_dac_get that does not return anything
-RIOT/drivers/include/mcp47xx.h:320: warning: found documented return type for mcp47xx_dac_poweroff that does not return anything
-RIOT/drivers/include/mcp47xx.h:309: warning: found documented return type for mcp47xx_dac_poweron that does not return anything
-RIOT/drivers/include/mcp47xx.h:279: warning: found documented return type for mcp47xx_dac_set that does not return anything
-RIOT/boards/esp32-mh-et-live-minikit/doc.txt:25: warning: explicit link request to 'esp32_mh_et_live_minikit_optional_hardware' could not be resolved
 RIOT/drivers/include/mma7660.h:79: warning: Member MODE_ACTIVE_SHIFT (macro definition) of group drivers_mma7660 is not documented.
@@ -15373,5 +15322,2 @@
 RIOT/drivers/include/sx127x.h:173: warning: Member SX127X_RX_CONTINUOUS_FLAG (macro definition) of group drivers_sx127x is not documented.
-RIOT/drivers/include/sx127x.h:340: warning: found documented return type for sx127x_set_state that does not return anything
-RIOT/sys/include/senml.h:454: warning: found documented return type for senml_set_duration_ms that does not return anything
-RIOT/sys/include/senml.h:477: warning: found documented return type for senml_set_duration_us that does not return anything
 RIOT/boards/hifive1/include/board.h:34: warning: Member XTIMER_HZ (macro definition) of group boards_hifive1 is not documented.
@@ -15433,4 +15379,2 @@
 RIOT/drivers/include/tsl4531x.h:78: warning: Member TSL45317_ADDR (macro definition) of group drivers_tsl4531x is not documented.
-RIOT/boards/esp32-ttgo-t-beam/doc.txt:24: warning: unable to resolve reference to 'esp32_ttgo_t_beam_optional_hardware' for \ref command
-RIOT/boards/esp32-ttgo-t-beam/doc.txt:52: warning: unable to resolve reference to 'esp32_ttgo_t_beam_optional_hardware' for \ref command
 RIOT/drivers/include/usbdev_mock.h:35: warning: Member usbdev_mock_ep_state_t (enumeration) of group drivers_usbdev_mock is not documented.
@@ -15460,4 +15404,2 @@
 RIOT/sys/include/vfs.h:173: warning: Member SPIFFS_VFS_FILE_BUFFER_SIZE (macro definition) of group sys_vfs is not documented.
-RIOT/boards/esp32-wemos-lolin-d32-pro/doc.txt:25: warning: explicit link request to 'esp32_wemos_lolin_d32_pro_optional_hardware' could not be resolved
-RIOT/drivers/include/xbee.h:179: warning: found documented return type for xbee_setup that does not return anything
 RIOT/boards/common/remote/include/board_common.h:39: warning: Member LED_ALL_OFF (macro definition) of group boards_common_remote is not documented.
@@ -15504,3 +15446,2 @@
 RIOT/pkg/lwip/include/lwipopts.h:179: warning: Member LWIP_ASSERT_CORE_LOCKED() (macro definition) of group pkg_lwip_opts is not documented.
-RIOT/boards/nrf52840dongle/doc.txt:10: warning: unable to resolve reference to 'nrf52840dongle_flash' for \ref command
 RIOT/sys/include/utlist.h:105: warning: Member LDECLTYPE(x) (macro definition) of group sys_ut is not documented.

@kfessel
Copy link
Contributor Author

kfessel commented Feb 1, 2023

these are types of warnings that might be missed with the check build:

error: md5 hash does not match for two different runs of \
RIOT/doc/doxygen/html/3_2include_2arduino__board__common_8h__incl.dot !

doxygen/doxygen#8071 and/or doxygen/doxygen#7706 seem related

 warning: found documented return type for *** that does not return anything
 warning: explicit link request to *** could not be resolved
 warning: unable to resolve reference to *** for \ref command

We can make these 3 types of warnings still show up if we generate html but disable dot. GENERATE_HTML=YES and HAVE_DOT=NO would be slightly slower than no output at all but we would get some extra warnings for /dot commands that are used in in our documentation.

@bors
Copy link
Contributor

bors bot commented Feb 1, 2023

Build succeeded:

@bors bors bot merged commit 053f526 into RIOT-OS:master Feb 1, 2023
bors bot added a commit that referenced this pull request Feb 7, 2023
19240: tools/doccheck: add simple exclude to doccheck r=benpicco a=kfessel

while doccheck runs for #19228 and #19220, i saw some spikes in memory consumption, turned out that was `grep -Evf dist/tools/doccheck/exclude_patterns` using about 2GB RAM. This PR changes that.

### Contribution description

add `exclude_simple`  to `doccheck` drived from `exclude patterns`
`sort`ed and `uniq`ued the simple excludes
removes no longer needed patterns from `exclude patterns`

simple excludes are string rules (no patterns just strings) 
how to apply these:
in this PR: 
*remove the path and line number from the rule
* that made some of them doubles of each other
* sorted and uniqued them. 
* this set of excludes is no longer path specific (an exception covers all paths but may of them still contain a file name)

another possible solution would be to have the excludes line number specific.

### Testing procedure

run `dist/tools/doccheck/check.sh`

compare memory consumption of 
master: `grep -Evf dist/tools/doccheck/exclude_patterns`
to 
this PR: `grep -Fvf dist/tools/doccheck/exclude_simple`

### Issues/PRs references



19248: cpu/gd32v: add periph_dac support r=benpicco a=gschorcht

### Contribution description

This PR provides the `periph_dac` support for GD32VF103.

### Testing procedure

`tests/periph_dac` should work on `sipeed-longan-nano` port on PA4 and PA5.

### Issues/PRs references

19255: boards/esp*: complete SD Card MTD config r=benpicco a=gschorcht

### Contribution description

This PR provides the remaining changes necessary to use the generic MTD SD Card configuration as described in PR #19216. 

This includes defining the MTD offset for SD cards, since the default `MTD_0` device always uses the internal flash device, and the completion of the configuration for the ESP32 boards with a SD card interface.

### Testing procedure

`tests/vfs_default` should work now with SD Cards:
```
main(): This is RIOT! (Version: 2023.04-devel-323-gfcc07)
mount points:
	/nvm0
	/sd0

data dir: /sd0
> vfs df 
Mountpoint              Total         Used    Available     Use%
/nvm0                3052 KiB        8 KiB     3044 KiB       0%
/sd0                 7580 MiB 3632148992 B   21089792 B      99%
```

### Issues/PRs references


Co-authored-by: Karl Fessel <karl.fessel@ovgu.de>
Co-authored-by: Gunar Schorcht <gunar@schorcht.net>
@MrKevinWeiss MrKevinWeiss added this to the Release 2023.04 milestone Apr 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: doc Area: Documentation Area: tools Area: Supplementary tools CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants