ebb0b574c8
This was caught while running the soong_build docs action under Bazel as
ninja executor. Since the config file is not an explicit input to the
action, it's not present in Bazel's execution root during action
execution time, leading to a missing file error. To fix it, add the file
as an input to the action, if it's configured in product variables.
New soong_build statement:
build out/soong/docs/soong_build.html: s.writedocs.soongDocs $
out/.module_paths/Android.bp.list out/soong/soong.variables $
out/soong/dexpreopt.config | out/soong/.bootstrap/bin/soong_build
outDir = out/soong/docs
Test: m
Test: USE_BAZEL=1 m
Bug: 161958189
Fixes: 161958189
Change-Id: I2bf264e848bb29ac91f4196fbe9c4ecf3cea8a2c
85 lines
2.7 KiB
Go
85 lines
2.7 KiB
Go
// 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) {
|
|
var deps Paths
|
|
deps = append(deps, pathForBuildToolDep(ctx, ctx.Config().moduleListFile))
|
|
deps = append(deps, pathForBuildToolDep(ctx, ctx.Config().ProductVariablesFileName))
|
|
|
|
// The dexpreopt configuration may not exist, but if it does, it's a dependency
|
|
// of soong_build.
|
|
dexpreoptConfigPath := ctx.Config().DexpreoptGlobalConfigPath(ctx)
|
|
if dexpreoptConfigPath.Valid() {
|
|
deps = append(deps, dexpreoptConfigPath.Path())
|
|
}
|
|
|
|
// 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("rm -f ${outDir}/* && %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()),
|
|
},
|
|
"outDir")
|
|
|
|
ctx.Build(pctx, BuildParams{
|
|
Rule: soongDocs,
|
|
Output: docsFile,
|
|
Inputs: deps,
|
|
Args: map[string]string{
|
|
"outDir": PathForOutput(ctx, "docs").String(),
|
|
},
|
|
})
|
|
|
|
// Add a phony target for building the documentation
|
|
ctx.Phony("soong_docs", docsFile)
|
|
}
|