1
0
mirror of https://github.com/ARMmbed/mbedtls.git synced 2025-05-10 17:01:41 +08:00

all.sh: update documentation

Signed-off-by: Manuel Pégourié-Gonnard <manuel.pegourie-gonnard@arm.com>
This commit is contained in:
Manuel Pégourié-Gonnard 2024-10-09 12:51:05 +02:00
parent e4e65aa10a
commit 58c09bd642

View File

@ -83,16 +83,19 @@
# #
# The bulk of the code is organized into functions that follow one of the # The bulk of the code is organized into functions that follow one of the
# following naming conventions: # following naming conventions:
# * pre_XXX: things to do before running the tests, in order. # * in all-core.sh:
# * component_XXX: independent components. They can be run in any order. # * pre_XXX: things to do before running the tests, in order.
# * component_check_XXX: quick tests that aren't worth parallelizing. # * post_XXX: things to do after running the tests.
# * component_build_XXX: build things but don't run them. # * in components-*.sh:
# * component_test_XXX: build and test. # * component_XXX: independent components. They can be run in any order.
# * component_release_XXX: tests that the CI should skip during PR testing. # * component_check_XXX: quick tests that aren't worth parallelizing.
# * support_XXX: if support_XXX exists and returns false then # * component_build_XXX: build things but don't run them.
# component_XXX is not run by default. # * component_test_XXX: build and test.
# * post_XXX: things to do after running the tests. # * component_release_XXX: tests that the CI should skip during PR testing.
# * other: miscellaneous support functions. # * support_XXX: if support_XXX exists and returns false then
# component_XXX is not run by default.
# * in various files:
# * other: miscellaneous support functions.
# #
# Each component must start by invoking `msg` with a short informative message. # Each component must start by invoking `msg` with a short informative message.
# #
@ -111,11 +114,6 @@
# * Check out `Makefile`, `library/Makefile`, `programs/Makefile`, # * Check out `Makefile`, `library/Makefile`, `programs/Makefile`,
# `tests/Makefile` and `programs/fuzz/Makefile` from git. # `tests/Makefile` and `programs/fuzz/Makefile` from git.
# This cleans up after an in-tree use of CMake. # This cleans up after an in-tree use of CMake.
#
# The tests are roughly in order from fastest to slowest. This doesn't
# have to be exact, but in general you should add slower tests towards
# the end and fast checks near the beginning.
################################################################ ################################################################