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

Unified Diff: tools/gn/variables.cc

Issue 2349743002: Update gn's depfile help text to include more guidance. (Closed)
Patch Set: update build_utils.py help text as swell Created 4 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 | « build/android/gyp/util/build_utils.py ('k') | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: tools/gn/variables.cc
diff --git a/tools/gn/variables.cc b/tools/gn/variables.cc
index f374934a5823851a36305081ae84020f5aae93df..644c8355edbd7a61da96d61c81c1a343c2755961 100644
--- a/tools/gn/variables.cc
+++ b/tools/gn/variables.cc
@@ -1025,13 +1025,23 @@ const char kDepfile_Help[] =
" the dependencies of the input. Empty or unset means that the script\n"
" doesn't generate the files.\n"
"\n"
+ " A depfile should be used only when a target depends on files that are\n"
+ " not already specified by a target's inputs and sources. Likewise,\n"
+ " depfiles should specify only those dependencies not already included\n"
+ " in sources or inputs.\n"
+ "\n"
" The .d file should go in the target output directory. If you have more\n"
" than one source file that the script is being run over, you can use\n"
" the output file expansions described in \"gn help action_foreach\" to\n"
" name the .d file according to the input."
"\n"
- " The format is that of a Makefile, and all of the paths should be\n"
- " relative to the root build directory.\n"
+ " The format is that of a Makefile and all paths must be relative to the\n"
+ " root build directory. Only one output may be listed and it must match\n"
+ " the first output of the action.\n"
+ "\n"
+ " Although depfiles are created by an action, they should not be listed\n"
+ " in the action's \"outputs\" unless another target will use the file as\n"
+ " an input.\n"
"\n"
"Example\n"
"\n"
« no previous file with comments | « build/android/gyp/util/build_utils.py ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698