From 8340c65dfe81bc24a37f4047c94142a4930e0510 Mon Sep 17 00:00:00 2001 From: bunnie Date: Sun, 2 Oct 2022 03:00:52 +0800 Subject: [PATCH] fixup some comments --- xtask/src/builder.rs | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/xtask/src/builder.rs b/xtask/src/builder.rs index 5177262e0..77ddf8e64 100644 --- a/xtask/src/builder.rs +++ b/xtask/src/builder.rs @@ -243,6 +243,9 @@ impl Builder { self } + /// The builder sets up all the cargo arguments to build a set of packages with features for a respective + /// target and stream. It also runs the build as well. It's meant to be called only by the `build()` + /// method, and it gets called repeatedly to build the kernel, loader, and services. fn builder( &self, packages: &Vec::, @@ -368,7 +371,8 @@ impl Builder { Ok(artifacts) } - /// Consume the builder and execute the task + /// Consume the builder and execute the configured build task. This handles dispatching all configurations, + /// including renode, hosted, and hardware targets. pub fn build(mut self) -> Result<(), DynError> { if self.apps.len() == 0 && self.services.len() == 0 { // no services were specified - don't build anything