doc: update CHIP name in tool guides

Updated CHIP to Matter in tool guides. Updated structure of the Android guide. Signed-off-by: Grzegorz Ferenc <[email protected]>
project-chip · Oct 18, 2021 · 5349603 · 5349603
1 parent 5127931
commit 5349603
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 33 deletions.
diff --git a/docs/guides/android_building.md b/docs/guides/android_building.md
@@ -3,13 +3,14 @@
 There are following Apps on Android
 
 -   CHIPTool - Android CHIPTool is an application for Android for commissioning
-    and controlling CHIP accessory devices. It offers the following features: -
-    Scan a CHIP QR code and display payload information to the user - Read the
-    NFC tag containing CHIP onboarding information - Commission a CHIP device -
-    Send echo requests to the CHIP echo server - Send on/off cluster requests to
-    a CHIP device
+    and controlling Matter accessory devices. It offers the following features:
+    - Scan a Matter QR code and display payload information to the user
+    - Read the NFC tag containing Matter onboarding information
+    - Commission a Matter device
+    - Send echo requests to the Matter echo server
+    - Send on/off cluster requests to a Matter device
 -   CHIPTest
-    -   Android CHIPTest is an application for Android for running CHIP's unit
+    -   Android CHIPTest is an application for Android for running Matter's unit
         tests
 
 <hr>
@@ -20,6 +21,7 @@ There are following Apps on Android
 -   [Preparing for build](#preparing)
 -   [Building Android CHIPTool from scripts](#building-scripts)
 -   [Building Android CHIPTool from Android Studio](#building-studio)
+-   [Building Android CHIPTest from scripts](#building-chiptest-scripts)
 
 <hr>
 
@@ -61,9 +63,9 @@ architecture:
 
 ## Preparing for build
 
-Complete the following steps to prepare the CHIP build:
+Complete the following steps to prepare the Matter build:
 
-1. Check out the CHIP repository.
+1. Check out the Matter repository.
 
 2. Run bootstrap (**only required first time**)
 
@@ -76,11 +78,7 @@ Complete the following steps to prepare the CHIP build:
 
 <a name="building-scripts"></a>
 
-## Building Android CHIPTool
-
-<a name="chiptool_scripts_build"></a>
-
-### From scripts
+## Building Android CHIPTool from scripts
 
 This is the simplest option. In the command line, run the following command from
 the top CHIP directory:
@@ -100,17 +98,17 @@ adb install out/android-$TARGET_CPU-chip-tool/outputs/apk/debug/app-debug.apk
 ```
 
 You can use Android Studio to edit the Android CHIPTool app itself and run it
-after build_examples.py, but you will not be able to edit CHIP Android code from
-`src/controller/java`, or other CHIP C++ code within Android Studio.
+after build_examples.py, but you will not be able to edit Matter Android code from
+`src/controller/java`, or other Matter C++ code within Android Studio.
 
 <a name="building-studio"></a>
 
-### From Android Studio
+## Building Android CHIPTool from Android Studio
 
-This option allows Android Studio to build the core CHIP code from source, which
-allows us to directly edit core CHIP code in-IDE.
+This option allows Android Studio to build the core Matter code from source, which
+allows us to directly edit core Matter code in-IDE.
 
-1. In the command line, run the following command from the top CHIP directory:
+1. In the command line, run the following command from the top Matter directory:
 
     ```shell
     TARGET_CPU=arm64 ./scripts/examples/android_app_ide.sh
@@ -149,11 +147,12 @@ or
 (cd src/android/CHIPTool && ./gradlew installDebug)
 ```
 
-## Building Android CHIPTest
+<a name="building-chiptest-scripts"></a>
 
-### From scripts
+## Building Android CHIPTest from scripts
 
-The steps are similar with [CHIPTool scripts build](#chiptool_scripts_build)
+Currently, the CHIPTest can only be built from scripts.
+The steps are similar to [building CHIPTool from scripts](#building-scripts).
 
 ```shell
 ./scripts/build/build_examples.py --target android-arm64-chip-test build
@@ -162,7 +161,3 @@ The steps are similar with [CHIPTool scripts build](#chiptool_scripts_build)
 You can modify the `matterUTestLib` variable to the test lib in
 [src/android/CHIPTest/gradle.properties](https://github.com/project-chip/connectedhomeip/blob/master/src/android/CHIPTest/gradle.properties)
 to change target to test.
-
-### From Android Studio
-
-Not supported yet
diff --git a/docs/guides/python_chip_controller_advanced_usage.md b/docs/guides/python_chip_controller_advanced_usage.md
@@ -2,7 +2,7 @@
 
 This document extends the
 [basic documentation](python_chip_controller_building.md) of the Python CHIP
-Controller with the useful information when developing Python CHIP controller
+Controller with the useful information when developing Python CHIP Controller
 tool or Matter accessories on Linux.
 
 <hr>
@@ -79,7 +79,7 @@ interfaces working as Bluetooth LE central and peripheral, respectively.
 ## Debugging with gdb
 
 You can run the chip-device-ctrl under GDB for debugging, however, since the
-CHIP core support library is a dynamic library, you cannot read the symbols
+Matter core support library is a dynamic library, you cannot read the symbols
 unless it is fully loaded.
 
 The following block is a example debug session using GDB:
@@ -116,8 +116,8 @@ suppress thread related outputs first by running the following command:
 (gdb) set print thread-events off
 ```
 
-We cannot set breakpoints here, since the GDB knows nothing about the CHIP
-library, let run the CHIP device controller first.
+We cannot set breakpoints here, since the GDB knows nothing about the Matter
+library, let run the Matter device controller first.
 
 ```
 (gdb) run
@@ -140,8 +140,8 @@ Chip Device Controller Shell
 chip-device-ctrl >
 ```
 
-The prompt `chip-device-ctrl >` indicates that the CHIP core library is loaded
-by Python, you can browse the symbols in the CHIP core library, setting
+The prompt `chip-device-ctrl >` indicates that the Matter core library is loaded
+by Python, you can browse the symbols in the Matter core library, setting
 breakpoints on functions and many other functions provided by GDB.
 
 You can use `Ctrl-C` to send SIGINT to the controller anytime you want so you

diff --git a/docs/guides/python_chip_controller_building.md b/docs/guides/python_chip_controller_building.md
@@ -1,6 +1,6 @@
 # Working with Python CHIP Controller
 
-The Python CHIP controller is a tool that allows to commission a Matter device
+The Python CHIP Controller is a tool that allows to commission a Matter device
 into the network and to communicate with it using the Zigbee Cluster Library
 (ZCL) messages.