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

Issue 2481423002: Convert gn docstrings to C++11 raw strings. (Closed)

Created:
4 years, 1 month ago by brettw
Modified:
4 years, 1 month ago
Reviewers:
scottmg
CC:
chromium-reviews, Dirk Pranke, tfarina, agrieve+watch_chromium.org
Target Ref:
refs/pending/heads/master
Project:
chromium
Visibility:
Public.

Description

Convert gn docstrings to C++11 raw strings. This makes them more readable and easier to modify. The documentation was un-indented and re-wrapped to 80 cols which makes it fill out the column on the screen better. A few tests were updated to use raw strings as well, but converting all of them seemed not worth the effort. There is a documentation fix in the set_defaults (added [] around the configs in the example), and an obsolete line in the group documentation was removed ("exactly like depending on its deps). Committed: https://crrev.com/085a9b2a0cc2ae534c775012b1f09bf83b1c9041 Cr-Commit-Position: refs/heads/master@{#430679}

Patch Set 1 #

Patch Set 2 : Tweaks #

Total comments: 3

Patch Set 3 : Fix #

Patch Set 4 : Newlines #

Total comments: 11

Patch Set 5 : Fixes #

Total comments: 2

Patch Set 6 : More #

Total comments: 10

Patch Set 7 : Fixes #

Unified diffs Side-by-side diffs Delta from patch set Stats (+6842 lines, -7111 lines) Patch
M tools/gn/args.cc View 3 chunks +25 lines, -28 lines 0 comments Download
M tools/gn/command_analyze.cc View 1 2 3 1 chunk +69 lines, -75 lines 0 comments Download
M tools/gn/command_args.cc View 1 2 3 1 chunk +57 lines, -56 lines 0 comments Download
M tools/gn/command_check.cc View 1 2 3 1 chunk +142 lines, -146 lines 0 comments Download
M tools/gn/command_desc.cc View 1 2 3 1 chunk +125 lines, -126 lines 0 comments Download
M tools/gn/command_format.cc View 1 2 3 1 chunk +38 lines, -37 lines 0 comments Download
M tools/gn/command_gen.cc View 1 2 3 1 chunk +96 lines, -100 lines 0 comments Download
M tools/gn/command_help.cc View 1 2 3 1 chunk +17 lines, -16 lines 0 comments Download
M tools/gn/command_ls.cc View 1 2 3 1 chunk +42 lines, -41 lines 0 comments Download
M tools/gn/command_path.cc View 1 2 3 4 5 1 chunk +38 lines, -38 lines 0 comments Download
M tools/gn/command_refs.cc View 1 2 3 4 1 chunk +103 lines, -99 lines 0 comments Download
M tools/gn/docs/reference.md View 1 2 184 chunks +1929 lines, -2193 lines 0 comments Download
M tools/gn/function_exec_script.cc View 1 2 3 4 5 1 chunk +51 lines, -51 lines 0 comments Download
M tools/gn/function_foreach.cc View 1 2 3 4 5 1 chunk +30 lines, -29 lines 0 comments Download
M tools/gn/function_forward_variables_from.cc View 1 2 3 1 chunk +74 lines, -76 lines 0 comments Download
M tools/gn/function_get_label_info.cc View 1 2 3 4 1 chunk +59 lines, -65 lines 0 comments Download
M tools/gn/function_get_path_info.cc View 1 2 3 4 5 6 1 chunk +75 lines, -76 lines 0 comments Download
M tools/gn/function_get_target_outputs.cc View 1 2 3 1 chunk +52 lines, -51 lines 0 comments Download
M tools/gn/function_process_file_template.cc View 1 2 3 1 chunk +40 lines, -39 lines 0 comments Download
M tools/gn/function_read_file.cc View 1 2 3 4 5 1 chunk +19 lines, -18 lines 0 comments Download
M tools/gn/function_rebase_path.cc View 1 2 3 4 1 chunk +89 lines, -93 lines 0 comments Download
M tools/gn/function_set_default_toolchain.cc View 1 chunk +27 lines, -27 lines 0 comments Download
M tools/gn/function_set_defaults.cc View 1 2 3 4 1 chunk +31 lines, -31 lines 0 comments Download
M tools/gn/function_template.cc View 1 2 3 4 1 chunk +138 lines, -142 lines 0 comments Download
M tools/gn/function_toolchain.cc View 1 2 3 4 5 6 2 chunks +528 lines, -543 lines 0 comments Download
M tools/gn/function_toolchain_unittest.cc View 2 chunks +12 lines, -12 lines 0 comments Download
M tools/gn/function_write_file.cc View 1 2 3 1 chunk +26 lines, -26 lines 0 comments Download
M tools/gn/functions.cc View 1 2 3 10 chunks +317 lines, -309 lines 0 comments Download
M tools/gn/functions_target.cc View 1 2 3 12 chunks +471 lines, -464 lines 0 comments Download
M tools/gn/functions_target_unittest.cc View 1 chunk +14 lines, -14 lines 0 comments Download
M tools/gn/input_conversion.cc View 1 2 3 1 chunk +51 lines, -51 lines 0 comments Download
M tools/gn/label_pattern.cc View 1 2 3 4 5 6 1 chunk +34 lines, -34 lines 0 comments Download
M tools/gn/parser.cc View 1 2 3 4 5 6 1 chunk +202 lines, -204 lines 0 comments Download
M tools/gn/runtime_deps.cc View 1 2 3 1 chunk +67 lines, -66 lines 0 comments Download
M tools/gn/setup.cc View 1 2 3 4 5 6 1 chunk +78 lines, -81 lines 0 comments Download
M tools/gn/substitution_writer.cc View 1 2 3 1 chunk +100 lines, -107 lines 0 comments Download
M tools/gn/switches.cc View 1 2 3 3 chunks +150 lines, -140 lines 0 comments Download
M tools/gn/variables.cc View 1 2 3 4 5 chunks +1426 lines, -1407 lines 0 comments Download

Messages

Total messages: 46 (27 generated)
brettw
Tweaks
4 years, 1 month ago (2016-11-07 23:43:57 UTC) #3
brettw
4 years, 1 month ago (2016-11-07 23:44:10 UTC) #6
scottmg
https://codereview.chromium.org/2481423002/diff/20001/tools/gn/command_analyze.cc File tools/gn/command_analyze.cc (right): https://codereview.chromium.org/2481423002/diff/20001/tools/gn/command_analyze.cc#newcode91 tools/gn/command_analyze.cc:91: errors that way rather than via return codes.)"; \n ...
4 years, 1 month ago (2016-11-07 23:48:06 UTC) #8
brettw
Fix
4 years, 1 month ago (2016-11-08 00:04:37 UTC) #11
brettw
Newlines
4 years, 1 month ago (2016-11-08 00:18:46 UTC) #16
brettw
Thanks, I forgot about the ending newlines. New snap up.
4 years, 1 month ago (2016-11-08 00:18:50 UTC) #18
scottmg
https://codereview.chromium.org/2481423002/diff/60001/tools/gn/command_path.cc File tools/gn/command_path.cc (right): https://codereview.chromium.org/2481423002/diff/60001/tools/gn/command_path.cc#newcode317 tools/gn/command_path.cc:317: gn path out/Default //base //tools/gn)"; One more https://codereview.chromium.org/2481423002/diff/60001/tools/gn/function_exec_script.cc File ...
4 years, 1 month ago (2016-11-08 00:27:53 UTC) #20
scottmg
https://codereview.chromium.org/2481423002/diff/60001/tools/gn/function_get_label_info.cc File tools/gn/function_get_label_info.cc (right): https://codereview.chromium.org/2481423002/diff/60001/tools/gn/function_get_label_info.cc#newcode75 tools/gn/function_get_label_info.cc:75: # Returns string "//out/Debug/gen/foo/bar".)*"; On 2016/11/08 00:27:53, scottmg wrote: ...
4 years, 1 month ago (2016-11-08 00:30:30 UTC) #21
brettw
Fixes
4 years, 1 month ago (2016-11-08 00:38:42 UTC) #24
brettw
Did those plus found a few more. PTAL https://codereview.chromium.org/2481423002/diff/60001/tools/gn/function_get_label_info.cc File tools/gn/function_get_label_info.cc (right): https://codereview.chromium.org/2481423002/diff/60001/tools/gn/function_get_label_info.cc#newcode75 tools/gn/function_get_label_info.cc:75: # ...
4 years, 1 month ago (2016-11-08 00:38:46 UTC) #26
scottmg
... I think maybe you forgot to upload? https://codereview.chromium.org/2481423002/diff/80001/tools/gn/command_path.cc File tools/gn/command_path.cc (right): https://codereview.chromium.org/2481423002/diff/80001/tools/gn/command_path.cc#newcode317 tools/gn/command_path.cc:317: gn ...
4 years, 1 month ago (2016-11-08 00:49:05 UTC) #28
brettw
More
4 years, 1 month ago (2016-11-08 00:53:26 UTC) #31
brettw
New snap up with 2 more fixed on top of the ones you found.
4 years, 1 month ago (2016-11-08 00:53:48 UTC) #33
scottmg
Maybe I like old-style strings better. lgtm with the changes below. I'm ambivalent if you ...
4 years, 1 month ago (2016-11-08 01:01:46 UTC) #35
brettw
Fixes
4 years, 1 month ago (2016-11-08 18:51:58 UTC) #38
commit-bot: I haz the power
CQ is trying da patch. Follow status at https://chromium-cq-status.appspot.com/v2/patch-status/codereview.chromium.org/2481423002/120001
4 years, 1 month ago (2016-11-08 18:52:15 UTC) #41
brettw
I skipped the tests ones (I did them that way on purpose). In some ways ...
4 years, 1 month ago (2016-11-08 18:53:02 UTC) #42
commit-bot: I haz the power
Committed patchset #7 (id:120001)
4 years, 1 month ago (2016-11-08 19:11:08 UTC) #44
commit-bot: I haz the power
4 years, 1 month ago (2016-11-08 19:39:40 UTC) #46
Message was sent while issue was closed.
Patchset 7 (id:??) landed as
https://crrev.com/085a9b2a0cc2ae534c775012b1f09bf83b1c9041
Cr-Commit-Position: refs/heads/master@{#430679}

Powered by Google App Engine
This is Rietveld 408576698