Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(114)

Unified Diff: tools/gn/docs/reference.md

Issue 1301423006: Escape "--" in markdown rendering for GN reference docs. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@gn_reference
Patch Set: fix second dec== Created 5 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | tools/gn/standard_out.cc » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: tools/gn/docs/reference.md
diff --git a/tools/gn/docs/reference.md b/tools/gn/docs/reference.md
index b81b3f65f46e02018f0e769a1a67dcddca66ea24..a510d5a3eead5aa6084a921d0df5b9122a8961dc 100644
--- a/tools/gn/docs/reference.md
+++ b/tools/gn/docs/reference.md
@@ -2,7 +2,7 @@
*This page is automatically generated from* `gn help --markdown all`.
-## **--args**: Specifies build arguments overrides.
+## **\--args**: Specifies build arguments overrides.
```
See "gn help buildargs" for an overview of how build arguments work.
@@ -40,7 +40,7 @@
```
-## **--[no]color**: Forces colored output on or off.
+## **\--[no]color**: Forces colored output on or off.
```
Normally GN will try to detect whether it is outputting to a terminal
@@ -58,7 +58,7 @@
```
-## **--dotfile**: Override the name of the ".gn" file.
+## **\--dotfile**: Override the name of the ".gn" file.
```
Normally GN loads the ".gn"file from the source root for some basic
@@ -70,9 +70,9 @@
```
-## **--markdown**: write the output in the Markdown format.
+## **\--markdown**: write the output in the Markdown format.
-## **--[no]color**: Forces colored output on or off.
+## **\--[no]color**: Forces colored output on or off.
```
Normally GN will try to detect whether it is outputting to a terminal
@@ -97,7 +97,7 @@
```
-## **--root**: Explicitly specify source root.
+## **\--root**: Explicitly specify source root.
```
Normally GN will look up in the directory tree from the current
@@ -119,7 +119,7 @@
```
-## **--runtime-deps-list-file**: Save runtime dependencies for targets in file.
+## **\--runtime-deps-list-file**: Save runtime dependencies for targets in file.
```
--runtime-deps-list-file=<filename>
@@ -154,7 +154,7 @@
```
-## **--time**: Outputs a summary of how long everything took.
+## **\--time**: Outputs a summary of how long everything took.
```
Hopefully self-explanatory.
@@ -168,7 +168,7 @@
```
-## **--tracelog**: Writes a Chrome-compatible trace log to the given file.
+## **\--tracelog**: Writes a Chrome-compatible trace log to the given file.
```
The trace log will show file loads, executions, scripts, and writes.
@@ -194,7 +194,7 @@
```
-## **gn args <out_dir> [--list] [--short] [--args]**
+## **gn args <out_dir> [\--list] [\--short] [\--args]**
```
See also "gn help buildargs" for a more high-level overview of how
@@ -259,7 +259,7 @@
```
-## **gn check <out_dir> [<label_pattern>] [--force]**
+## **gn check <out_dir> [<label_pattern>] [\--force]**
```
"gn check" is the same thing as "gn gen" with the "--check" flag
@@ -309,7 +309,7 @@
```
-## **gn desc <out_dir> <target label> [<what to show>] [--blame]**
+## **gn desc <out_dir> <target label> [<what to show>] [\--blame]**
```
Displays information about a given labeled target for the given build.
@@ -474,7 +474,7 @@
```
-## **gn format [--dump-tree] [--in-place] [--stdin] BUILD.gn**
+## **gn format [\--dump-tree] [\--in-place] [\--stdin] BUILD.gn**
```
Formats .gn file to a standard format.
@@ -538,7 +538,7 @@
```
-## **gn ls <out_dir> [<label_pattern>] [--all-toolchains] [--as=...]**
+## **gn ls <out_dir> [<label_pattern>] [\--all-toolchains] [\--as=...]**
```
[--type=...] [--testonly=...]
@@ -642,7 +642,7 @@
```
-## **gn refs <out_dir> (<label_pattern>|<label>|<file>|@<response_file>)* [--all]**
+## **gn refs <out_dir> (<label_pattern>|<label>|<file>|@<response_file>)* [\--all]**
```
[--all-toolchains] [--as=...] [--testonly=...] [--type=...]
@@ -4817,17 +4817,17 @@
```
-** --args**: Specifies build arguments overrides.
-** --color**: Force colored output.
-** --dotfile**: Override the name of the ".gn" file.
-** --markdown**: write the output in the Markdown format.
-** --nocolor**: Force non-colored output.
+** \--args**: Specifies build arguments overrides.
+** \--color**: Force colored output.
+** \--dotfile**: Override the name of the ".gn" file.
+** \--markdown**: write the output in the Markdown format.
+** \--nocolor**: Force non-colored output.
** -q**: Quiet mode. Don't print output on success.
-** --root**: Explicitly specify source root.
-** --runtime-deps-list-file**: Save runtime dependencies for targets in file.
-** --time**: Outputs a summary of how long everything took.
-** --tracelog**: Writes a Chrome-compatible trace log to the given file.
+** \--root**: Explicitly specify source root.
+** \--runtime-deps-list-file**: Save runtime dependencies for targets in file.
+** \--time**: Outputs a summary of how long everything took.
+** \--tracelog**: Writes a Chrome-compatible trace log to the given file.
** -v**: Verbose logging.
-** --version**: Prints the GN version number and exits.
+** \--version**: Prints the GN version number and exits.
```
« no previous file with comments | « no previous file | tools/gn/standard_out.cc » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698