github.com/westcoastroms/westcoastroms-build@v0.0.0-20190928114312-2350e5a73030/build/soong/android/writedocs.go (about)

     1  // Copyright 2015 Google Inc. All rights reserved.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package android
    16  
    17  import (
    18  	"fmt"
    19  	"os"
    20  	"path/filepath"
    21  	"strings"
    22  
    23  	"github.com/google/blueprint"
    24  )
    25  
    26  func init() {
    27  	RegisterSingletonType("writedocs", DocsSingleton)
    28  }
    29  
    30  func DocsSingleton() Singleton {
    31  	return &docsSingleton{}
    32  }
    33  
    34  type docsSingleton struct{}
    35  
    36  func primaryBuilderPath(ctx SingletonContext) Path {
    37  	primaryBuilder, err := filepath.Rel(ctx.Config().BuildDir(), os.Args[0])
    38  	if err != nil {
    39  		ctx.Errorf("path to primary builder %q is not in build dir %q",
    40  			os.Args[0], ctx.Config().BuildDir())
    41  	}
    42  
    43  	return PathForOutput(ctx, primaryBuilder)
    44  }
    45  
    46  func (c *docsSingleton) GenerateBuildActions(ctx SingletonContext) {
    47  	// Generate build system docs for the primary builder.  Generating docs reads the source
    48  	// files used to build the primary builder, but that dependency will be picked up through
    49  	// the dependency on the primary builder itself.  There are no dependencies on the
    50  	// Blueprints files, as any relevant changes to the Blueprints files would have caused
    51  	// a rebuild of the primary builder.
    52  	docsFile := PathForOutput(ctx, "docs", "soong_build.html")
    53  	primaryBuilder := primaryBuilderPath(ctx)
    54  	soongDocs := ctx.Rule(pctx, "soongDocs",
    55  		blueprint.RuleParams{
    56  			Command: fmt.Sprintf("%s --soong_docs %s %s",
    57  				primaryBuilder.String(), docsFile.String(), strings.Join(os.Args[1:], " ")),
    58  			CommandDeps: []string{primaryBuilder.String()},
    59  			Description: fmt.Sprintf("%s docs $out", primaryBuilder.Base()),
    60  		})
    61  
    62  	ctx.Build(pctx, BuildParams{
    63  		Rule:   soongDocs,
    64  		Output: docsFile,
    65  	})
    66  
    67  	// Add a phony target for building the documentation
    68  	ctx.Build(pctx, BuildParams{
    69  		Rule:   blueprint.Phony,
    70  		Output: PathForPhony(ctx, "soong_docs"),
    71  		Input:  docsFile,
    72  	})
    73  }