In 66448d9e96 "utest: smp_call: move from example to components/drivers/smp_call"
UTEST_SMP_CALL_FUNC was replaced with RT_UTEST_SMP_CALL_FUNC.
However, some files are forgot to do this replacement, so this patch address
this.
Note: In .config, lines like "# CONFIG_XXX is not set" do not need
to be modified; they are comments. Furthermore, for BSPs, running
"scons --menuconfig" and save the config will automatically replace
them. Therefore, no modification is necessary in this case.
Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
In 01e015450f, "utest: move driver-related case under to drivers,"
UTEST_DEVICE_TC was replaced with RT_UTEST_DRIVERS_CORE. However,
some files are forgot to do this replacement, so this patch address
this.
Note: In .config, lines like "# CONFIG_XXX is not set" do not need
to be modified; they are comments. Furthermore, for BSPs, running
"scons --menuconfig" and save the config will automatically replace
them. Therefore, no modification is necessary in this case.
Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
Also:
- Add "RT_" prefix for utest config options.
- Rename the case names to following the naming rule.
Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
Also:
- Add "RT_" prefix for the UTEST config options.
- Follow the naming rules to update the case name.
Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
Also,
- Rename UTEST_SMP_CALL_FUNC to RT_UTEST_SMP_CALL_FUNC.
- Add depends on RT_USING_SMP in Kconfig for RT_UTEST_SMP_CALL_FUNC
- Follow the naming rules of utest case to update the cases' name.
Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
[cpp_check.py 80 INFO] bsp/w60x/drivers/drv_rtc.c:58:11: error: Syntax Error: AST broken, binary operator '&=' doesn't have two operands. [internalAstError]
[cpp_check.py 80 INFO] libcpu/arm/s3c24x0/rtc.c:34:12: error: Expression 'RTCCON|=RTCCON|=0x01' depends on order of evaluation of side effects [unknownEvaluationOrder]
Add dependent of RT_USING_SERIAL_V2 in Kconfig to
make sure utest for serial_v2 is only available
when RT_USING_SERIAL_V2 is enabled.
Otherwise menuconfig allow people enable UTEST_SERIAL_TC
but building of utestcases failed. It looks weird and
better to be fixed.
Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
Add dependent of RT_USING_SERIAL_BYPASS in Kconfig to
make sure utest for serial-bypass is only available
when RT_USING_SERIAL_BYPASS is enabled.
Otherwise building of utestcases failed when UTEST_SERIAL_BYPASS
is enabled.
Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
The current test environment is mainly based on Ubuntu
22.04 LTS and doxygen version is 1.9.1.
But when we switch to Ubuntu 24.04, the default Doxygen
version on Ubuntu 24.04 is 1.9.8.
The supported configuration and layout file formats
differ from those in 1.9.1 (Ubuntu 22.04).
In particular, the layout XML file format of 1.9.8 is
incompatible with the older format(1.9.1). Therefore,
to support Doxygen on Ubuntu 24.04, we need to load
different configuration and layout files. (The layout
file is specified using the LAYOUT_FILE parameter in
the configuration file.)
Solution: Provide corresponding configuration and layout
files for different Doxygen versions, distinguished by
the Doxygen version number.
Currently, only Doxygen versions 1.9.1 and above are supported.
If the doxygen version is >= 1.9.1 but < 1.9.8, the 1.9.1
configuration and layout are used by default. If the doxygen
version is >= 1.9.8, the 1.9.8 configuration and layout are used.
Only 1.9.1 and 1.9.8 have been tested, as these are the
default doxygen versions on Ubuntu 22.04 LTS and Ubuntu
24.04. Other versions have not been tested yet. If
necessary, we will change the configuration based on
the same approach in the future.
Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
* doxygen: remove @return command if function return void
When doxygen is upgraded to v1.9.8 (on ubuntu 24.04), doxygen
reports: "doxygen error: found documented return type for xxx
that does not return anything" for those functions which return
void but declare "@return" in doxygen comment.
Solution: remove "@return" for those cases, and update
guide document for how to write doxgen comment for functions.
Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
* doxygen: fixed a minor typo for uart doc
This error is found when building with doxygen 1.9.8, but not
detecetd on 1.9.1.
Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
The cleanup involved three parts:
- Merging the standalone "/**@{*/" into
"@addtogroup group_thread_management"
- Changing "/**@}*/" to "/** @} group_thread_management */",
adding the group name makes it easier to find the matching "@{" part.
- Deleting the "@addtogroup" directive in "include/rtthread.h"
because this header file doesn't have doxygen comments.
All doxygen comments for function bodies are defined in other .c files.
Note, we remian two doxygen comments for rt_thread_inited_hookproto_t
and rt_thread_idle_sethook in the "include/rtthread.h".
rt_thread_inited_hookproto_t is really defined here.
For rt_thread_idle_sethook, please see FIXME comment for reason.
Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
The cleanup involved three parts:
- Merging the standalone "/**@{*/" into
"@addtogroup group_object_management"
- Changing "/**@}*/" to "/** @} group_object_management */",
adding the group name makes it easier to find the matching "@{" part.
- Deleting the "@addtogroup" directive in "include/rtthread.h"
because this header file doesn't have doxygen comments.
All doxygen comments for function bodies are defined in "src/object.c".
Plus minor cleanup for group_hook in src/object.c.
Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
