Update documentation for genrule and sdk_library
1. Documentation for genrule and sdk_library was missing a period, which
has been added now. For
genrule, Before:
https://android-build.googleplex.com/builds/submitted/7594870/linux/latest/view/genrule.html,
After:
https://x20web.corp.google.com/users/sp/spandandas/soong_docs/genrule.html
2. Documentation for genrule was missing definition of $(locations),
which has been added now
Bug: 194231221
Test: m soong_docs
Change-Id: Ia367f13055c110d92a491a9c1b1af4113f66b296
diff --git a/genrule/genrule.go b/genrule/genrule.go
index 8372a64..1ac50b1 100644
--- a/genrule/genrule.go
+++ b/genrule/genrule.go
@@ -113,16 +113,17 @@
label string
}
type generatorProperties struct {
- // The command to run on one or more input files. Cmd supports substitution of a few variables
+ // The command to run on one or more input files. Cmd supports substitution of a few variables.
//
// Available variables for substitution:
//
- // $(location): the path to the first entry in tools or tool_files
- // $(location <label>): the path to the tool, tool_file, input or output with name <label>
- // $(in): one or more input files
- // $(out): a single output file
- // $(depfile): a file to which dependencies will be written, if the depfile property is set to true
- // $(genDir): the sandbox directory for this tool; contains $(out)
+ // $(location): the path to the first entry in tools or tool_files.
+ // $(location <label>): the path to the tool, tool_file, input or output with name <label>. Use $(location) if <label> refers to a rule that outputs exactly one file.
+ // $(locations <label>): the paths to the tools, tool_files, inputs or outputs with name <label>. Use $(locations) if <label> refers to a rule that outputs two or more files.
+ // $(in): one or more input files.
+ // $(out): a single output file.
+ // $(depfile): a file to which dependencies will be written, if the depfile property is set to true.
+ // $(genDir): the sandbox directory for this tool; contains $(out).
// $$: a literal $
Cmd *string