ARMmbed / mbed-os-5-docs

Full documentation for Mbed OS 5 and 6

Home Page:http://os.mbed.com/docs

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Test commands not in line since test directories move

jeromecoutant opened this issue · comments

Hi

In many doc pages, test commands are not correct, user can not verify its porting or patches for ex.

I tried to make few grep:

docs/api/security/Devicekey.md:    mbed test -n features-device_key-tests-device_key-functionality
docs/porting/storage/BlockDevice.md:mbed test -t <toolchain> -m <target> -n features-tests-filesystem-*_block_device
docs/porting/storage/BlockDevice.md:mbed test -t <toolchain> -m <target> -n mbed-os-features-storage-tests-blockdevice-general_block_device -v
docs/porting/porting_full_process/built_in_tests.md:    mbed test -m <new_target> -t gcc_arm --compile-list -n mbed-os-tests-mbed_hal-common_ticker
docs/porting/target/QuadSPI.md:mbed test -t <toolchain> -m <target> -n tests-mbed_hal-qspi
docs/porting/target/ResetReason.md:mbed test -t <toolchain> -m <target> -n "tests-mbed_hal-reset_reason"
docs/porting/target/Watchdog.md:mbed test -t <toolchain> -m <target> -n "tests-mbed_hal-watchdog*"
docs/porting/target/crc.md:mbed test -t <toolchain> -m <target> -n "tests-mbed_hal-crc*"
docs/porting/target/flash.md:- Flash IAP: `mbed test -m TARGET_NAME -n tests-mbed_drivers-flashiap`.
docs/porting/target/flash.md:- Flash HAL: `mbed test -m TARGET_NAME -n tests-mbed_hal-flash`.
docs/porting/target/i2c.md:mbed test -t <toolchain> -m <target> -n "tests-mbed_hal_fpga_ci_test_shield-i2c"
docs/porting/target/lp_ticker.md:mbed test -t <toolchain> -m <target> -n tests-mbed_hal-common_ticker*,tests-mbed_hal-lp_ticker*
docs/porting/target/mpu.md:mbed test -t <toolchain> -m <target> -n "tests-mbed_hal-mpu*"
docs/porting/target/rtc.md:mbed test -t <toolchain> -m <target> -n "tests-mbed_hal-rtc*"
docs/porting/target/sai.md:mbed test -t <toolchain> -m <target> -n "tests-mbed_hal-sai*"
docs/porting/target/sleep.md:mbed test -t <toolchain> -m <target> -n "tests-mbed_hal-sleep*"
docs/porting/target/spi.md:mbed test -t <toolchain> -m <target> -n "tests-mbed_hal-spi*"
docs/porting/target/spi.md:   - SPI master: `mbed test -t GCC_ARM -m K64F -n tests-mbed_hal_fpga_ci_test_shield-spi_master -v`
docs/porting/target/spi.md:   - SPI slave: `mbed test -t GCC_ARM -m K64F -n tests-mbed_hal_fpga_ci_test_shield-spi_slave -v`
docs/porting/target/static_pinmap.md: mbed test -t ARM -m K64F -n tests-mbed_hal_fpga_ci_test_shield*
docs/porting/target/target.md:mbed test -t <toolchain> -m <target> -n mbed-os-tests-mbed_hal*
docs/porting/target/us_ticker.md:mbed test -t <toolchain> -m <target> -n tests-mbed_hal-common_ticker*,tests-mbed_hal-us_t
docs/debugging-testing/testing/testing_greentea.md:$ mbed test -n tests-*-mbed_platform-*
docs/porting/connectivity/NetworkStack.md:Building and running the tests require you to provide the `mbed_app.json` as guided, and run the test with `mbed test -n mbed-os-tests-network-*,mbed-os-tests-netsocket*`.
docs/porting/connectivity/NetworkStack.md:- Run tests - `mbed test -m [mcu] -t [toolchain] -n mbed-os-tests-netsocket* --test-config esp8266_config.json`.
docs/porting/porting_full_process/integration-tests.md:   $ mbed test -t <toolchain> -m <platform> -n *integration-* -DINTEGRATION_TESTS --app-config TESTS\integration\COMMON\target_extended.json -v
docs/porting/target/usb.md:mbed test -t <toolchain> -m <target> -n mbed-os-tests-usb_device-*
docs/tools/mbed_cli_1/cli-test-debug.md:$ mbed test -m NUCLEO_F429ZI -t GCC_ARM -n TESTS-functional*

ex:
"-n features-device_key-tests-device_key-functionality" => "-n drivers-device_key-tests-tests-device_key-functionality"
"-n tests-mbed_hal-qspi" => "-n hal-tests-tests-mbed_hal-qspi"

@jeromecoutant This issue has an incomplete or old issue template.For future reference please use an up to date clone of the repository before raising issues. Many thanks.

Thank you for raising this detailed GitHub issue. I am now notifying our internal issue triagers.
Internal Jira reference: https://jira.arm.com/browse/IOTOSM-3712