OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/doc/known-warnings.txt

25 lines
1.1 KiB
Plaintext
Raw Normal View History

doc: use warnings_filter Replace current filter setup with the warnings_filter Sphinx extension. Note that current regexes have been simplified to make them more readable while keeping the most relevant information. Sphinx warnings are now treated as errors (-W). Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-04-06 06:02:03 +08:00
# Each line should contain the regular expression of a known Sphinx warning
# that should be filtered out
doc: Log unused log filter patterns This allows us to identify any patterns that we can remove or that we didn't realise are no longer in use. This might happen if issues within doxygen or docleaf are resolved. This allows us to remove the pattern: .*Duplicate C declaration.*\n.*'\.\. c:.*:: uint16_t id'.* which does not match anything in the current set up. We also split the filter patterns in known-warnings out into different sections depending on their cause. Also extend the pattern parser to ignore empty lines so that we can have some formatting in the known-warnings file. Signed-off-by: Michael Jones <m.pricejones@gmail.com>
2023-07-02 04:16:50 +08:00
# Function and (enum or struct) name
doc: services: storage: add flash_img API Doxygen comments were existing, but they were not rendered anywhere in the docs. The code is located under DFU, but I think it makes sense to document it under storage, next to similar flash-related APIs. Signed-off-by: Martin Jäger <martin@libre.solar>
2022-05-11 00:28:21 +08:00
.*Duplicate C declaration.*\n.*'\.\. c:.*:: flash_img_check'.*
doc: warnings: make expressions more generic When duplicates exist the problem may come from two or more distinct constructs. When running parallel builds there is no guarantee on which one will come first (or if all), so allow any C construct. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-05-17 16:33:03 +08:00
.*Duplicate C declaration.*\n.*'\.\. c:.*:: fs_statvfs'.*
.*Duplicate C declaration.*\n.*'\.\. c:.*:: .*dmic_trigger.*'.*
doc: Log unused log filter patterns This allows us to identify any patterns that we can remove or that we didn't realise are no longer in use. This might happen if issues within doxygen or docleaf are resolved. This allows us to remove the pattern: .*Duplicate C declaration.*\n.*'\.\. c:.*:: uint16_t id'.* which does not match anything in the current set up. We also split the filter patterns in known-warnings out into different sections depending on their cause. Also extend the pattern parser to ignore empty lines so that we can have some formatting in the known-warnings file. Signed-off-by: Michael Jones <m.pricejones@gmail.com>
2023-07-02 04:16:50 +08:00
.*Duplicate C declaration.*\n.*'\.\. c:.*:: dma_config'.*
.*Duplicate C declaration.*\n.*'\.\. c:.*:: net_if_mcast_monitor'.*
# Struct and typedef name
.*Duplicate C declaration.*\n.*'\.\. c:.*:: zsock_fd_set'.*
# Function and extern function
doc: warnings: make expressions more generic When duplicates exist the problem may come from two or more distinct constructs. When running parallel builds there is no guarantee on which one will come first (or if all), so allow any C construct. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-05-17 16:33:03 +08:00
.*Duplicate C declaration.*\n.*'\.\. c:.*:: .*net_if_ipv4_addr_mask_cmp.*'.*
.*Duplicate C declaration.*\n.*'\.\. c:.*:: .*net_if_ipv4_is_addr_bcast.*'.*
.*Duplicate C declaration.*\n.*'\.\. c:.*:: .*net_if_ipv4_addr_lookup.*'.*
.*Duplicate C declaration.*\n.*'\.\. c:.*:: .*net_if_ipv6_addr_lookup.*'.*
.*Duplicate C declaration.*\n.*'\.\. c:.*:: .*net_if_ipv6_maddr_lookup.*'.*
doc: Log unused log filter patterns This allows us to identify any patterns that we can remove or that we didn't realise are no longer in use. This might happen if issues within doxygen or docleaf are resolved. This allows us to remove the pattern: .*Duplicate C declaration.*\n.*'\.\. c:.*:: uint16_t id'.* which does not match anything in the current set up. We also split the filter patterns in known-warnings out into different sections depending on their cause. Also extend the pattern parser to ignore empty lines so that we can have some formatting in the known-warnings file. Signed-off-by: Michael Jones <m.pricejones@gmail.com>
2023-07-02 04:16:50 +08:00
# Common field names
doc: warnings: make expressions more generic When duplicates exist the problem may come from two or more distinct constructs. When running parallel builds there is no guarantee on which one will come first (or if all), so allow any C construct. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-05-17 16:33:03 +08:00
.*Duplicate C declaration.*\n.*'\.\. c:.*:: .*struct in_addr.*'.*
.*Duplicate C declaration.*\n.*'\.\. c:.*:: .*struct in6_addr.*'.*
.*Duplicate C declaration.*\n.*'\.\. c:.*:: .*struct net_if.*'.*