From 9a70020d484fd197607d47a213a6636314b5ee5a Mon Sep 17 00:00:00 2001 From: Pawel Date: Mon, 21 Sep 2020 04:28:51 -0700 Subject: [PATCH] Adding a small build tip. --- toolkit/docs/building/building.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/toolkit/docs/building/building.md b/toolkit/docs/building/building.md index 82b311597cd..780a8860f8a 100644 --- a/toolkit/docs/building/building.md +++ b/toolkit/docs/building/building.md @@ -84,6 +84,11 @@ By default all build commands are executed from inside the `./toolkit` folder. A few one-time steps can be run now (they will re-run automatically later if needed) Remote files are generally only available for release branches. + +**IMPORTANT:** HEAD of many branches is not guaranteed to build successfully. To avoid build issues it is recommended to check out the `[BRANCH-NAME]-stable` tag. + +Example: to safely build the `1.0` branch check out the `1.0-stable` tag. + ```bash # Get the source code git clone https://github.com/microsoft/CBL-Mariner.git