Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit ca68c496 authored by Matthew Maurer's avatar Matthew Maurer
Browse files

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
parent 0dd067d3

rust/doc.go

+11 −1
Original line number Diff line number Diff line
@@ -29,6 +29,14 @@ func RustdocSingleton() android.Singleton { 
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
@@ -36,8 +44,10 @@ func (n *rustdocSingleton) GenerateBuildActions(ctx android.SingletonContext) { 


		if m, ok := module.(*Module); ok {

			if m.docTimestampFile.Valid() {

				ctx.Phony("rustdoc", m.docTimestampFile.Path())

				zipCmd.Implicit(m.docTimestampFile.Path())

			}

		}

	})

	rule.Build("rustdoc-zip", "Zipping all built Rust documentation...")

	ctx.Phony("rustdoc", docZip)

}

scripts/build-rustdocs.sh

+1 −1
Original line number Diff line number Diff line
@@ -27,5 +27,5 @@ m rustdoc 


if [ -n "${DIST_DIR}" ]; then

    mkdir -p ${DIST_DIR}

    cp -r ${OUT_DIR}/soong/rustdoc $DIST_DIR/rustdoc

    cp ${OUT_DIR}/soong/rustdoc.zip $DIST_DIR

fi