Skip to content

Commit

Permalink
Merge branch 'master' into updateUI
Browse files Browse the repository at this point in the history
  • Loading branch information
jeonghwan7 authored Jan 18, 2023
2 parents 7cc2737 + 808b9fe commit bb5a317
Show file tree
Hide file tree
Showing 35 changed files with 286 additions and 348 deletions.
12 changes: 10 additions & 2 deletions .github/workflows/docbuild.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
name: Documentation Build

on:
pull_request:
types: [opened, synchronize, reopened]
branches:
- master
paths:
- '.github/workflows/docbuild.yaml'
- '**.md'
- 'docs/**'
push:
branches:
- master
Expand All @@ -9,7 +17,7 @@ permissions:
contents: write

jobs:
build-and-deploy:
build-and-publish:
runs-on: ubuntu-latest

steps:
Expand Down Expand Up @@ -39,7 +47,7 @@ jobs:
make html
touch _build/html/.nojekyll
- name: Deploy to gh-pages
if: github.repository == 'project-chip/connectedhomeip'
if: github.repository == 'project-chip/connectedhomeip' && github.event_name == 'push' && github.ref_name == 'master'
uses: peaceiris/actions-gh-pages@v3
with:
deploy_key: ${{ secrets.DOXYGEN_DEPLOY_KEY }}
Expand Down
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?= -W -c . -d _build/doctrees
SPHINXOPTS ?= -W --keep-going -c . -d _build/doctrees
SPHINXBUILD ?= sphinx-build
SOURCEDIR = _build/src
BUILDDIR = _build
Expand Down
31 changes: 31 additions & 0 deletions docs/guides/BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -390,6 +390,37 @@ gn desc out/host //src/lib outputs
gn desc out/host //src/lib --format=json
```

## Coverage

Code coverage scripts generate a report that details how much of the Matter SDK
source code has been executed, it also gives information on how often the Matter
SDK executes segments of code and produces a copy of the source file, annotated
with execution frequencies.

```
./scripts/build_coverage.sh
```

By default, Code coverage is performed at the unit testing level. Unit tests are
created by developers, thus giving them the best vantage from which to decide
what tests to include in unit testing. But you can extend the coverage test by
scope and ways of execution with the following parameters:

```
-c, --code Specify which scope to collect coverage data.
'core': collect coverage data from core stack in Matter SDK. --default
'clusters': collect coverage data from clusters implementation in Matter SDK.
'all': collect coverage data from Matter SDK.
-t, --tests Specify which tools to run the coverage check.
'unit': Run unit test to drive the coverage check. --default
'yaml': Run yaml test to drive the coverage check.
'all': Run unit & yaml test to drive the coverage check.
```

Also see the up-to-date unit testing coverage report of the Matter SDK
(collected daily) at:
[matter coverage](https://matter-build-automation.ue.r.appspot.com).

## Maintaining Matter

If you make any change to the GN build system, the next build will regenerate
Expand Down
7 changes: 7 additions & 0 deletions examples/light-switch-app/nrfconnect/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,13 @@ config CHIP_ENABLE_SLEEPY_END_DEVICE_SUPPORT

endif # NET_L2_OPENTHREAD

if CHIP_WIFI

config NRF_WIFI_LOW_POWER
default y

endif # CHIP_WIFI

rsource "../../../config/nrfconnect/chip-module/Kconfig.features"
rsource "../../../config/nrfconnect/chip-module/Kconfig.defaults"
source "Kconfig.zephyr"
16 changes: 2 additions & 14 deletions examples/light-switch-app/silabs/SiWx917/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,6 @@ An example showing the use of CHIP on the Silicon Labs EFR32 MG12 and MG24.
> release with added tools and documentation.
> [Silabs Matter Github](https://github.com/SiliconLabs/matter/releases)
<a name="intro"></a>

## Introduction

The EFR32 light switch example provides a baseline demonstration of a on-off
Expand All @@ -53,8 +51,6 @@ The light switch example is intended to serve both as a means to explore the
workings of Matter as well as a template for creating real products based on the
Silicon Labs platform.

<a name="building"></a>

## Building

- Download the
Expand Down Expand Up @@ -181,15 +177,13 @@ Silicon Labs platform.
$ gn gen out/debug --args='import("//with_pw_rpc.gni")'
$ ninja -C out/debug

[Running Pigweed RPC console](#running-pigweed-rpc-console)
[Running Pigweed RPC console](#running-rpc-console)

For more build options, help is provided when running the build script without
arguments

./scripts/examples/gn_efr32_example.sh

<a name="flashing"></a>

## Flashing the Application

- On the command line:
Expand All @@ -199,8 +193,6 @@ arguments

- Or with the Ozone debugger, just load the .out file.

<a name="view-logging"></a>

## Viewing Logging Output

The example application is built to use the SEGGER Real Time Transfer (RTT)
Expand Down Expand Up @@ -249,8 +241,6 @@ combination with JLinkRTTClient as follows:

$ JLinkRTTClient

<a name="running-complete-example"></a>

## Running the Complete Example

- It is assumed here that you already have an OpenThread border router
Expand Down Expand Up @@ -385,8 +375,6 @@ combination with JLinkRTTClient as follows:
#Add Ipv6 route on PC(Linux) \$ sudo ip route add <Thread global ipv6 prefix>/64
via 2002::2
<a name="running-pigweed-rpc-console"></a>
## Running RPC console
- As part of building the example with RPCs enabled the chip_rpc python
Expand Down Expand Up @@ -432,7 +420,7 @@ tracking code inside the `trackAlloc` and `trackFree` function
For the description of Software Update process with EFR32 example applications
see
[EFR32 OTA Software Update](../../../docs/guides/silabs_efr32_software_update.md)
[EFR32 OTA Software Update](../../../../docs/guides/silabs_efr32_software_update.md)
## Building options
Expand Down
7 changes: 7 additions & 0 deletions examples/lock-app/nrfconnect/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,13 @@ config CHIP_ENABLE_SLEEPY_END_DEVICE_SUPPORT

endif # NET_L2_OPENTHREAD

if CHIP_WIFI

config NRF_WIFI_LOW_POWER
default y

endif # CHIP_WIFI

rsource "../../../config/nrfconnect/chip-module/Kconfig.features"
rsource "../../../config/nrfconnect/chip-module/Kconfig.defaults"
source "Kconfig.zephyr"
14 changes: 1 addition & 13 deletions examples/lock-app/silabs/SiWx917/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@ An example showing the use of CHIP on the Silicon Labs EFR32 MG12 and MG24.
> release with added tools and documentation.
> [Silabs Matter Github](https://github.com/SiliconLabs/matter/releases)
<a name="intro"></a>

## Introduction

The EFR32 lock example provides a baseline demonstration of a door lock control
Expand All @@ -48,8 +46,6 @@ The lighting example is intended to serve both as a means to explore the
workings of Matter as well as a template for creating real products based on the
Silicon Labs platform.

<a name="building"></a>

## Building

- Download the
Expand Down Expand Up @@ -189,17 +185,13 @@ Mac OS X
$ ninja -C out/debug
```

[Running Pigweed RPC console](#running-pigweed-rpc-console)

For more build options, help is provided when running the build script without
arguments

```
./scripts/examples/gn_efr32_example.sh
```

<a name="flashing"></a>

## Flashing the Application

- On the command line:
Expand All @@ -211,8 +203,6 @@ arguments

- Or with the Ozone debugger, just load the .out file.

<a name="view-logging"></a>

## Viewing Logging Output

The example application is built to use the SEGGER Real Time Transfer (RTT)
Expand Down Expand Up @@ -271,8 +261,6 @@ combination with JLinkRTTClient as follows:
$ JLinkRTTClient
```

<a name="running-complete-example"></a>

## Running the Complete Example

- It is assumed here that you already have an OpenThread border router
Expand Down Expand Up @@ -413,7 +401,7 @@ tracking code inside the `trackAlloc` and `trackFree` function

For the description of Software Update process with EFR32 example applications
see
[EFR32 OTA Software Update](../../../docs/guides/silabs_efr32_software_update.md)
[EFR32 OTA Software Update](../../../../docs/guides/silabs_efr32_software_update.md)

## Building options

Expand Down
16 changes: 1 addition & 15 deletions examples/window-app/silabs/SiWx917/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,6 @@ An example showing the use of CHIP on the Silicon Labs EFR32 MG12 and MG24.
> release with added tools and documentation.
> [Silabs Matter Github](https://github.com/SiliconLabs/matter/releases)
<a name="intro"></a>

## Introduction

The EFR32 window-covering example provides a baseline demonstration of a Window
Expand All @@ -48,8 +46,6 @@ The window-covering example is intended to serve both as a means to explore the
workings of Matter as well as a template for creating real products based on the
Silicon Labs platform.

<a name="building"></a>

## Building

- Download the
Expand Down Expand Up @@ -145,15 +141,11 @@ Silicon Labs platform.
$ gn gen out/debug --args='import("//with_pw_rpc.gni")'
$ ninja -C out/debug

[Running Pigweed RPC console](#running-pigweed-rpc-console)

For more build options, help is provided when running the build script without
arguments

./scripts/examples/gn_efr32_example.sh

<a name="flashing"></a>

## Flashing the Application

- On the command line:
Expand All @@ -163,8 +155,6 @@ arguments

- Or with the Ozone debugger, just load the .out file.

<a name="view-logging"></a>

## Viewing Logging Output

The example application is built to use the SEGGER Real Time Transfer (RTT)
Expand Down Expand Up @@ -213,8 +203,6 @@ combination with JLinkRTTClient as follows:

$ JLinkRTTClient

<a name="running-complete-example"></a>

## Running the Complete Example

- It is assumed here that you already have an OpenThread border router
Expand Down Expand Up @@ -344,13 +332,11 @@ combination with JLinkRTTClient as follows:
# Add Ipv6 route on PC (Linux)
$ sudo ip route add <Thread global ipv6 prefix>/64 via 2002::2
<a name="running-pigweed-rpc-console"></a>
## OTA Software Update
For the description of Software Update process with EFR32 example applications
see
[EFR32 OTA Software Update](../../../docs/guides/silabs_efr32_software_update.md)
[EFR32 OTA Software Update](../../../../docs/guides/silabs_efr32_software_update.md)
## Building options
Expand Down
2 changes: 1 addition & 1 deletion integrations/docker/images/build-all.sh
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
# https://github.com/project-chip/connectedhomeip/issues/710
#
set -e
find "$(git rev-parse --show-toplevel)"/integrations/docker/images/ -name Dockerfile ! -path "*chip-cert-bins/*" ! -path "*chip-build-remote-builder/*" | while read -r dockerfile; do
find "$(git rev-parse --show-toplevel)"/integrations/docker/images/ -name Dockerfile ! -path "*chip-cert-bins/*" | while read -r dockerfile; do
pushd "$(dirname "$dockerfile")" >/dev/null
./build.sh "$@"
popd >/dev/null
Expand Down

This file was deleted.

24 changes: 0 additions & 24 deletions integrations/docker/images/chip-build-remote-builder/README.md

This file was deleted.

23 changes: 0 additions & 23 deletions integrations/docker/images/chip-build-remote-builder/build.sh

This file was deleted.

This file was deleted.

Loading

0 comments on commit bb5a317

Please sign in to comment.