Google Git
Sign in
chromium / chromiumos / docs / 29ae16da4d97ff6a4d882b87584d9cf8a55545af
commit29ae16da4d97ff6a4d882b87584d9cf8a55545af[log] [tgz]
authorAllen Webb <allenwebb@google.com>Wed Oct 31 21:53:47 2018
committerchrome-bot <chrome-bot@chromium.org>Thu Nov 01 00:23:10 2018
treeb2951d64babf322d34885430994cbd17d96c7542
parent88704c3ed0e4a4a51b80e5015eca9d210ad39a01 [diff]
fuzzing: Add context to gyp example.

This adds a little bit of context to the gyp example to make it more
clear to someone writing a fuzzer.

Change-Id: I0cac1458a5c9ae2b17f7df5f5c5127636d2f4638
Reviewed-on: https://chromium-review.googlesource.com/1311539
Commit-Ready: Allen Webb <allenwebb@google.com>
Tested-by: Allen Webb <allenwebb@google.com>
Reviewed-by: Caroline Tice <cmtice@chromium.org>
1 file changed
tree: b2951d64babf322d34885430994cbd17d96c7542
  1. images/
  2. scripts/
  3. ca_certs.md
  4. chrome_commit_pipeline.md
  5. COMMIT-QUEUE.ini
  6. contact.md
  7. containers_and_vms.md
  8. contributing.md
  9. cros_commit_pipeline.md
  10. cros_vm.md
  11. dbus_best_practices.md
  12. dbus_in_chrome.md
  13. debug_buttons.md
  14. developer_guide.md
  15. development_basics.md
  16. fuzzing.md
  17. gsutil.md
  18. kernel_faq.md
  19. lsb-release.md
  20. navbar.md
  21. os_config.md
  22. platform2_gn.md
  23. PRESUBMIT.cfg
  24. README.md
  25. reporting_bugs.md
  26. rust_on_cros.md
  27. sandboxing.md
  28. security_review_howto.md
  29. security_severity_guidelines.md
  30. security_sheriffing.md
  31. simple_chrome_workflow.md
  32. source_layout.md
  33. unit_tests.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.

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

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