Allow Soong to generate its own build documentation
Add a rule in soong that re-executes soong_build in order to
generate build documentation. This allows Soong to customize
the documentation.
Bug: 70516282
Test: m soong_docs
Change-Id: If143cfacd6ac20274cd7bb8d8fab0c07025a5553
diff --git a/android/config.go b/android/config.go
index 0eebb5f..16870f1 100644
--- a/android/config.go
+++ b/android/config.go
@@ -25,6 +25,7 @@
"strings"
"sync"
+ "github.com/google/blueprint/bootstrap"
"github.com/google/blueprint/proptools"
)
@@ -67,6 +68,7 @@
FileConfigurableOptions
ProductVariables productVariables
+ PrimaryBuilder string
ConfigFileName string
ProductVariablesFileName string
@@ -91,6 +93,8 @@
useOpenJDK9 bool // Use OpenJDK9, but possibly target 1.8
targetOpenJDK9 bool // Use OpenJDK9 and target 1.9
+ stopBefore bootstrap.StopBefore
+
OncePer
}
@@ -312,14 +316,22 @@
return nil
}
-func (c *config) RemoveAbandonedFiles() bool {
- return false
+func (c *config) StopBefore() bootstrap.StopBefore {
+ return c.stopBefore
}
+func (c *config) SetStopBefore(stopBefore bootstrap.StopBefore) {
+ c.stopBefore = stopBefore
+}
+
+var _ bootstrap.ConfigStopBefore = (*config)(nil)
+
func (c *config) BlueprintToolLocation() string {
return filepath.Join(c.buildDir, "host", c.PrebuiltOS(), "bin")
}
+var _ bootstrap.ConfigBlueprintToolLocation = (*config)(nil)
+
// HostSystemTool looks for non-hermetic tools from the system we're running on.
// Generally shouldn't be used, but useful to find the XCode SDK, etc.
func (c *config) HostSystemTool(name string) string {
diff --git a/android/writedocs.go b/android/writedocs.go
new file mode 100644
index 0000000..9737030
--- /dev/null
+++ b/android/writedocs.go
@@ -0,0 +1,73 @@
+// Copyright 2015 Google Inc. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package android
+
+import (
+ "fmt"
+ "os"
+ "path/filepath"
+ "strings"
+
+ "github.com/google/blueprint"
+)
+
+func init() {
+ RegisterSingletonType("writedocs", DocsSingleton)
+}
+
+func DocsSingleton() Singleton {
+ return &docsSingleton{}
+}
+
+type docsSingleton struct{}
+
+func primaryBuilderPath(ctx SingletonContext) Path {
+ primaryBuilder, err := filepath.Rel(ctx.Config().BuildDir(), os.Args[0])
+ if err != nil {
+ ctx.Errorf("path to primary builder %q is not in build dir %q",
+ os.Args[0], ctx.Config().BuildDir())
+ }
+
+ return PathForOutput(ctx, primaryBuilder)
+}
+
+func (c *docsSingleton) GenerateBuildActions(ctx SingletonContext) {
+ // Generate build system docs for the primary builder. Generating docs reads the source
+ // files used to build the primary builder, but that dependency will be picked up through
+ // the dependency on the primary builder itself. There are no dependencies on the
+ // Blueprints files, as any relevant changes to the Blueprints files would have caused
+ // a rebuild of the primary builder.
+ docsFile := PathForOutput(ctx, "docs", "soong_build.html")
+ primaryBuilder := primaryBuilderPath(ctx)
+ soongDocs := ctx.Rule(pctx, "soongDocs",
+ blueprint.RuleParams{
+ Command: fmt.Sprintf("%s --soong_docs %s %s",
+ primaryBuilder.String(), docsFile.String(), strings.Join(os.Args[1:], " ")),
+ CommandDeps: []string{primaryBuilder.String()},
+ Description: fmt.Sprintf("%s docs $out", primaryBuilder.Base()),
+ })
+
+ ctx.Build(pctx, BuildParams{
+ Rule: soongDocs,
+ Output: docsFile,
+ })
+
+ // Add a phony target for building the documentation
+ ctx.Build(pctx, BuildParams{
+ Rule: blueprint.Phony,
+ Output: PathForPhony(ctx, "soong_docs"),
+ Input: docsFile,
+ })
+}