Google Git
Sign in
chromium / chromiumos / docs / 5386c95b172b50a381ce4ec749c0538712979b76
commit5386c95b172b50a381ce4ec749c0538712979b76[log] [tgz]
authorMike Frysinger <vapier@chromium.org>Wed Aug 01 17:57:29 2018
committerchrome-bot <chrome-bot@chromium.org>Sat Aug 04 23:17:57 2018
tree2e6f0c1696a9a4216309e079774599b5c0444ebf
parent6f968e98e8dd83b6aa703a7145b569cec821e0fe [diff]
containers_and_vms: add newer supported devices to the list

Change-Id: I1b1833e1766ec243cd43d00d5359a0f4e0c1a56e
Reviewed-on: https://chromium-review.googlesource.com/1158969
Commit-Ready: Mike Frysinger <vapier@chromium.org>
Tested-by: Mike Frysinger <vapier@chromium.org>
Reviewed-by: Dylan Reid <dgreid@chromium.org>
1 file changed
tree: 2e6f0c1696a9a4216309e079774599b5c0444ebf
  1. scripts/
  2. ca_certs.md
  3. chrome_commit_pipeline.md
  4. COMMIT-QUEUE.ini
  5. containers_and_vms.md
  6. cros_commit_pipeline.md
  7. cros_vm.md
  8. dbus_best_practices.md
  9. dbus_in_chrome.md
  10. developer_guide.md
  11. development_basics.md
  12. fuzzing.md
  13. navbar.md
  14. PRESUBMIT.cfg
  15. README.md
  16. reporting_bugs.md
  17. rust_on_cros.md
  18. sandboxing.md
  19. security_review_howto.md
  20. security_severity_guidelines.md
  21. simple_chrome_workflow.md
  22. unit_tests.md
README.md

Chromium OS docs

This directory contains public Chromium OS project documentation that is automatically rendered by Gitiles. The docs are written in Gitiles-flavored Markdown.

General guidelines

See the Chromium documentation guidelines and Chromium documentation best practices.

Style guide

Markdown documents must follow the style guide.

Making changes

This repository is managed by the repo tool, so you can make changes to it using the same techniques that you'd use for any other repositories in the project. Feel free to bypass the commit queue and commit changes immediately after they are reviewed.

Making changes without repo

You can also make changes to this repository without using the repo tool. This comes in handy when you don't have a Chromium OS checkout:

git clone https://chromium.googlesource.com/chromiumos/docs
curl -Lo .git/hooks/commit-msg https://gerrit-review.googlesource.com/tools/hooks/commit-msg
chmod +x .git/hooks/commit-msg
cd docs
git checkout -b changes
(make some changes)
git commit -a
git push origin HEAD:refs/for/master

The above steps will upload a patch to chromium-review.googlesource.com where you can get your patch reviewed, and submit.

Previewing changes

You can preview your local changes using scripts/preview_docs:

scripts/preview_docs README.md

You can also use md_browser, which is entirely local and does not require refs/sandbox/ push permission, but has somewhat inaccurate rendering:

# at top of Chromium OS checkout
./chromium/src/tools/md_browser/md_browser.py -d docs

Then browse to e.g. http://localhost:8080/README.md.

To review someone else's changes, apply them locally first, or just click the gitiles link near the top of a Gerrit file diff page.