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

Unified Diff: tools/gn/substitution_writer.cc

Issue 2481423002: Convert gn docstrings to C++11 raw strings. (Closed)
Patch Set: Fixes Created 4 years, 1 month 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 | « tools/gn/setup.cc ('k') | tools/gn/switches.cc » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: tools/gn/substitution_writer.cc
diff --git a/tools/gn/substitution_writer.cc b/tools/gn/substitution_writer.cc
index ce574856c7aaf123dde1869920a2670f0d89c698..4d818cdaeac6a25d45de131d93618909ac5a3379 100644
--- a/tools/gn/substitution_writer.cc
+++ b/tools/gn/substitution_writer.cc
@@ -34,113 +34,106 @@ void SetDirOrDotWithNoSlash(const std::string& dir, std::string* dest) {
} // namespace
const char kSourceExpansion_Help[] =
- "How Source Expansion Works\n"
- "\n"
- " Source expansion is used for the action_foreach and copy target types\n"
- " to map source file names to output file names or arguments.\n"
- "\n"
- " To perform source expansion in the outputs, GN maps every entry in the\n"
- " sources to every entry in the outputs list, producing the cross\n"
- " product of all combinations, expanding placeholders (see below).\n"
- "\n"
- " Source expansion in the args works similarly, but performing the\n"
- " placeholder substitution produces a different set of arguments for\n"
- " each invocation of the script.\n"
- "\n"
- " If no placeholders are found, the outputs or args list will be treated\n"
- " as a static list of literal file names that do not depend on the\n"
- " sources.\n"
- "\n"
- " See \"gn help copy\" and \"gn help action_foreach\" for more on how\n"
- " this is applied.\n"
- "\n"
- "Placeholders\n"
- "\n"
- " This section discusses only placeholders for actions. There are other\n"
- " placeholders used in the definition of tools. See \"gn help tool\" for\n"
- " those.\n"
- "\n"
- " {{source}}\n"
- " The name of the source file including directory (*). This will\n"
- " generally be used for specifying inputs to a script in the\n"
- " \"args\" variable.\n"
- " \"//foo/bar/baz.txt\" => \"../../foo/bar/baz.txt\"\n"
- "\n"
- " {{source_file_part}}\n"
- " The file part of the source including the extension.\n"
- " \"//foo/bar/baz.txt\" => \"baz.txt\"\n"
- "\n"
- " {{source_name_part}}\n"
- " The filename part of the source file with no directory or\n"
- " extension. This will generally be used for specifying a\n"
- " transformation from a source file to a destination file with the\n"
- " same name but different extension.\n"
- " \"//foo/bar/baz.txt\" => \"baz\"\n"
- "\n"
- " {{source_dir}}\n"
- " The directory (*) containing the source file with no\n"
- " trailing slash.\n"
- " \"//foo/bar/baz.txt\" => \"../../foo/bar\"\n"
- "\n"
- " {{source_root_relative_dir}}\n"
- " The path to the source file's directory relative to the source\n"
- " root, with no leading \"//\" or trailing slashes. If the path is\n"
- " system-absolute, (beginning in a single slash) this will just\n"
- " return the path with no trailing slash. This value will always\n"
- " be the same, regardless of whether it appears in the \"outputs\"\n"
- " or \"args\" section.\n"
- " \"//foo/bar/baz.txt\" => \"foo/bar\"\n"
- "\n"
- " {{source_gen_dir}}\n"
- " The generated file directory (*) corresponding to the source\n"
- " file's path. This will be different than the target's generated\n"
- " file directory if the source file is in a different directory\n"
- " than the BUILD.gn file.\n"
- " \"//foo/bar/baz.txt\" => \"gen/foo/bar\"\n"
- "\n"
- " {{source_out_dir}}\n"
- " The object file directory (*) corresponding to the source file's\n"
- " path, relative to the build directory. this us be different than\n"
- " the target's out directory if the source file is in a different\n"
- " directory than the build.gn file.\n"
- " \"//foo/bar/baz.txt\" => \"obj/foo/bar\"\n"
- "\n"
- "(*) Note on directories\n"
- "\n"
- " Paths containing directories (except the source_root_relative_dir)\n"
- " will be different depending on what context the expansion is evaluated\n"
- " in. Generally it should \"just work\" but it means you can't\n"
- " concatenate strings containing these values with reasonable results.\n"
- "\n"
- " Details: source expansions can be used in the \"outputs\" variable,\n"
- " the \"args\" variable, and in calls to \"process_file_template\". The\n"
- " \"args\" are passed to a script which is run from the build directory,\n"
- " so these directories will relative to the build directory for the\n"
- " script to find. In the other cases, the directories will be source-\n"
- " absolute (begin with a \"//\") because the results of those expansions\n"
- " will be handled by GN internally.\n"
- "\n"
- "Examples\n"
- "\n"
- " Non-varying outputs:\n"
- " action(\"hardcoded_outputs\") {\n"
- " sources = [ \"input1.idl\", \"input2.idl\" ]\n"
- " outputs = [ \"$target_out_dir/output1.dat\",\n"
- " \"$target_out_dir/output2.dat\" ]\n"
- " }\n"
- " The outputs in this case will be the two literal files given.\n"
- "\n"
- " Varying outputs:\n"
- " action_foreach(\"varying_outputs\") {\n"
- " sources = [ \"input1.idl\", \"input2.idl\" ]\n"
- " outputs = [ \"{{source_gen_dir}}/{{source_name_part}}.h\",\n"
- " \"{{source_gen_dir}}/{{source_name_part}}.cc\" ]\n"
- " }\n"
- " Performing source expansion will result in the following output names:\n"
- " //out/Debug/obj/mydirectory/input1.h\n"
- " //out/Debug/obj/mydirectory/input1.cc\n"
- " //out/Debug/obj/mydirectory/input2.h\n"
- " //out/Debug/obj/mydirectory/input2.cc\n";
+ R"(How Source Expansion Works
+
+ Source expansion is used for the action_foreach and copy target types to map
+ source file names to output file names or arguments.
+
+ To perform source expansion in the outputs, GN maps every entry in the
+ sources to every entry in the outputs list, producing the cross product of
+ all combinations, expanding placeholders (see below).
+
+ Source expansion in the args works similarly, but performing the placeholder
+ substitution produces a different set of arguments for each invocation of the
+ script.
+
+ If no placeholders are found, the outputs or args list will be treated as a
+ static list of literal file names that do not depend on the sources.
+
+ See "gn help copy" and "gn help action_foreach" for more on how this is
+ applied.
+
+Placeholders
+
+ This section discusses only placeholders for actions. There are other
+ placeholders used in the definition of tools. See "gn help tool" for those.
+
+ {{source}}
+ The name of the source file including directory (*). This will generally
+ be used for specifying inputs to a script in the "args" variable.
+ "//foo/bar/baz.txt" => "../../foo/bar/baz.txt"
+
+ {{source_file_part}}
+ The file part of the source including the extension.
+ "//foo/bar/baz.txt" => "baz.txt"
+
+ {{source_name_part}}
+ The filename part of the source file with no directory or extension. This
+ will generally be used for specifying a transformation from a source file
+ to a destination file with the same name but different extension.
+ "//foo/bar/baz.txt" => "baz"
+
+ {{source_dir}}
+ The directory (*) containing the source file with no trailing slash.
+ "//foo/bar/baz.txt" => "../../foo/bar"
+
+ {{source_root_relative_dir}}
+ The path to the source file's directory relative to the source root, with
+ no leading "//" or trailing slashes. If the path is system-absolute,
+ (beginning in a single slash) this will just return the path with no
+ trailing slash. This value will always be the same, regardless of whether
+ it appears in the "outputs" or "args" section.
+ "//foo/bar/baz.txt" => "foo/bar"
+
+ {{source_gen_dir}}
+ The generated file directory (*) corresponding to the source file's path.
+ This will be different than the target's generated file directory if the
+ source file is in a different directory than the BUILD.gn file.
+ "//foo/bar/baz.txt" => "gen/foo/bar"
+
+ {{source_out_dir}}
+ The object file directory (*) corresponding to the source file's path,
+ relative to the build directory. this us be different than the target's
+ out directory if the source file is in a different directory than the
+ build.gn file.
+ "//foo/bar/baz.txt" => "obj/foo/bar"
+
+(*) Note on directories
+
+ Paths containing directories (except the source_root_relative_dir) will be
+ different depending on what context the expansion is evaluated in. Generally
+ it should "just work" but it means you can't concatenate strings containing
+ these values with reasonable results.
+
+ Details: source expansions can be used in the "outputs" variable, the "args"
+ variable, and in calls to "process_file_template". The "args" are passed to a
+ script which is run from the build directory, so these directories will
+ relative to the build directory for the script to find. In the other cases,
+ the directories will be source- absolute (begin with a "//") because the
+ results of those expansions will be handled by GN internally.
+
+Examples
+
+ Non-varying outputs:
+ action("hardcoded_outputs") {
+ sources = [ "input1.idl", "input2.idl" ]
+ outputs = [ "$target_out_dir/output1.dat",
+ "$target_out_dir/output2.dat" ]
+ }
+ The outputs in this case will be the two literal files given.
+
+ Varying outputs:
+ action_foreach("varying_outputs") {
+ sources = [ "input1.idl", "input2.idl" ]
+ outputs = [ "{{source_gen_dir}}/{{source_name_part}}.h",
+ "{{source_gen_dir}}/{{source_name_part}}.cc" ]
+ }
+ Performing source expansion will result in the following output names:
+ //out/Debug/obj/mydirectory/input1.h
+ //out/Debug/obj/mydirectory/input1.cc
+ //out/Debug/obj/mydirectory/input2.h
+ //out/Debug/obj/mydirectory/input2.cc
+)";
// static
void SubstitutionWriter::WriteWithNinjaVariables(
« no previous file with comments | « tools/gn/setup.cc ('k') | tools/gn/switches.cc » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698