Google Git
Sign in
chromium / chromiumos / docs / HEAD
commit928352e86f273a478c1d1ec14d628812283b248b[log] [tgz]
authorAchuith Bhandarkar <achuith@chromium.org>Thu Jan 16 20:20:59 2020
committerCommit Bot <commit-bot@chromium.org>Thu Jan 16 23:48:59 2020
treee96ad2809fa9562a2ca087452a8d70b3c7a8de9a
parent56523b5d5fce55a8e183fd6eb7d181f6528864fe [diff]
simple_chrome: Update doc with cros flash.

cros flash in the simple chrome SDK can now handle xbuddy links and can
update test images over SSH. With Xbuddy support, there's no reason
to futz with Goldeneye, or with a ChromeOS chroot.

BUG=chromium:403086
TEST=None

Change-Id: Ia166edb00e46bb0f90ab7c6ac56602491e90b783
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/docs/+/2005568
Reviewed-by: Steven Bennetts <stevenjb@chromium.org>
Commit-Queue: Achuith Bhandarkar <achuith@chromium.org>
Tested-by: Achuith Bhandarkar <achuith@chromium.org>
1 file changed
tree: e96ad2809fa9562a2ca087452a8d70b3c7a8de9a
  1. .gitignore
  2. OWNERS
  3. PRESUBMIT.cfg
  4. README.md
  5. archive_mirrors.md
  6. ca_certs.md
  7. chrome_commit_pipeline.md
  8. chromeos_gn.md
  9. constants/
  10. contact.md
  11. containers_and_vms.md
  12. contributing.md
  13. cros_commit_pipeline.md
  14. cros_flash.md
  15. cros_tools.md
  16. cros_vm.md
  17. dbus_best_practices.md
  18. dbus_in_chrome.md
  19. debug_buttons.md
  20. design_docs/
  21. developer_guide.md
  22. developer_mode.md
  23. development_basics.md
  24. eol_aue_process.md
  25. firmware_test_manual.md
  26. git_and_gerrit_intro.md
  27. glossary.md
  28. gsutil.md
  29. images/
  30. kernel_faq.md
  31. kernel_tips_and_tricks.md
  32. lsb-release.md
  33. navbar.md
  34. os_config.md
  35. packages/
  36. platform2_primer.md
  37. portage/
  38. remote_trybots.md
  39. reporting_bugs.md
  40. rust_on_cros.md
  41. sandboxing.md
  42. scripts/
  43. security/
  44. security_review_howto.md
  45. security_severity_guidelines.md
  46. simple_chrome_workflow.md
  47. source_layout.md
  48. styleguide/
  49. testing/
  50. work_on_branch.md
  51. write_protection.md
  52. xbuddy.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.

See the Contributing guide for more details.

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
cd docs
curl -Lo .git/hooks/commit-msg https://gerrit-review.googlesource.com/tools/hooks/commit-msg
chmod +x .git/hooks/commit-msg
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 which utilizes Gerrit sandbox branches:

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
./src/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.