summaryrefslogtreecommitdiff
path: root/README.md
Commit message (Collapse)AuthorAgeFilesLines
* cr50/README.md: Use futility over obsolete scriptEdward O'Callaghan2023-02-151-1/+1
| | | | | | | | | | | | | | | | | | | | BUG=b:260531154 BRANCH=none TEST=none Change-Id: I9e9cb4aadb7b59d7d1f64847d3e4852ca15f5b9e Signed-off-by: Edward O'Callaghan <quasisec@google.com> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/4160818 Tested-by: Edward O'Callaghan <quasisec@chromium.org> Reviewed-by: Peter Marheine <pmarheine@chromium.org> Code-Coverage: Zoss <zoss-cl-coverage@prod.google.com> Commit-Queue: Peter Marheine <pmarheine@chromium.org> Auto-Submit: Edward O'Callaghan <quasisec@chromium.org> Reviewed-by: Evan Benn <evanbenn@chromium.org> (cherry picked from commit 611a9ab148c8a56dbdbc4e2844a74fcbe63b0457) Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/4253167 Commit-Queue: Andrey Pronin <apronin@chromium.org> Reviewed-by: Andrey Pronin <apronin@chromium.org>
* Update header templates/examplesAlex Klein2022-07-291-1/+1
| | | | | | | | | | | | | | ChromiumOS instead of Chromium OS and drop "All rights reserved.". BUG=b:230609017 TEST=None Change-Id: I55bf56261a7695a5b52ce61b46d6fb2695495d87 Signed-off-by: Alex Klein <saklein@google.com> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3791656 Commit-Queue: Mary Ruthven <mruthven@chromium.org> Reviewed-by: Mary Ruthven <mruthven@chromium.org> Tested-by: Mary Ruthven <mruthven@chromium.org>
* coil: use links to the main branch in docsMary Ruthven2021-01-061-9/+9
| | | | | | | | | | BUG=b:175244613 TEST=make buildall -j Change-Id: I70b2374985aeefb3550e529dcdc53a9ab2fffecb Signed-off-by: Mary Ruthven <mruthven@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2613453 Reviewed-by: Namyoon Woo <namyoon@chromium.org>
* docs: update link to host commands documentationHarry Cutts2019-11-061-1/+1
| | | | | | | | | | | | | | The Google Sites version was deprecated when https://crrev.com/c/1807964 was submitted. BRANCH=none BUG=none TEST=Check the rendering in Gitiles Change-Id: I440ae76501a4eb747e4a2e4550c192565c3c6717 Signed-off-by: Harry Cutts <hcutts@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1900666 Reviewed-by: Aseda Aboagye <aaboagye@chromium.org>
* docs: change docs finding EC consoleMary Ruthven2019-09-201-1/+1
| | | | | | | | | | | BUG=none BRANCH=none TEST=none Change-Id: I62b04adf970abf5534d5ce6c7630f6b09749222c Signed-off-by: Mary Ruthven <mruthven@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1816305 Reviewed-by: Aseda Aboagye <aaboagye@chromium.org>
* doc: Update EC termsKeith Short2019-08-211-0/+3
| | | | | | | | | | | | | | Add more EC definitions. Correct the named anchors in the USB-C markdown. And a link from the main EC readme. BUG=none BRANCH=none TEST=none Change-Id: Ica7e7c270373589d850166539fb1b13b1ddbd7e0 Signed-off-by: Keith Short <keithshort@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1758826 Reviewed-by: Edward Hill <ecgh@chromium.org>
* docs: Add fingerprint (FPMCU) docsTom Hughes2019-08-061-170/+17
| | | | | | | | | | | | | | BRANCH=none BUG=chromium:973205 TEST=make buildall -j TEST=View Markdown Preview in CLion TEST=View Markdown in gitiles Change-Id: I64c6060bdf41f69af05a8ffd64d437fb1fd2b507 Signed-off-by: Tom Hughes <tomhughes@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1658525 Reviewed-by: Aseda Aboagye <aaboagye@chromium.org> Commit-Queue: Aseda Aboagye <aaboagye@chromium.org>
* Improve unit test and fuzzer documentation storyCraig Hesling2019-07-201-3/+15
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Update **test** directory description to README.md. * Add ** fuzz** directory description to README.md. * Add unit test and fuzzer make targets to `make help` * Change showboards to print-boards to be more consistent * Change showboards to use auto pretty print * Add print-tests, print-host-tests, and print-host-fuzzers This is necessary to remove the ambiguity about what a special name is for a given unit test. Documentation Story: The idea is to give a brief overview of what the test and fuzz directories are in README.md. README.md also mentions you should see `make help` for more detail. Running `make help` shows you more general test/fuzz commands, including the print-* commands. Running the print-* commands show you exact target names for all possible unit/fuzz test (both the build-only and run target names). BRANCH=none BUG=none TEST=make help TEST=make print-tests TEST=make print-host-tests TEST=make print-host-fuzzers TEST=make print-host-fuzzers | cat TEST=make print-boards TEST=make print-boards | cat TEST=make buildall -j Change-Id: I34b68196ac635ba71a1d45ceb5d35a3b36fd129f Signed-off-by: Craig Hesling <hesling@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1684714 Reviewed-by: Aseda Aboagye <aaboagye@chromium.org> Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org>
* Don't refer to specific MCUs in the README introHarry Cutts2019-07-091-5/+1
| | | | | | | | | | | | | | | | | | | | This statement seems pretty out-of-date, and keeping it up-to-date isn't going to be worthwhile, so just make it more generic. (This is the same change as was made in revision #41 of the sites page before it was migrated [0], but it seems the Markdown migration took the version before.) [0]: https://sites.google.com/a/chromium.org/dev/system/app/pages/admin/compare?wuid=wuid:gx:3ac9dfd5b19509d3&rev1=41&rev2=40 BRANCH=none BUG=none TEST=none Change-Id: I0570b719af6699b4467309fccd312e1be68d6f14 Signed-off-by: Harry Cutts <hcutts@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1693335 Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org>
* docs: Update READMETom Hughes2019-06-121-0/+781
Converted the documentation in http://dev.chromium.org/chromium-os/ec-development to Markdown with go/gdc. I made minor cleanups to the Markdown after the conversion due to bugs in the formatting, but preserved the content/text. It's known that this documentation is out of date, but I wanted to preserve the history, so updates to the context/text should be made after this commit. BRANCH=none BUG=chromium:973205 TEST=make buildall -j TEST=View Markdown Preview in CLion TEST=View Markdown in gitiles Change-Id: Ifdb2494f0f82b7226c1c77925e6a03656e604d14 Signed-off-by: Tom Hughes <tomhughes@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1653597 Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org>