Skip to content

Commit

Permalink
BIGTOP-4059: Add Documentation for Parallel Maven Compilation in Bigt…
Browse files Browse the repository at this point in the history
…op (apache#1232)

Co-authored-by: jialiang <[email protected]>
  • Loading branch information
JiaLiangC and JiaLiangC authored Jan 30, 2024
1 parent d481826 commit fc93b76
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,15 @@ __On all systems, Building Apache Bigtop requires certain set of tools__
By default, the installation path of components will follow [Filesystem Hierarchy Standard](https://refspecs.linuxfoundation.org/FHS_3.0/fhs/index.html), but you can use `-PparentDir=/path` to add prefix to the path, in this example, prefix `/path/${bigtop_version}` will be added

To avoid download wrong version of components when you have multiple repositories configured on your machine, you can use `-PpkgSuffix` to add bigtop version to package suffix, for example, package name `zookeeper` will be changed to `zookeeper_3_2_0` when using `Bigtop-3.2.0`

* __Enabling Parallel Build for packages(BIGTOP-4044)__

Apache Bigtop defaults to non-parallel builds. Use -PbuildThreads=2C to activate Maven's parallel build feature and expedite compilation for compatible components.

Append a digit and 'C' to -PbuildThreads= to set the CPU core count for concurrent builds.

Consult the bigtop.bom file to verify component compatibility with parallel builds; those marked with maven_parallel_build = true support this option.

* __Building local YUM/APT repositories__ : `gradle [yum|apt]`

* __Recommended build environments__
Expand Down
5 changes: 4 additions & 1 deletion bigtop.bom
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,10 @@
packaging = 'rpm' // *optional* If this component can be built only as either
// DEB or RPM, specify that packaging format explicitly.
// If both formats are supported, omit this option.
maven_parallel_build = true
maven_parallel_build = true // *optional* maven_parallel_build indicates whether the component can be built in parallel.
// Components with this flag can have the Maven parallel build parameter -PbuildThreads=2C or -PbuildThreads=2
// passed during compilation to enable parallel building and speed up the process.

}
}
}
Expand Down

0 comments on commit fc93b76

Please sign in to comment.