StrixOS/build_soong
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update documentation for genrule and sdk_library

Browse Source 
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
This commit is contained in:
Spandan Das
2021-07-29 18:26:39 +00:00
parent ae86338676
commit 93e95992a4
2 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
genrule/genrule.go
View File

@@ -113,16 +113,17 @@ type hostToolDependencyTag struct {
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

2
java/sdk_library.go
View File

@@ -419,7 +419,7 @@ type sdkLibraryProperties struct {
// local files that are used within user customized droiddoc options.
Droiddoc_option_files []string
// additional droiddoc options
// additional droiddoc options.
// Available variables for substitution:
//
// $(location <label>): the path to the droiddoc_option_files with name <label>