ebuild_faq: Clarify -rX symlink revbumps

Related: in b/187795346, we're not requiring new (or version-bumped)
ebuilds to have a symlink.

Change-Id: Id6fb9e2fe353a4c244256c587452bcd486e074c3
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/docs/+/3546305
Reviewed-by: Dan Callaghan <dcallagh@chromium.org>
Commit-Queue: Brian Norris <briannorris@chromium.org>
Tested-by: Brian Norris <briannorris@chromium.org>
1 file changed
tree: 4a06bcac6cc55beff7941ae4d70d30c2479ca67b
  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. releases.md
  62. remote_trybots.md
  63. repo-tool.md
  64. reporting_bugs.md
  65. rust_on_cros.md
  66. sandboxing.md
  67. security_review_howto.md
  68. security_severity_guidelines.md
  69. simple_chrome_workflow.md
  70. source_layout.md
  71. stack_traces.md
  72. test_install_configuration.md
  73. tips-and-tricks.md
  74. unblocked_terms.txt
  75. work_on_branch.md
  76. write_protection.md
  77. 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.

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.