summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authornodir <nodir@chromium.org>2015-12-19 16:54:33 -0800
committerCommit bot <commit-bot@chromium.org>2015-12-20 00:55:33 +0000
commit6efa499a1284f200785f3374b991e7d73adbe235 (patch)
treec5f595fc17c672e9c464a62fb8b77542efd0c470 /docs
parentb988466841a1f7b77d0c2bd6824273b7f82b4a36 (diff)
downloadchromium_src-6efa499a1284f200785f3374b991e7d73adbe235.zip
chromium_src-6efa499a1284f200785f3374b991e7d73adbe235.tar.gz
chromium_src-6efa499a1284f200785f3374b991e7d73adbe235.tar.bz2
docs: explain how to preview changes
Your own changes or someone else's. R=jyasskin@chromium.org, BUG=571125 Review URL: https://codereview.chromium.org/1535273002 Cr-Commit-Position: refs/heads/master@{#366287}
Diffstat (limited to 'docs')
-rw-r--r--docs/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
index 6bd588f..c37c54d 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -8,5 +8,23 @@ It is automatically
Markdown documents must follow the [style guide].
+## Previewing changes
+
+You can preview your local changes using [md_browser]:
+
+```bash
+# in chromium checkout
+python tools/md_browser/md_browser.py
+```
+
+To review someone else's changes, apply them locally first:
+
+```bash
+# in chromium checkout
+git cl patch <CL number or URL>
+python tools/md_browser/md_browser.py
+```
+
[Markdown]: https://gerrit.googlesource.com/gitiles/+/master/Documentation/markdown.md
[style guide]: https://github.com/google/styleguide/tree/gh-pages/docguide
+[md_browser]: ../tools/md_browser/ \ No newline at end of file