Commit 76097c7f authored by agrieve's avatar agrieve Committed by Commit bot

Update gn's depfile help text to include more guidance.

Review-Url: https://codereview.chromium.org/2349743002
Cr-Commit-Position: refs/heads/master@{#419555}
parent a48869ce
......@@ -420,7 +420,7 @@ def AddDepfileOption(parser):
else:
func = parser.add_argument
func('--depfile',
help='Path to depfile. Must be specified as the action\'s first output.')
help='Path to depfile (refer to `gn help depfile`)')
def WriteDepfile(depfile_path, first_gn_output, inputs=None, add_pydeps=True):
......
......@@ -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"
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment