platform_build_soong/rust/doc.go
Matthew Maurer ca68c49621 rust: doc: Zip up docs when done
Fetching artifacts from the build server doesn't go well with large
numbers of files in nested directories.

Produce an additional rustdoc.zip artifact to make this easier.

This change also prevents ${DIST} from receiving the unpacked rustdoc
site. This can be changed if b/188822051 is fixed.

Bug: 162741284
Test: m rustdoc; check resulting zip contents manually
Change-Id: I80b6a8fa6e274d2d8c3419d8734251afd4d7dba7
2021-08-20 13:08:16 -07:00

53 lines
1.5 KiB
Go

// Copyright 2021 The Android Open Source Project
//
// 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 rust
import (
"android/soong/android"
)
func init() {
android.RegisterSingletonType("rustdoc", RustdocSingleton)
}
func RustdocSingleton() android.Singleton {
return &rustdocSingleton{}
}
type rustdocSingleton struct{}
func (n *rustdocSingleton) GenerateBuildActions(ctx android.SingletonContext) {
docDir := android.PathForOutput(ctx, "rustdoc")
docZip := android.PathForOutput(ctx, "rustdoc.zip")
rule := android.NewRuleBuilder(pctx, ctx)
zipCmd := rule.Command().BuiltTool("soong_zip").
FlagWithOutput("-o ", docZip).
FlagWithArg("-C ", docDir.String()).
FlagWithArg("-D ", docDir.String())
ctx.VisitAllModules(func(module android.Module) {
if !module.Enabled() {
return
}
if m, ok := module.(*Module); ok {
if m.docTimestampFile.Valid() {
zipCmd.Implicit(m.docTimestampFile.Path())
}
}
})
rule.Build("rustdoc-zip", "Zipping all built Rust documentation...")
ctx.Phony("rustdoc", docZip)
}