Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[shell] Add documentation for CHIP shell commands. #1596

Merged
merged 1 commit into from
Jul 14, 2020

Conversation

turon
Copy link
Contributor

@turon turon commented Jul 14, 2020

Problem

The example shell app doesn't document what commands are available.

Summary of Changes

Add some docs!

These MD files can be viewed as rendered by github here: https://github.com/turon/connectedhomeip/blob/pr/shell/readme/examples/shell/README.md

@turon turon force-pushed the pr/shell/readme branch from 812a687 to f813cb6 Compare July 14, 2020 19:57
@turon turon force-pushed the pr/shell/readme branch 2 times, most recently from a7ee339 to 188328d Compare July 14, 2020 20:02
@turon turon force-pushed the pr/shell/readme branch from 188328d to de0ef2c Compare July 14, 2020 20:27
@github-actions
Copy link

Size increase report for "gn_nrf-example-build"

File Section File VM
Full report output
BLOAT REPORT

Files found only in the build output:
    report.csv


@github-actions
Copy link

Size increase report for "gn_linux-example-build"

File Section File VM
Full report output
BLOAT REPORT

Files found only in the build output:
    report.csv


@github-actions
Copy link

Size increase report for "nrf-example-build"

File Section File VM
Full report output
BLOAT REPORT

Files found only in the build output:
    report.csv

Comparing ./master_artifact/chip-nrf52840-lock-example.out and ./pull_artifact/chip-nrf52840-lock-example.out:

sections,vmsize,filesize


@github-actions
Copy link

Size increase report for "linux-example-build"

File Section File VM
Full report output
BLOAT REPORT

Files found only in the build output:
    report.csv

Comparing ./master_artifact/chip-standalone-demo.out and ./pull_artifact/chip-standalone-demo.out:

sections,vmsize,filesize


@github-actions
Copy link

Size increase report for "esp32-example-build"

File Section File VM
Full report output
BLOAT REPORT

Files found only in the build output:
    report.csv

Comparing ./master_artifact/chip-wifi-echo.elf and ./pull_artifact/chip-wifi-echo.elf:

sections,vmsize,filesize


@andy31415 andy31415 merged commit 899de40 into project-chip:master Jul 14, 2020
@turon turon deleted the pr/shell/readme branch July 14, 2020 21:48
kedars pushed a commit to kedars/connectedhomeip that referenced this pull request Jul 19, 2020
kedars pushed a commit to kedars/connectedhomeip that referenced this pull request Jul 19, 2020
kedars pushed a commit to kedars/connectedhomeip that referenced this pull request Jul 19, 2020
kedars pushed a commit to kedars/connectedhomeip that referenced this pull request Jul 21, 2020
kedars pushed a commit to kedars/connectedhomeip that referenced this pull request Jul 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants