Google Git
Sign in
chromium / chromiumos / docs / refs/heads/factory-brya-14909.124.B
commitf22a5917933e7d18354113cbdaa5641a11f49ef0[log] [tgz]
authorGrace Cham <hscham@chromium.org>Tue Jun 07 08:04:28 2022
committerChromeos LUCI <chromeos-scoped@luci-project-accounts.iam.gserviceaccount.com>Wed Jun 08 07:40:39 2022
tree6763de2e49de6115a5463c382ae60f528ab5db25
parent9b40adec96eb6f16bd6e14280f9eda086745e825 [diff]
development_basics: Recommend std::optional instead of absl::optional

As an exeption to the suggestion in Modern C++ use in Chromium.

Also fix the out-of-date desription and link for the pointer to
Chromium's document.

BUG=b:192529039
TEST=None

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

ChromiumOS docs

This directory contains public ChromiumOS 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 ChromiumOS 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.