Convert gn docstrings to C++11 raw strings.

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}

[brettw, 2016-11-07 23:38:51]

Description was changed from

==========
Convert gn docstrings to C++11 raw strings.

This makes them more readable and easier to modify.
==========

to

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

There is a bug fix in the set_defaults documentation (added [] around the
configs in the example), and an incorrect line in the group documentation was
removed ("exactly like depending on its deps).
==========

[brettw, 2016-11-07 23:40:15]

Description was changed from

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

There is a bug fix in the set_defaults documentation (added [] around the
configs in the example), and an incorrect line in the group documentation was
removed ("exactly like depending on its deps).
==========

to

==========
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).
==========

[brettw, 2016-11-07 23:43:57]

Tweaks

[brettw, 2016-11-07 23:43:58]

The CQ bit was checked by brettw@chromium.org to run a CQ dry run

[brettw, 2016-11-07 23:44:09]

brettw@chromium.org changed reviewers:
+ scottmg@chromium.org

[commit-bot: I haz the power, 2016-11-07 23:44:49]

Dry run: CQ is trying da patch. Follow status at
 
https://chromium-cq-status.appspot.com/v2/patch-status/codereview.chromium.or...

[scottmg, 2016-11-07 23:48:06]

https://codereview.chromium.org/2481423002/diff/20001/tools/gn/command_analyz...
File tools/gn/command_analyze.cc (right):

https://codereview.chromium.org/2481423002/diff/20001/tools/gn/command_analyz...
tools/gn/command_analyze.cc:91: errors that way rather than via return codes.)";
\n missing here.

https://codereview.chromium.org/2481423002/diff/20001/tools/gn/command_args.cc
File tools/gn/command_args.cc (right):

https://codereview.chromium.org/2481423002/diff/20001/tools/gn/command_args.c...
tools/gn/command_args.cc:338: arguments).)";
And here

https://codereview.chromium.org/2481423002/diff/20001/tools/gn/command_check.cc
File tools/gn/command_check.cc (right):

https://codereview.chromium.org/2481423002/diff/20001/tools/gn/command_check....
tools/gn/command_check.cc:52: "gn help check_includes".)";
And a bunch more it looks like.

[commit-bot: I haz the power, 2016-11-07 23:55:52]

The CQ bit was unchecked by commit-bot@chromium.org

[commit-bot: I haz the power, 2016-11-07 23:55:53]

Dry run: Try jobs failed on following builders:
  chromium_presubmit on master.tryserver.chromium.linux (JOB_FAILED,
http://build.chromium.org/p/tryserver.chromium.linux/builders/chromium_presub...)

[brettw, 2016-11-08 00:04:37]

Fix

[brettw, 2016-11-08 00:04:38]

The CQ bit was checked by brettw@chromium.org to run a CQ dry run

[commit-bot: I haz the power, 2016-11-08 00:05:16]

Dry run: CQ is trying da patch. Follow status at
 
https://chromium-cq-status.appspot.com/v2/patch-status/codereview.chromium.or...

[commit-bot: I haz the power, 2016-11-08 00:12:07]

The CQ bit was unchecked by commit-bot@chromium.org

[commit-bot: I haz the power, 2016-11-08 00:12:08]

Dry run: Try jobs failed on following builders:
  chromium_presubmit on master.tryserver.chromium.linux (JOB_FAILED,
http://build.chromium.org/p/tryserver.chromium.linux/builders/chromium_presub...)

[brettw, 2016-11-08 00:18:46]

Newlines

[brettw, 2016-11-08 00:18:47]

The CQ bit was checked by brettw@chromium.org to run a CQ dry run

[brettw, 2016-11-08 00:18:50]

Thanks, I forgot about the ending newlines. New snap up.

[commit-bot: I haz the power, 2016-11-08 00:19:31]

Dry run: CQ is trying da patch. Follow status at
 
https://chromium-cq-status.appspot.com/v2/patch-status/codereview.chromium.or...

[scottmg, 2016-11-08 00:27:53]

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.c...
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_...
File tools/gn/function_exec_script.cc (right):

https://codereview.chromium.org/2481423002/diff/60001/tools/gn/function_exec_...
tools/gn/function_exec_script.cc:115: exec_script("//foo/bar/myscript.py"))";
here too

https://codereview.chromium.org/2481423002/diff/60001/tools/gn/function_forea...
File tools/gn/function_foreach.cc (right):

https://codereview.chromium.org/2481423002/diff/60001/tools/gn/function_forea...
tools/gn/function_foreach.cc:45: c)";
here

https://codereview.chromium.org/2481423002/diff/60001/tools/gn/function_get_l...
File tools/gn/function_get_label_info.cc (right):

https://codereview.chromium.org/2481423002/diff/60001/tools/gn/function_get_l...
tools/gn/function_get_label_info.cc:75: # Returns string
"//out/Debug/gen/foo/bar".)*";
\n looks wrong and ... what's with the *?

https://codereview.chromium.org/2481423002/diff/60001/tools/gn/function_get_p...
File tools/gn/function_get_path_info.cc (right):

https://codereview.chromium.org/2481423002/diff/60001/tools/gn/function_get_p...
tools/gn/function_get_path_info.cc:197: result =
get_path_info(get_path_info(path, "dir"), "abspath")";
here

https://codereview.chromium.org/2481423002/diff/60001/tools/gn/function_read_...
File tools/gn/function_read_file.cc (right):

https://codereview.chromium.org/2481423002/diff/60001/tools/gn/function_read_...
tools/gn/function_read_file.cc:40: lines = read_file("foo.txt", "list lines"))";
here

https://codereview.chromium.org/2481423002/diff/60001/tools/gn/function_rebas...
File tools/gn/function_rebase_path.cc (right):

https://codereview.chromium.org/2481423002/diff/60001/tools/gn/function_rebas...
tools/gn/function_rebase_path.cc:216: })";
i gave up here.

[scottmg, 2016-11-08 00:30:30]

https://codereview.chromium.org/2481423002/diff/60001/tools/gn/function_get_l...
File tools/gn/function_get_label_info.cc (right):

https://codereview.chromium.org/2481423002/diff/60001/tools/gn/function_get_l...
tools/gn/function_get_label_info.cc:75: # Returns string
"//out/Debug/gen/foo/bar".)*";
On 2016/11/08 00:27:53, scottmg wrote:
> \n looks wrong and ... what's with the *?

oh, I see the * at the beginning now. (I think the cxx discussion disallowed
non-default ones, but oh well.)

Anyway, there's some \ns missing I think.

https://codereview.chromium.org/2481423002/diff/60001/tools/gn/function_set_d...
File tools/gn/function_set_defaults.cc (right):

https://codereview.chromium.org/2481423002/diff/60001/tools/gn/function_set_d...
tools/gn/function_set_defaults.cc:45: })";
here

https://codereview.chromium.org/2481423002/diff/60001/tools/gn/function_templ...
File tools/gn/function_template.cc (right):

https://codereview.chromium.org/2481423002/diff/60001/tools/gn/function_templ...
tools/gn/function_template.cc:154: })";
here

[commit-bot: I haz the power, 2016-11-08 00:31:08]

The CQ bit was unchecked by commit-bot@chromium.org

[commit-bot: I haz the power, 2016-11-08 00:31:09]

Dry run: Try jobs failed on following builders:
  chromium_presubmit on master.tryserver.chromium.linux (JOB_FAILED,
http://build.chromium.org/p/tryserver.chromium.linux/builders/chromium_presub...)

[brettw, 2016-11-08 00:38:42]

Fixes

[brettw, 2016-11-08 00:38:43]

The CQ bit was checked by brettw@chromium.org to run a CQ dry run

[brettw, 2016-11-08 00:38:46]

Did those plus found a few more. PTAL

https://codereview.chromium.org/2481423002/diff/60001/tools/gn/function_get_l...
File tools/gn/function_get_label_info.cc (right):

https://codereview.chromium.org/2481423002/diff/60001/tools/gn/function_get_l...
tools/gn/function_get_label_info.cc:75: # Returns string
"//out/Debug/gen/foo/bar".)*";
On 2016/11/08 00:30:30, scottmg wrote:
> On 2016/11/08 00:27:53, scottmg wrote:
> > \n looks wrong and ... what's with the *?
> 
> oh, I see the * at the beginning now. (I think the cxx discussion disallowed
> non-default ones, but oh well.)

There's a )" in this string that's syntactically important, and using the
non-default ones is the least bad thing to do as far as I can see.

[commit-bot: I haz the power, 2016-11-08 00:39:31]

Dry run: CQ is trying da patch. Follow status at
 
https://chromium-cq-status.appspot.com/v2/patch-status/codereview.chromium.or...

[scottmg, 2016-11-08 00:49:05]

... 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.c...
tools/gn/command_path.cc:317: gn path out/Default //base //tools/gn)";
Another

https://codereview.chromium.org/2481423002/diff/80001/tools/gn/function_exec_...
File tools/gn/function_exec_script.cc (right):

https://codereview.chromium.org/2481423002/diff/80001/tools/gn/function_exec_...
tools/gn/function_exec_script.cc:115: exec_script("//foo/bar/myscript.py"))";
Another

[commit-bot: I haz the power, 2016-11-08 00:53:23]

The CQ bit was unchecked by commit-bot@chromium.org

[commit-bot: I haz the power, 2016-11-08 00:53:24]

Dry run: This issue passed the CQ dry run.

[brettw, 2016-11-08 00:53:26]

More

[brettw, 2016-11-08 00:53:27]

The CQ bit was checked by brettw@chromium.org to run a CQ dry run

[brettw, 2016-11-08 00:53:48]

New snap up with 2 more fixed on top of the ones you found.

[commit-bot: I haz the power, 2016-11-08 00:54:16]

Dry run: CQ is trying da patch. Follow status at
 
https://chromium-cq-status.appspot.com/v2/patch-status/codereview.chromium.or...

[scottmg, 2016-11-08 01:01:46]

Maybe I like old-style strings better.

lgtm with the changes below.

I'm ambivalent if you don't feel it's necessary to change the test ones.

https://codereview.chromium.org/2481423002/diff/100001/tools/gn/function_get_...
File tools/gn/function_get_path_info.cc (right):

https://codereview.chromium.org/2481423002/diff/100001/tools/gn/function_get_...
tools/gn/function_get_path_info.cc:197: result =
get_path_info(get_path_info(path, "dir"), "abspath")";
moar

https://codereview.chromium.org/2481423002/diff/100001/tools/gn/function_tool...
File tools/gn/function_toolchain.cc (right):

https://codereview.chromium.org/2481423002/diff/100001/tools/gn/function_tool...
tools/gn/function_toolchain.cc:380: };)*";
here

https://codereview.chromium.org/2481423002/diff/100001/tools/gn/function_tool...
tools/gn/function_toolchain.cc:724: )"  // String break to prevent overflowing
the 16K max VC string length.
lolz

https://codereview.chromium.org/2481423002/diff/100001/tools/gn/function_tool...
tools/gn/function_toolchain.cc:906: };)";
\n

https://codereview.chromium.org/2481423002/diff/100001/tools/gn/function_tool...
File tools/gn/function_toolchain_unittest.cc (right):

https://codereview.chromium.org/2481423002/diff/100001/tools/gn/function_tool...
tools/gn/function_toolchain_unittest.cc:22: })");
here

https://codereview.chromium.org/2481423002/diff/100001/tools/gn/function_tool...
tools/gn/function_toolchain_unittest.cc:51: })");
here

https://codereview.chromium.org/2481423002/diff/100001/tools/gn/functions_tar...
File tools/gn/functions_target_unittest.cc (right):

https://codereview.chromium.org/2481423002/diff/100001/tools/gn/functions_tar...
tools/gn/functions_target_unittest.cc:67: })");
here

https://codereview.chromium.org/2481423002/diff/100001/tools/gn/label_pattern.cc
File tools/gn/label_pattern.cc (right):

https://codereview.chromium.org/2481423002/diff/100001/tools/gn/label_pattern...
tools/gn/label_pattern.cc:48: toolchain.)*";
here

https://codereview.chromium.org/2481423002/diff/100001/tools/gn/parser.cc
File tools/gn/parser.cc (right):

https://codereview.chromium.org/2481423002/diff/100001/tools/gn/parser.cc#new...
tools/gn/parser.cc:216: empty_scope.new_thing = [ 1, 2, 3 ])*";
here

https://codereview.chromium.org/2481423002/diff/100001/tools/gn/setup.cc
File tools/gn/setup.cc (right):

https://codereview.chromium.org/2481423002/diff/100001/tools/gn/setup.cc#newc...
tools/gn/setup.cc:120: secondary_source =
"//build/config/temporary_buildfiles/")";
here

[commit-bot: I haz the power, 2016-11-08 01:04:09]

The CQ bit was unchecked by commit-bot@chromium.org

[commit-bot: I haz the power, 2016-11-08 01:04:10]

Dry run: This issue passed the CQ dry run.

[brettw, 2016-11-08 18:51:58]

Fixes

[brettw, 2016-11-08 18:51:58]

The CQ bit was checked by brettw@chromium.org

[brettw, 2016-11-08 18:51:59]

The patchset sent to the CQ was uploaded after l-g-t-m from scottmg@chromium.org
Link to the patchset: https://codereview.chromium.org/2481423002/#ps120001
(title: "Fixes")

[commit-bot: I haz the power, 2016-11-08 18:52:15]

CQ is trying da patch. Follow status at
 
https://chromium-cq-status.appspot.com/v2/patch-status/codereview.chromium.or...

[brettw, 2016-11-08 18:53:02]

I skipped the tests ones (I did them that way on purpose).

In some ways I liked the old string better as well. But it makes really hard to
update the documentation any time anything wraps, and worrying about escaping
all of the " and such gets pretty annoying.

[commit-bot: I haz the power, 2016-11-08 19:11:06]

Description was changed from

==========
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).
==========

to

==========
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).
==========

[commit-bot: I haz the power, 2016-11-08 19:11:08]

Committed patchset #7 (id:120001)

[commit-bot: I haz the power, 2016-11-08 19:39:39]

Description was changed from

==========
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).
==========

to

==========
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}
==========

[commit-bot: I haz the power, 2016-11-08 19:39:40]

Patchset 7 (id:??) landed as
https://crrev.com/085a9b2a0cc2ae534c775012b1f09bf83b1c9041
Cr-Commit-Position: refs/heads/master@{#430679}