Google Git
Sign in
chromium / chromiumos / docs / refs/heads/release-R85-13310.B
commit4db9d1465f283d14919fc18ab5bea69f7c7078a1[log] [tgz]
authorFergus Dall <sidereal@google.com>Mon Jun 22 04:01:07 2020
committerCommit Bot <commit-bot@chromium.org>Wed Jun 24 08:39:13 2020
treebfbbb7ba935c9442f98a19977263766d9496a461
parentaf7edf3e6e334c93ef975e1e7d1aabbdb80d6f59 [diff]
crostini_developer_guide: explain how to run binaries on a desktop

It's possible to run binaries built for the termina VM inside the
chrome OS chroot, which can be useful for e.g. attaching a debugger.

Change-Id: I26353f6d21c22df80a613c912ab2ffe78c25a4ec
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/docs/+/2256629
Commit-Queue: Fergus Dall <sidereal@google.com>
Tested-by: Fergus Dall <sidereal@google.com>
Reviewed-by: David Munro <davidmunro@google.com>
1 file changed
tree: bfbbb7ba935c9442f98a19977263766d9496a461
  1. constants/
  2. design_docs/
  3. firmware/
  4. images/
  5. packages/
  6. portage/
  7. scripts/
  8. security/
  9. styleguide/
  10. testing/
  11. .gitignore
  12. adding_builder_variants.md
  13. archive_mirrors.md
  14. ca_certs.md
  15. chrome_commit_pipeline.md
  16. chromeos_gn.md
  17. contact.md
  18. containers_and_vms.md
  19. contributing.md
  20. cros_commit_pipeline.md
  21. cros_flash.md
  22. cros_tools.md
  23. cros_vm.md
  24. crostini_developer_guide.md
  25. dbus_best_practices.md
  26. dbus_in_chrome.md
  27. debug_buttons.md
  28. developer_guide.md
  29. developer_mode.md
  30. development_basics.md
  31. eol_aue_process.md
  32. firmware_code_reviews.md
  33. firmware_test_manual.md
  34. git_and_gerrit_intro.md
  35. glossary.md
  36. gsutil.md
  37. kernel_faq.md
  38. kernel_tips_and_tricks.md
  39. lsb-release.md
  40. navbar.md
  41. os_config.md
  42. OWNERS
  43. pd_firmware_update.md
  44. platform2_primer.md
  45. PRESUBMIT.cfg
  46. programming_languages.md
  47. README.md
  48. remote_trybots.md
  49. repo-tool.md
  50. reporting_bugs.md
  51. rust_on_cros.md
  52. sandboxing.md
  53. security_review_howto.md
  54. security_severity_guidelines.md
  55. simple_chrome_workflow.md
  56. source_layout.md
  57. stack_traces.md
  58. test_install_configuration.md
  59. work_on_branch.md
  60. write_protection.md
  61. 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.