sandboxing: add section on finding failing syscalls

I suspect this is a very common problem to have, so putting it in its
own section should make it easier to find, compared to being mixed in to
the variety of troubleshooting tips. I've also made some of the steps a
bit more explicit, thanks to help from dverkamp@.

BUG=none
TEST=check gitiles rendering

Change-Id: Ib2d3fd09a3b8c09ed12f27b8ae8178617affaf1a
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/docs/+/3379763
Reviewed-by: Mike Frysinger <vapier@chromium.org>
Commit-Queue: Harry Cutts <hcutts@chromium.org>
Tested-by: Harry Cutts <hcutts@chromium.org>
1 file changed
tree: 4421c5dbb7e9dddf97020729cfd5cc31aa2c1790
  1. constants/
  2. design_docs/
  3. firmware/
  4. images/
  5. manatee/
  6. packages/
  7. portage/
  8. scripts/
  9. security/
  10. styleguide/
  11. testing/
  12. .gitignore
  13. adding_builder_variants.md
  14. archive_mirrors.md
  15. breakages_and_flakes.md
  16. ca_certs.md
  17. chrome_commit_pipeline.md
  18. chromeos_gn.md
  19. chroot-clangd-guide.md
  20. contact.md
  21. containers_and_vms.md
  22. contributing.md
  23. cros_commit_pipeline.md
  24. cros_deploy.md
  25. cros_flash.md
  26. cros_tools.md
  27. cros_vm.md
  28. crostini_developer_guide.md
  29. dbus_best_practices.md
  30. dbus_in_chrome.md
  31. debug_buttons.md
  32. developer_guide.md
  33. developer_mode.md
  34. development_basics.md
  35. disk_format.md
  36. eol_aue_process.md
  37. firmware_code_reviews.md
  38. firmware_test_manual.md
  39. firmware_ui.md
  40. git_and_gerrit_intro.md
  41. glossary.md
  42. gsutil.md
  43. input_stack.md
  44. kernel_development.md
  45. kernel_faq.md
  46. kernel_tips_and_tricks.md
  47. large_scale_changes.md
  48. life_of_a_bug.md
  49. logging.md
  50. lsb-release.md
  51. lsc_workflow.md
  52. navbar.md
  53. os_config.md
  54. OWNERS
  55. pd_firmware_update.md
  56. platform2_primer.md
  57. platform_public_tracker.md
  58. PRESUBMIT.cfg
  59. PRESUBMIT.sh
  60. README.md
  61. remote_trybots.md
  62. repo-tool.md
  63. reporting_bugs.md
  64. rust_on_cros.md
  65. sandboxing.md
  66. security_review_howto.md
  67. security_severity_guidelines.md
  68. simple_chrome_workflow.md
  69. source_layout.md
  70. stack_traces.md
  71. test_install_configuration.md
  72. tips-and-tricks.md
  73. unblocked_terms.txt
  74. work_on_branch.md
  75. write_protection.md
  76. 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/main

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.