diff --git a/.github/.wordlist.txt b/.github/.wordlist.txt deleted file mode 100644 index 4ba44213739c30..00000000000000 --- a/.github/.wordlist.txt +++ /dev/null @@ -1,949 +0,0 @@ -AAAA -aabbccddeeff -aarch -abcdef -abfb -ABI -ABIs -ables -accessor -AccountLogin -acdbc -ACKed -ACL -AdapterAddress -AdapterName -adb -addr -AddThreadNetwork -AddWiFiNetwork -adk -adoc -AdvAutonomous -AdvManagedFlag -AdvOnLink -AdvRouterAddr -AdvSendAdvert -AE -aef -algs -alloc -APIs -apk -AppConfig -ApplicationBasic -ApplicationLauncher -approver -aps -arg -argc -args -argv -armeabi -armv -att -attId -attrListName -attrMask -attSizeBytes -attType -AudioOutput -auth -autoconnect -autocrlf -autogenerated -automake -autotools -AwaitNextAction -AXXXF -babaf -backend -backticks -backtrace -BarrierControl -BasicCHIPRegression -baudrate -BD -BDX -BeagleBone -bitbake -bld -ble -BLE -BleApplicationDelegate -BleLayer -BLEManager -BLEManagerImpl -BlePlatformDelegate -Blinls -bloaty -blocklist -blockquote -bluetoothd -bluez -bootable -Bootloader -BorderRouterAP -BRD -breakpoint -bredr -BridgedDeviceBasic -bridgedLightEndpoint -bringup -bt -btmgmt -BTN -BTP -btvirt -buildwithmatter -burndown -BytesMain -bz -bzip -CACACACA -cacerts -CAfile -cancelled -CBB -cbd -CCMP -CCS -CCSTUDIO -CCXML -ced -cfg -CFLAGS -cgroup -changeset -characterised -CharString -ChipBLEMgr -CHIPCirqueTest -CHIPCryptoPALHsm -CHIPDeviceController -ChipDeviceCtrl -CHIPDeviceEvent -CHIPDevicePlatformEvent -ChipEchoRequester -ChipEchoResponder -ChipImInitiator -ChipImResponder -ChipLight -ChipMessageLayer -CHIPTool -chmod -chrpath -CircleCI -cJTAG -CKIT -CLA -clapre -CLI -cloudbuild -CLRF -clusterAttrs -clusterId -clusterList -clusterListName -ClusterRevision -ClusterTestGeneration -cmake -CMSIS -CMVH -cn -codeaurora -codebase -CodeLab -codelabs -ColorControl -Comcast -Commandline -Commissionable -CommissioningFlow -commondatastorage -CONF -CONFIG -ConfigDescription -ConfigurationManager -ConfigurationManagerImpl -connectedhomeip -ConnectionData -ConnectIP -ConnectivityManager -ConnectivityManagerImpl -connstring -conntype -const -ContentLaunch -ContentLauncher -controllee -conv -cortexa -cp -cpio -cpp -cppreference -cpuapp -cpython -crypto -cryptographic -csu -csv -ctl -ctrl -ctypes -CurrentHue -CurrentLevel -CurrentSaturation -customizations -cxx -CY -DAC -DAP -DataFrame -dataset -datasets -dBm -DBUILD -dbus -dcc -DCHIP -DCMAKE -debianutils -DEDEDEDE -DelayedActionTime -demangle -deployable -deps -desc -descheduled -dev -devcontainer -devCtrl -DeviceCaCerts -DeviceCert -DeviceCommissioner -DeviceCommon -DeviceController -DeviceId -DeviceLayer -DeviceNetworkProvisioningDelegate -DeviceNetworkProvisioningDelegateImpl -DevicePairingDelegate -DevKitC -DevKitM -df -dfu -DHCP -dhrishi -dialout -diffstat -diffsyms -dimmable -dirs -disambiguated -discoverable -DispatchEvent -DispatchEventToApplication -DISTRO -Distutils -DK -DL -DNS -Dnsmasq -dnsmasqd -DNSStubListener -Dockerfile -Dockerfiles -Don'ts -DoorLock -DOTBR -DOVERLAY -downcasting -Doxygen -dpkg -dryrun -DS -duplicative -DV -dynload -eabi -EB -ECC -ECD -EchoRequests -EchoResponse -EchoService -edaf -EDR -ee -EEE -eef -ef -efr -EFR -eg -EjQ -elftools -emberAfExternalAttributeReadCallback -emberAfExternalAttributeWriteCallback -EnableNetwork -EnableWiFiNetwork -EndpointId -endpointName -entrypoint -env -esd -ESPPORT -Espressif -eth -EthernetNetworkDiagnostics -ethernets -EvalCode -EvalCodeWithName -EvalFrameDefault -evk -exceptfds -ExchangeContext -exe -ExecStart -executables -ExtendedPAN -extern -extpanid -FabricId -factoryreset -fb -fbb -fbd -FC -FDDE -fde -FECA -feff -ffeebaefa -FFF -fffe -fffff -Fi -filepath -fini -FixedLabel -flashdebug -focusable -forkpty -formatOnSave -fota -FOTA -FreeRTOS -fsl -fsync -gcloud -GDB -GeneralCommissioning -GeneralDiagnostics -GenericConfigurationManagerImpl -GenericConnectivityManagerImpl -GenericImpl -GenericPlatformManagerImpl -GenericThreadConfigurationManagerImpl -GenericThreadStackManagerImpl -GenericWiFiConfigurationManagerImpl -GetDeviceId -GetDeviceInfo -GetIP -getstarted -gitignore -glibc -gn -GND -gni -GNinja -gnuarmemb -GNUARMEMB -googleapis -googlesource -GPG -GPIO -GPL -GPLv -Gradle -gradlew -GroupId -GroupKeyManagement -gtk -Gv -hardcoded -hardknott -HardwareVersion -HardwareVersionString -hci -hciattach -hciconfig -hdlc -HKDF -hoc -hostapd -hostname -href -HTTPS -HW -iaszone -ICA -ICMP -IDF -idx -ifdef -ifdefs -ihex -im -IM -imager -imagetool -img -Impl -ImplClass -implementers -imx -indexhtml -Inet -InetLayer -Infineon -init -inlined -instantiation -integrations -IntelliSense -InteractionModelVersion -Interation -Interoperable -introvideos -InvokeCommandRequests -InvokeCommandResponse -IoT -ipaddr -ipp -iptables -iputils -IPv -ISCAN -itemName -iterable -jinja -jlink -JLink -JLinkExe -JLinkRTTClient -JN -jpg -js -json -JTAG -KA -Kconfig -KeypadInput -KitProg -kNodeIdNotSpecified -knownissues -KVS -LabelList -LAUNCHXL -ldflags -LEDs -LevelControl -LF -libavahi -libc -libcairo -libCHIP -libdbus -LIBDIR -libegl -libffi -libgirepository -libglib -libical -libncurses -libreadline -libsdl -libssl -libstdc -libthread -libtool -libTransportLayer -libudev -libwebkitgtk -lifecycle -lightbulb -lightin -LinkSoftwareAndDocumentationPack -LocalConfigDisabled -localhost -localstatedir -LowPower -LPC -LTE -LTS -LwIP -macaddr -machineType -MacOS -MacOSX -MacPorts -Makefile -makefiles -MakeTpCall -mandir -ManualPairingCode -ManualTest -ManufacturingDate -masterkey -matterc -matterd -MatterLock -MaxInterval -MaxRtrAdvInterval -mbedTLS -mcu -MCUboot -mcumgr -MCUs -mcux -MCUXpresso -mdash -MDNS -MediaInput -MediaPlayback -mem -memdf -MemMonitoring -menuconfig -MeshCoP -MfgDeviceCaCerts -MfgSpecificPing -mfrcacerts -mfrcert -MfrDeviceCert -MfrDeviceId -mgmt -microcontroller -MicroSD -middleware -Minicom -MinInterval -MinRtrAdvInterval -mkdir -mlan -mmevk -moal -modprobe -Modustoolbox -moveMode -MoveToHue -MoveToLevel -MoveToSaturation -MoveWithOnOff -MPSL -MRP -MTU -Multiband -Multicast -multilib -Multiprotocol -MX -mydir -MyPASSWORD -MySSID -nano -natively -navpad -ncs -nding -NDK -netplan -NetworkCommissioning -networkID -networkname -NewUDPEndPoint -nfds -nl -NLUnitTest -NLUnitTests -NodeId -nordicsemi -NotAvailable -nRF -nrfconnect -nrfdks -nrfutil -nrfxlib -NUM -NTAG -nwk -NXP -objcopy -OccupancySensing -OctetString -OECORE -ol -Onboarding -onboardingcodes -oneshot -OnOff -OnOffClusterTest -OnPlatformEvent -OpenSSL -OpenThread -OpenThreadDemo -openweave -OperationalCredentials -operationalDataset -opkg -optionMask -optionOverride -optionsMask -optionsOverride -orgs -OTA -OTBR -otcli -PAA -PAI -PairDevice -PAKE -param -params -PartNumber -PASE -Passcode -PBKDF -PCA -pcaps -PDFs -PDK -peerAddrStr -pem -percentageLiftValue -pexpect -PID -Pigweed -PinCode -pkgconfig -PlatformManager -PlatformManagerImpl -plt -png -polymorphism -POSIX -PosixConfig -postAttributeChangeCallback -pre -preprocessor -Presetup -prj -ProductID -ProductLabel -ProductName -productrev -ProductRevision -ProductURL -proto -protos -Prover -PRs -PSCAN -PSK -PTR -pts -PumpConfigurationAndControl -pwd -PXXXF -py -pychip -pycrypto -pycryptodome -PyEval -PyFunction -pylint -PyObject -PyRun -QEMU -Qorvo -QPG -QRCode -qrcodetool -QRCodeUrl -QSPI -QueryImage -qvCHIP -RADVD -RasPi -RCP -ReadConfigValue -readelf -readfds -README -Reag -rebase -recommand -recommanded -recurse -regen -RelativeHumidityMeasurement -RemainAfterExit -remoteDeviceId -Rendez -RendezvousInformation -RendezvousParameters -RendezVousTest -repo -req -Requestor -responder -reusability -rfid -rfids -RGB -riscv -rloc -rmw -Rollershade -rootfs -RPC -RPCs -RPi -rsn -RSSI -rtld -RTOS -RTT -RUNAS -RunMain -runtime -rw -sbin -scalability -scalable -scm -sco -scp -ScriptBinding -SDC -SDHC -SDK -SDK's -SDKs -SDKTARGETSYSROOT -sdl -segger -SEGGER -semver -SERIALDEVICE -SerialNumber -ServiceId -SetUpPINCode -SetupQRCode -sexualized -SIGINT -SiLabs -SiliconLabs -SimpleFileExFlags -SimpleLink -sl -SLTB -SLWSTK -SmartThings -SMP -socat -socio -softap -SoftDevice -softmmu -SoftwareDiagnostics -SoftwareVersion -SoftwareVersionString -spinel -src -SRP -SRV -SSID -startoffset -StartScan -stderr -stdout -str -strcpy -su -Subclassing -subcommand -subcommands -subdirectories -subdirectory -submodule -submodules -subprocess -sudo -svg -SVR -SWD -sysconfdir -SysConfig -sysctl -sysdeps -sysroot -SYSROOT -systemctl -systemd -systemdsystemunitdir -systemduserunitdir -sysv -TargetNavigator -TBD -TCP -teardown -Telink -TemperatureMeasurement -TestArray -TestCluster -TestEmptyString -TestMultiRead -TESTPASSWD -TESTSSID -TestString -TestStruct -TestThreadStackMgr -TestUint -TestUpdateValue -testws -texinfo -textboxes -TFT -ThreadStackManager -ThreadStackManagerImpl -Thunderboard -timeoutMs -TKIP -tlsr -TLV -tmp -tngvndl -TODO -toolchain -toolchains -topologies -totalTests -trackAlloc -trackFree -transitionTime -TransportMgrBase -TrustedRootCertificates -TSG -tsv -tty -ttyACM -ttyACMx -ttymxc -ttyUSB -TvChannel -txt -uart -UART -UDP -UDPEndPoint -ug -ui -uint -unblur -UNBLUR -uncommissioned -unfocus -Unicast -UniFlash -unpair -unprovisioned -untrusted -UpdateTokens -upstreamed -URI -usbmodem -USBtoUART -uscif -USERINTERFACE -UserLabel -usermod -usr -util -utils -UUID -VCP -Vectorcall -VendorID -VendorName -vendorpayload -venv -Verifier -VID -visualstudio -vlatest -VLEDs -vnc -vous -VSC -VSCode -WakeOnLan -WantedBy -webpage -wget -whde -whitespace -whitespaces -whl -wic -WindowCovering -WindowCoveringGoToLiftPercentage -wlan -wmm -WPA -wpan -wra -writefds -wrover -WS -WSL -WSTK -xab -xaver -xbef -xcd -Xcode -xd -xds -xdsdfu -xef -xF -xFFFF -xfffff -xffffffffe -xfffffffff -xtensa -xwayland -XXXX -xz -yaml -yearday -yml -YNJV -Yocto -yoctoproject -YourFolder -zapt -zaptool -ZCL -zclconfigure -zclread -zclwrite -ZephyrConfig -zephyrproject -Zigbee -zigbeealliance -zigbeethread diff --git a/.github/workflows/android.yaml b/.github/workflows/android.yaml index a95c7726dee66d..2fbc0d57913c3f 100644 --- a/.github/workflows/android.yaml +++ b/.github/workflows/android.yaml @@ -16,11 +16,7 @@ name: Android on: push: - paths: - - '!**.md' pull_request: - paths: - - '!**.md' concurrency: group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }} diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 3278baa5a54b8b..1e32b20861fdc9 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -16,11 +16,7 @@ name: Builds on: push: - paths: - - '!**.md' pull_request: - paths: - - '!**.md' workflow_dispatch: concurrency: diff --git a/.github/workflows/cirque.yaml b/.github/workflows/cirque.yaml index 9e9530a2089ab1..1a229025285af8 100644 --- a/.github/workflows/cirque.yaml +++ b/.github/workflows/cirque.yaml @@ -16,11 +16,7 @@ name: Cirque on: push: - paths: - - '!**.md' pull_request: - paths: - - '!**.md' workflow_dispatch: concurrency: diff --git a/.github/workflows/darwin.yaml b/.github/workflows/darwin.yaml index 1b8959fecedf99..417329feac3810 100644 --- a/.github/workflows/darwin.yaml +++ b/.github/workflows/darwin.yaml @@ -16,11 +16,7 @@ name: Darwin on: push: - paths: - - '!**.md' pull_request: - paths: - - '!**.md' workflow_dispatch: concurrency: diff --git a/.github/workflows/doxygen.yaml b/.github/workflows/doxygen.yaml index 1d264a9c42f98f..615eb5ab69d44d 100644 --- a/.github/workflows/doxygen.yaml +++ b/.github/workflows/doxygen.yaml @@ -16,11 +16,7 @@ name: Doxygen on: push: - paths: - - '!**.md' pull_request: - paths: - - '!**.md' workflow_dispatch: concurrency: diff --git a/.github/workflows/examples-efr32.yaml b/.github/workflows/examples-efr32.yaml index 515a8d88fe7434..2b73a924b26ee5 100644 --- a/.github/workflows/examples-efr32.yaml +++ b/.github/workflows/examples-efr32.yaml @@ -16,11 +16,7 @@ name: Build example - EFR32 on: push: - paths: - - '!**.md' pull_request: - paths: - - '!**.md' concurrency: group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }} diff --git a/.github/workflows/examples-esp32.yaml b/.github/workflows/examples-esp32.yaml index 6fc95b90c471a1..1cce1a171e9083 100644 --- a/.github/workflows/examples-esp32.yaml +++ b/.github/workflows/examples-esp32.yaml @@ -16,11 +16,7 @@ name: Build example - ESP32 on: push: - paths: - - '!**.md' pull_request: - paths: - - '!**.md' concurrency: group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }} diff --git a/.github/workflows/examples-infineon.yaml b/.github/workflows/examples-infineon.yaml index df3d87e379a2c0..196fc434169a77 100644 --- a/.github/workflows/examples-infineon.yaml +++ b/.github/workflows/examples-infineon.yaml @@ -16,11 +16,7 @@ name: Build example - Infineon P6 on: push: - paths: - - '!**.md' pull_request: - paths: - - '!**.md' workflow_dispatch: concurrency: diff --git a/.github/workflows/examples-k32w.yaml b/.github/workflows/examples-k32w.yaml index 8bcc30398dfd18..11058a5a61129d 100644 --- a/.github/workflows/examples-k32w.yaml +++ b/.github/workflows/examples-k32w.yaml @@ -16,11 +16,7 @@ name: Build example - K32W with SE051 on: push: - paths: - - '!**.md' pull_request: - paths: - - '!**.md' concurrency: group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }} diff --git a/.github/workflows/examples-linux-standalone.yaml b/.github/workflows/examples-linux-standalone.yaml index a7744ab5dd2b6a..ff751c8578dc31 100644 --- a/.github/workflows/examples-linux-standalone.yaml +++ b/.github/workflows/examples-linux-standalone.yaml @@ -16,11 +16,7 @@ name: Build example - Linux Standalone on: push: - paths: - - '!**.md' pull_request: - paths: - - '!**.md' concurrency: group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }} diff --git a/.github/workflows/examples-nrfconnect.yaml b/.github/workflows/examples-nrfconnect.yaml index 09230f6e18fea5..b48f5dfa09ff66 100644 --- a/.github/workflows/examples-nrfconnect.yaml +++ b/.github/workflows/examples-nrfconnect.yaml @@ -16,11 +16,7 @@ name: Build example - nRF Connect SDK on: push: - paths: - - '!**.md' pull_request: - paths: - - '!**.md' concurrency: group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }} diff --git a/.github/workflows/examples-qpg.yaml b/.github/workflows/examples-qpg.yaml index 6b86f7844142c4..50518558390431 100644 --- a/.github/workflows/examples-qpg.yaml +++ b/.github/workflows/examples-qpg.yaml @@ -16,11 +16,7 @@ name: Build example - QPG on: push: - paths: - - '!**.md' pull_request: - paths: - - '!**.md' concurrency: group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }} diff --git a/.github/workflows/examples-telink.yaml b/.github/workflows/examples-telink.yaml index 6d99803f0a021b..b2372a724f8133 100644 --- a/.github/workflows/examples-telink.yaml +++ b/.github/workflows/examples-telink.yaml @@ -16,11 +16,7 @@ name: Build example - Telink on: push: - paths: - - '!**.md' pull_request: - paths: - - '!**.md' concurrency: group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }} diff --git a/.github/workflows/qemu.yaml b/.github/workflows/qemu.yaml index c961f5ab87db82..d67075c53499e7 100644 --- a/.github/workflows/qemu.yaml +++ b/.github/workflows/qemu.yaml @@ -16,11 +16,7 @@ name: QEMU on: push: - paths: - - '!**.md' pull_request: - paths: - - '!**.md' concurrency: group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }} diff --git a/.github/workflows/spell.yml b/.github/workflows/spell.yml deleted file mode 100644 index 2911e77f3e0648..00000000000000 --- a/.github/workflows/spell.yml +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright (c) 2020-2021 Project CHIP Authors -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -name: Run misspell -# yamllint disable-line rule:truthy -on: - push: - paths: - - '**.md' - - '!.github/*' - pull_request: - branches: - - master - paths: - - '**.md' - - '!.github/*' - -jobs: - check-reviewdog: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 - - uses: reviewdog/action-misspell@v1 - with: - github_token: ${{ secrets.github_token }} - check-spellcheck: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 - - uses: igsekor/pyspelling-any@v0.0.2 diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml index c8d881f822360f..a588da906050c8 100644 --- a/.github/workflows/tests.yaml +++ b/.github/workflows/tests.yaml @@ -16,11 +16,7 @@ name: Tests on: push: - paths: - - '!**.md' pull_request: - paths: - - '!**.md' workflow_dispatch: concurrency: diff --git a/.github/workflows/unit_integration_test.yaml b/.github/workflows/unit_integration_test.yaml index da6a40956bd96b..14adee6374a317 100644 --- a/.github/workflows/unit_integration_test.yaml +++ b/.github/workflows/unit_integration_test.yaml @@ -16,11 +16,7 @@ name: Unit / Interation Tests on: push: - paths: - - '!**.md' pull_request: - paths: - - '!**.md' concurrency: group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }} diff --git a/.github/workflows/zap_templates.yaml b/.github/workflows/zap_templates.yaml index d6a67c80136be6..245d6c664b9619 100644 --- a/.github/workflows/zap_templates.yaml +++ b/.github/workflows/zap_templates.yaml @@ -16,11 +16,7 @@ name: ZAP on: push: - paths: - - '!**.md' pull_request: - paths: - - '!**.md' concurrency: group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }} diff --git a/.spellcheck.yml b/.spellcheck.yml deleted file mode 100644 index a6c56411bcc5a6..00000000000000 --- a/.spellcheck.yml +++ /dev/null @@ -1,25 +0,0 @@ -# Copyright (c) 2020-2021 Project CHIP Authors -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -matrix: - - name: markdown - dictionary: - wordlists: - - .github/.wordlist.txt - pipeline: - - pyspelling.filters.markdown: - sources: - - '**/*.md|!third_party/**|!examples/common/**/repo/**' - aspell: - ignore-case: true diff --git a/docs/VSCODE_DEVELOPMENT.md b/docs/VSCODE_DEVELOPMENT.md index 8e1047568c6e17..1f7463dbed607a 100644 --- a/docs/VSCODE_DEVELOPMENT.md +++ b/docs/VSCODE_DEVELOPMENT.md @@ -85,7 +85,7 @@ session. Developers are encouraged to add tasks to the [launch json](../.vscode/launch.json) over time to make sure everyone is using -the same base debugging setup. +the same base debuging setup. ## Submitting a Pull Request - Practical Advice diff --git a/docs/guides/nrfconnect_examples_configuration.md b/docs/guides/nrfconnect_examples_configuration.md index f51250e9662b49..cf544fbeb76cc1 100644 --- a/docs/guides/nrfconnect_examples_configuration.md +++ b/docs/guides/nrfconnect_examples_configuration.md @@ -107,7 +107,7 @@ them default values for any application. The application configuration is specified using Kconfig configuration files (`*.conf`), where available Kconfig options can be used and their default values -overridden. Typically, there are many files having impact on the final +overrided. Typically, there are many files having impact on the final configuration shape. There is no need to modify all these files separately. See the following list diff --git a/docs/guides/nxp_k32w_android_commissioning.md b/docs/guides/nxp_k32w_android_commissioning.md index bdeb564ccd227c..4d7b7232aee010 100644 --- a/docs/guides/nxp_k32w_android_commissioning.md +++ b/docs/guides/nxp_k32w_android_commissioning.md @@ -27,7 +27,7 @@ onto a CHIP-enabled Thread network. The commissioning process is composed of the following main stages: -- K32W061 (CHIP accessory) device is put in BLE advertisement mode by pressing +- K32W061 (CHIP accessory) device is put in BLE advertisment mode by pressing the USERINTERFACE button; - CHIPTool discovers the CHIP accessory over BLE; - CHIPTool establishes a secure channel with the accessory using a SPAKE2+ @@ -182,7 +182,7 @@ To make your PC work as a Thread Border Router, complete the following tasks: - On System startup, dnsmasq will not wait for wlan0 interface to initialize and will fail. We need to tell systemd to launch it after - networks get ready, so we will modify dnsmasq service file by specifying + networks get ready, so we will modify dnsmasq service file by specifing the initialization order under the _After=_ and _Wants=_ sections: $ sudo vim /lib/systemd/system/dnsmasq.service diff --git a/docs/guides/python_chip_controller_advanced_usage.md b/docs/guides/python_chip_controller_advanced_usage.md index 8a324b15b06a6c..845967714c9b92 100644 --- a/docs/guides/python_chip_controller_advanced_usage.md +++ b/docs/guides/python_chip_controller_advanced_usage.md @@ -110,7 +110,7 @@ Reading symbols from python3... ``` The Python will create lots of threads due to main loop, so you may want to -suppress thread related outputs first by running the following command: +supress thread related outputs first by running the following command: ``` (gdb) set print thread-events off @@ -247,4 +247,4 @@ then you can use `bt` (for `backtrace`) to see the backtrace of the call stack. ``` The frame #0 and frame #1 are the function frames in the CHIP C++ library, the -other frames live in the Python interpreter so you can ignore it. +other frames live in the Python intepreter so you can ignore it. diff --git a/docs/guides/python_chip_controller_building.md b/docs/guides/python_chip_controller_building.md index 032b72953d4372..d52e8f7c3f592d 100644 --- a/docs/guides/python_chip_controller_building.md +++ b/docs/guides/python_chip_controller_building.md @@ -223,7 +223,7 @@ with network credentials. Done ``` - Matter specification does not define how the Thread or Wi-Fi credentials are + Matter specifiction does not define how the Thread or Wi-Fi credentials are obtained by Controller. For example, for Thread, instead of fetching datasets directly from the Thread Border Router, you might also use a different out-of-band method. @@ -248,7 +248,7 @@ with network credentials. #### Commissioning a Wi-Fi device 1. Assuming your Wi-Fi SSID is _TESTSSID_, and your Wi-Fi password is - _P455W4RD_, inject the credentials to the device by executing the following + _P455W4RD_, inject the credentials to the device by excuting the following command: ``` @@ -396,7 +396,7 @@ If no nodeid given, a random Node ID will be used. ### `close-session ` -If case there exists an open session (PASE or CASE) to the device with a given +If case there eixsts an open session (PASE or CASE) to the device with a given Node ID, mark it as expired. ### `discover` @@ -470,7 +470,7 @@ chip-device-ctrl > zcl LevelControl MoveWithOnOff 12344321 1 0 moveMode=1 rate=2 For any integer and char string (null terminated) types, just use `key=value`, for example: `rate=2`, `string=123`, `string_2="123 456"` -For byte string type, use `key=encoding:value`, currently, we support `str` and +For byte string type, use `key=encoding:value`, currectly, we support `str` and `hex` encoding, the `str` encoding will encode a NULL terminated string. For example, `networkId=hex:0123456789abcdef` (for `[0x01, 0x23, 0x45, 0x67, 0x89, 0xab, 0xcd, 0xef]`), `ssid=str:Test` (for diff --git a/examples/all-clusters-app/esp32/README.md b/examples/all-clusters-app/esp32/README.md index 21cc61569b1ead..73565e8ac0b992 100644 --- a/examples/all-clusters-app/esp32/README.md +++ b/examples/all-clusters-app/esp32/README.md @@ -220,7 +220,7 @@ commissioning and cluster control. `chip-device-ctrl > zcl LevelControl MoveToLevel 135246 1 1 level=10 transitionTime=0 optionMask=0 optionOverride=0` -- For ESP32C3-DevKitM, use the ColorControl cluster commands to control the +- For ESP32C3-DevKitM, use the ColorContorl cluster commands to control the CurrentHue and CurrentSaturation attribute. This allows you to control the color of on-board LED. diff --git a/examples/lighting-app/efr32/README.md b/examples/lighting-app/efr32/README.md index 6be09ad47bb191..6f689e04a3d6a2 100644 --- a/examples/lighting-app/efr32/README.md +++ b/examples/lighting-app/efr32/README.md @@ -221,7 +221,7 @@ combination with JLinkRTTClient as follows: - _Press and Release_ : Start, or restart, BLE advertisement in fast mode. It will advertise in this mode for 30 seconds. The device will then switch to a slower interval advertisement. - After 15 minutes, the advertisement stops. + After 15 minutes, the adverstiment stops. - _Pressed and hold for 6 s_ : Initiates the factory reset of the device. Releasing the button within the 6-second window cancels the factory reset @@ -280,7 +280,7 @@ via 2002::2 - To use the chip-rpc console after it has been installed run: `python3 -m chip_rpc.console --device /dev/tty. -b 115200 -o //pw_log.out` -- Then you can simulate a button press or release using the following command +- Then you can simulate a button press or realease using the following command where : idx = 0 or 1 for Button PB0 or PB1 action = 0 for PRESSED, 1 for RELEASE Test toggling the LED with `rpcs.chip.rpc.Button.Event(idx=1, pushed=True)` diff --git a/examples/lighting-app/nxp/linux-imx/imx8m/README.md b/examples/lighting-app/nxp/linux-imx/imx8m/README.md index cfad7440f7b945..479b9668c552e7 100644 --- a/examples/lighting-app/nxp/linux-imx/imx8m/README.md +++ b/examples/lighting-app/nxp/linux-imx/imx8m/README.md @@ -155,7 +155,7 @@ The generated executable file supports to work with below commandline argument: - Prerequisites By following the [Building](#building) section of this document, the Yocto - image is cross-compiled and programmed to a microSD card. + image is cross-compiled and programed to a microSD card. Follow the steps below to setup the environment needed to run the example on the i.MX 8M Mini EVK: diff --git a/examples/lighting-app/telink/Readme.md b/examples/lighting-app/telink/Readme.md index 34cfce4ae0418e..a91d67f23b73b9 100644 --- a/examples/lighting-app/telink/Readme.md +++ b/examples/lighting-app/telink/Readme.md @@ -15,7 +15,7 @@ ``` here `${CHIP_BASE}` is directory which contains CHIP repo files **!!!Pay - attention that OUTPUT_DIR should contains ABSOLUTE path to output dir** + attention that OUTPUT_DIR should conatins ABSOLUTE path to output dir** 1. Run build script: ``` @@ -71,7 +71,7 @@ $ BORDER_ROUTING=0 NETWORK_MANAGER=1 ./script/setup ### Setup IPv6 -Pay attention that border router should be configured as IPv6 access point. +Pay attention that border router shoud be configured as IPv6 access point. 1. To do so perform the following command: ``` @@ -86,7 +86,7 @@ Pay attention that border router should be configured as IPv6 access point. ### Config network Use [Web GUI](https://openthread.io/guides/border-router/web-gui) to config -Thread network **tlsr9518adk80d** board supports only static commissioning with +Thread network **tlsr9518adk80d** board supports only static comissioning with predefined Thread credentials shown in table below: | Item | Value | @@ -115,11 +115,11 @@ To get output from device, connect UART to following pins: The following buttons are available on **tlsr9518adk80d** board: -| Name | Function | Description | -| :------- | :--------------- | :----------------------------------------------------------------------------------------------------- | -| Button 1 | Factory reset | Perform factory reset to forget currently commissioned Thread network and back to uncommissioned state | -| Button 2 | Lighting control | Manually triggers the lighting state | -| Button 3 | Thread start | Commission thread with static credentials and enables the Thread on device | +| Name | Function | Description | +| :------- | :--------------- | :---------------------------------------------------------------------------------------------------- | +| Button 1 | Factory reset | Perform factory reset to forget currently commissioned Thread network and back to uncommisioned state | +| Button 2 | Lighting control | Manually triggers the lighting state | +| Button 3 | Thread start | Comission thread with static credentials and enables the Thread on device | ### LEDs @@ -128,7 +128,7 @@ following states: | State | Description | | :-------------------------- | :--------------------------------------------------------------------------- | -| Blinks with short pulses | Device is not commissioned to Thread, Thread is disabled | +| Blinks with short pulses | Device is not commisioned to Thread, Thred is disabled | | Blinls with frequent pulses | Device is commissioned, Thread enabled. Device trying to JOIN thread network | | Blinks with whde pulses | Device commissioned and joined to thread network as CHILD | @@ -139,7 +139,7 @@ following states: 1. With your client device (PC, Laptop etc.) connect to BorderRouterAP WiFi 2. Press Button 3 on **tlsr9518adk80d** board and wait till it joins to Thread network -3. Find adjusted IPv6 address in UART output of **tlsr9518adk80d** +3. Find ajusted IPv6 address in UART output of **tlsr9518adk80d** 4. Perform following command on your client device: ``` ping -6 ${IP_ADDRESS_OF_CHIP_DEVICE} diff --git a/examples/lock-app/cc13x2x7_26x2x7/README.md b/examples/lock-app/cc13x2x7_26x2x7/README.md index 857dc6bf552159..8d0a9753add908 100644 --- a/examples/lock-app/cc13x2x7_26x2x7/README.md +++ b/examples/lock-app/cc13x2x7_26x2x7/README.md @@ -265,7 +265,7 @@ fully provisioned, BLE advertising will stop. #### Bluetooth LE Rendezvous -To commission and control this application within a CHIP-enabled Thread network, +To commission and control this application wtihin a CHIP-eanbled Thread network, consult the [CHIPTool README](../../../src/android/CHIPTool/README.md) for information on the Android smartphone application. Reference the Device Configuration information printed in the Logging Output of this application. diff --git a/examples/lock-app/efr32/README.md b/examples/lock-app/efr32/README.md index abb69a2a9613ac..8018eb06343f49 100644 --- a/examples/lock-app/efr32/README.md +++ b/examples/lock-app/efr32/README.md @@ -210,7 +210,7 @@ combination with JLinkRTTClient as follows: - _Press and Release_ : Start, or restart, BLE advertisement in fast mode. It will advertise in this mode for 30 seconds. The device will then switch to a slower interval advertisement. - After 15 minutes, the advertisement stops. + After 15 minutes, the adverstiment stops. - _Pressed and hold for 6 s_ : Initiates the factory reset of the device. Releasing the button within the 6-second window cancels the factory reset diff --git a/examples/minimal-mdns/README.md b/examples/minimal-mdns/README.md index 8e781f852424ff..c728d40196998e 100644 --- a/examples/minimal-mdns/README.md +++ b/examples/minimal-mdns/README.md @@ -85,7 +85,7 @@ discovery. ### Advertising to test client listings -#### Simulated uncommissioned node +#### Simulated uncommisioned node ```sh dns-sd -R DD200C20D25AE5F7 _matterc._udp,S52,L840,V123 . 11111 D=840 VP=123+456 @@ -99,11 +99,11 @@ S52._sub._matterc._udp.local. PTR DD200C20D25AE5F7._matterc._udp.loca L840._sub._matterc._udp.local. PTR DD200C20D25AE5F7._matterc._udp.local. V123._sub._matterc._udp.local. PTR DD200C20D25AE5F7._matterc._udp.local. DD200C20D25AE5F7._matterc._udp.local. TXT "D=840" "VP=123+456" -DD200C20D25AE5F7._matterc._udp.local. SRV 0 0 11111 B75AFB458ECD.local. +DD200C20D25AE5F7._mattterc._udp.local. SRV 0 0 11111 B75AFB458ECD.local. B75AFB458ECD.local. AAAA ba2a:b311:742e:b44c:f515:576f:9783:3f30 ``` -#### Simulated commissioning node +#### Simulated commisioning node ```sh dns-sd -R DD200C20D25AE5F7 _matterd._udp,S52,L840,V123 . 11111 D=840 VP=123+456 PH=3 @@ -121,7 +121,7 @@ DD200C20D25AE5F7._matterd._udp.local. SRV 0 0 11111 B75AFB458ECD.local. B75AFB458ECD.local. AAAA ba2a:b311:742e:b44c:f515:576f:9783:3f30 ``` -#### Simulated commissioned node +#### Simulated commisioned node ```sh dns-sd -R 2906C908D115D362-8FC7772401CD0696 _matter._tcp . 22222 @@ -132,15 +132,15 @@ dns-sd -R 2906C908D115D362-8FC7772401CD0696 _matter._tcp . 22222 Nodes: ```sh -dns-sd -B _matterc._udp # Nodes awaiting commissioning -dns-sd -B _matterc._udp,S52 # Nodes awaiting commissioning with short discriminator 52 -dns-sd -B _matterc._udp,L840 # Nodes awaiting commissioning with long discriminator 840 -dns-sd -B _matterc._udp,V123 # Nodes awaiting commissioning with vendor id 123 - -dns-sd -B _matterd._udp # Commissionable nodes -dns-sd -B _matterd._udp,S52 # Commissionable nodes with short discriminator 52 -dns-sd -B _matterd._udp,L840 # Commissionable nodes with long discriminator 840 -dns-sd -B _matterd._udp,V123 # Commissionable nodes with vendor id 123 +dns-sd -B _matterc._udp # Nodes awaiting commisioning +dns-sd -B _matterc._udp,S52 # Nodes awaiting commisioning with short discriminator 52 +dns-sd -B _matterc._udp,L840 # Nodes awaiting commisioning with long discriminator 840 +dns-sd -B _matterc._udp,V123 # Nodes awaiting commisioning with vendor id 123 + +dns-sd -B _matterd._udp # Commisionable nodes +dns-sd -B _matterd._udp,S52 # Commisionable nodes with short discriminator 52 +dns-sd -B _matterd._udp,L840 # Commisionable nodes with long discriminator 840 +dns-sd -B _matterd._udp,V123 # Commisionable nodes with vendor id 123 ``` IP Address: diff --git a/examples/persistent-storage/efr32/README.md b/examples/persistent-storage/efr32/README.md index 2f3b5773821006..5b03331557057a 100644 --- a/examples/persistent-storage/efr32/README.md +++ b/examples/persistent-storage/efr32/README.md @@ -29,7 +29,7 @@ platforms. ## EFR32 The EFR32 platform KVS is fully implemented, the KVS is enabled and configured -using these defines: +using theese defines: ``` defines = [ diff --git a/examples/pump-app/cc13x2x7_26x2x7/doc/programming-ccs.md b/examples/pump-app/cc13x2x7_26x2x7/doc/programming-ccs.md index ac31ab8bbea1f0..f56fc6057011c9 100644 --- a/examples/pump-app/cc13x2x7_26x2x7/doc/programming-ccs.md +++ b/examples/pump-app/cc13x2x7_26x2x7/doc/programming-ccs.md @@ -106,7 +106,7 @@ file) in the `Load Program` dialog. Click `OK` to begin loading the target. ![CCS step 9](images/ccs-12.jpg) -- After locating the source file for `main.cpp` we can step through the code +- After loacating the source file for `main.cpp` we can step through the code as it executes. ![CCS step 9](images/ccs-13.jpg) diff --git a/examples/pump-controller-app/cc13x2x7_26x2x7/doc/programming-ccs.md b/examples/pump-controller-app/cc13x2x7_26x2x7/doc/programming-ccs.md index ac31ab8bbea1f0..f56fc6057011c9 100644 --- a/examples/pump-controller-app/cc13x2x7_26x2x7/doc/programming-ccs.md +++ b/examples/pump-controller-app/cc13x2x7_26x2x7/doc/programming-ccs.md @@ -106,7 +106,7 @@ file) in the `Load Program` dialog. Click `OK` to begin loading the target. ![CCS step 9](images/ccs-12.jpg) -- After locating the source file for `main.cpp` we can step through the code +- After loacating the source file for `main.cpp` we can step through the code as it executes. ![CCS step 9](images/ccs-13.jpg) diff --git a/examples/tv-casting-app/linux/README.md b/examples/tv-casting-app/linux/README.md index 6eba225d7c8c3e..bd1d16dbcfe08d 100644 --- a/examples/tv-casting-app/linux/README.md +++ b/examples/tv-casting-app/linux/README.md @@ -3,7 +3,7 @@ This is a CHIP TV Casting app that can be used to cast content to a TV. This app discovers TVs on the local network that act as commissioners, lets the user select one, sends the TV a User Directed Commissioning request, enters -commissioning mode, advertises itself as a Commissionable Node and gets +commisioning mode, advertises itself as a Commissionable Node and gets commissioned. Then it allows the user to send CHIP ContentLauncher commands to the TV. diff --git a/examples/window-app/efr32/README.md b/examples/window-app/efr32/README.md index 79ad30072ff490..cdd98f67749c89 100644 --- a/examples/window-app/efr32/README.md +++ b/examples/window-app/efr32/README.md @@ -223,7 +223,7 @@ combination with JLinkRTTClient as follows: - _Blinking slowly_ ; The window cover is half-open, either by tilt, or lift - _Blinking quickly_ ; The window cover is being automatically open or closed - **Push Button 0** Increase either tilt or lift, and factory reset + **Push Button 0** Increase seither tilt or lift, and factory reset - Pressed and release: The lift/tilt increases by 10% @@ -240,9 +240,9 @@ combination with JLinkRTTClient as follows: **Push Button0 and Button1** Switch between lift and tilt - - Pressing and release both buttons at the same time: switches between lift and tilt modes. Most window covering types support either lift only, or tilt only, but type 0x08 support both (default) + - Pressing and release both buttons at the same time: switches between lift and tilt modes. Most window covering types support either lift only, or tilt only, but type 0x08 suport both (default) - - Pressing and hold both buttons at the same time: Cycles between window covering 1, and window covering 2. + - Pressing and hold both buttons at the same time: Cycles betwen window covering 1, and window covering 2. * Once the device is provisioned, it will join the Thread network is established, look for the RTT log @@ -274,7 +274,7 @@ combination with JLinkRTTClient as follows: The [Python Controller](https://github.com/project-chip/connectedhomeip/blob/master/src/controller/python/README.md) can now be used to send ZCL commands to the window covering device. For - instance, to set the window covering lift by percentage: + instance, to set the window covering lift by percentantage: $ sudo chip-device-ctrl diff --git a/scripts/tools/memory/README.md b/scripts/tools/memory/README.md index 9ccd4a2560813e..b2546ebe14dcdc 100644 --- a/scripts/tools/memory/README.md +++ b/scripts/tools/memory/README.md @@ -12,7 +12,7 @@ The following options are common to _most_ of the scripts, where applicable: - `--verbose`, `-v` Show informational messages; repeat for debugging messages. - `--config-file` _FILE_ Read configuration _FILE_. Typically this is a file - from the `platform/` subdirectory providing platform-specific option + from the `plaform/` subdirectory providing platform-specific option defaults. Command line options override the configuration file. ### input options: @@ -36,7 +36,7 @@ The following options are common to _most_ of the scripts, where applicable: ## output options: - `--output-file` _FILENAME_, `--output` _FILENAME_, `-O` _FILENAME_ Output - file. Defaults to standard output. For `csv` and `tsv` formats, this is + file. Defautls to standard output. For `csv` and `tsv` formats, this is actually an output file name prefix. - `--output-format` _FORMAT_, `--to` _FORMAT_, `-t` _FORMAT_ Output format. One of: diff --git a/src/README.md b/src/README.md index 5d25de7f39f6d4..edf63ac6ff9c88 100644 --- a/src/README.md +++ b/src/README.md @@ -26,6 +26,6 @@ The CHIP src directory is structured as follows: ##### Near Field Communication Tag Reading NFC Tag Reading is disabled by default because a paid Apple developer account is -required to have it enabled. If you want to enable it and you have a paid Apple +requird to have it enabled. If you want to enable it and you have a paid Apple developer account, go to the CHIPTool iOS target and turn on Near Field Communication Tag Reading under the Capabilities tab. diff --git a/src/platform/Linux/README.md b/src/platform/Linux/README.md index 0fcdb7ec14f26a..aa7178d4928bf0 100644 --- a/src/platform/Linux/README.md +++ b/src/platform/Linux/README.md @@ -35,7 +35,7 @@ code will have parallels in any new adaptation. - Concrete implementation of ThreadStackManager interface - Supports Thread stack initialization and core event loop processing - Relies on GenericThreadStackManagerImpl_OpenThread/POSIX<> classes to - implement most API functionality + implement most API functionaltiy `include/platform/Linux/BLEManagerImpl.h`
`Linux/BLEManagerImpl.cpp` diff --git a/src/platform/README.md b/src/platform/README.md index c6f0665b956bb5..cc68a9c32e5cfd 100644 --- a/src/platform/README.md +++ b/src/platform/README.md @@ -297,7 +297,7 @@ class ConfigurationManagerImpl final }; ``` -In many cases, the generic implementation base class itself will directly provide +In many cases, the generic implementation base class itself will directy provide some or all of the implementation methods needed to satisfy the component’s interface. The rules of C++ method resolution are such that calls to a forwarding method on the interface class are mapped directly to the base class diff --git a/src/platform/Zephyr/README.md b/src/platform/Zephyr/README.md index 280dd0a28c1902..c5acee50033579 100644 --- a/src/platform/Zephyr/README.md +++ b/src/platform/Zephyr/README.md @@ -27,7 +27,7 @@ code will have parallels in any new adaptation. - Concrete implementation of ThreadStackManager interface - Supports Thread stack initialization and core event loop processing - Relies on GenericThreadStackManagerImpl_OpenThread/POSIX<> classes to - implement most API functionality + implement most API functionaltiy `include/platform/Zephyr/BLEManagerImpl.h`
`Zephyr/BLEManagerImpl.cpp` diff --git a/src/platform/qpg/README.md b/src/platform/qpg/README.md index e6be8af7b457e5..723aefd1904351 100644 --- a/src/platform/qpg/README.md +++ b/src/platform/qpg/README.md @@ -34,7 +34,7 @@ will have parallels in any new adaptation. - Concrete implementation of ThreadStackManager interface - Supports Thread stack initialization and core event loop processing - Relies on GenericThreadStackManagerImpl_OpenThread/FreeRTOS/LwIP<> classes - to implement most API functionality + to implement most API functionaltiy `BLEManagerImpl.h`
`BLEManagerImpl.cpp` diff --git a/src/test_driver/esp32/README.md b/src/test_driver/esp32/README.md index 757a490f90caf9..0d53ff2d0d3f55 100644 --- a/src/test_driver/esp32/README.md +++ b/src/test_driver/esp32/README.md @@ -1,6 +1,6 @@ # CHIP Tests on Device -An application that runs CHIP's unit tests on ESP32 device or QEMU. +An appplication that runs CHIP's unit tests on ESP32 device or QEMU. --- diff --git a/src/test_driver/linux-cirque/README.md b/src/test_driver/linux-cirque/README.md index 11d2ce28f375df..bbe04047ea1743 100644 --- a/src/test_driver/linux-cirque/README.md +++ b/src/test_driver/linux-cirque/README.md @@ -47,7 +47,7 @@ You can run the tests by: scripts/tests/cirque_tests.sh run_all_tests ``` -You can get more information from the terminal output (like the location of +You can get more infomation from the terminal output (like the location of logs). > Note: The container (as well as the networks) will be preserved for debugging. @@ -74,7 +74,7 @@ The output of the test will be written to `stdout` and `stderr`. ## Specify log directory -To specify log directory, simply set `LOG_DIR` variable. +To specify log directory, simplily set `LOG_DIR` variable. ``` export LOG_DIR=/some/log/directory @@ -131,5 +131,5 @@ It will print the container id in log, you can execute commands inside them. After you finished you test, press `Ctrl-C` and it will clean up testing environment. -Refer to `test-manual.py`, `ManualTest.sh`, and topologies file under +Refer to `test-manual.py`, `ManualTest.sh`, and tolologies file under `topologies` for detail.