This is an automated email from the ASF dual-hosted git repository. yuanz pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/incubator-teaclave-trustzone-sdk.git
commit 93507c965414333488bf48cdbc23eb9ae41a7fda Author: Yuan Zhuang <[email protected]> AuthorDate: Tue Oct 15 16:07:40 2024 +0800 Create migrating-to-new-building-env.md --- docs/migrating-to-new-building-env.md | 57 +++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) diff --git a/docs/migrating-to-new-building-env.md b/docs/migrating-to-new-building-env.md new file mode 100644 index 0000000..6673241 --- /dev/null +++ b/docs/migrating-to-new-building-env.md @@ -0,0 +1,57 @@ +--- +permalink: /trustzone-sdk-docs/migrating-to-new-building-env.md +--- + +## Migration Guide: Moving from `master` to `main` Branch (Post-Oct 2024) + +Since the `main` branch (after October 2024) introduces breaking changes +to the build environment, if users of the legacy `master` branch want to +keep upstream or use a new version of the Rust toolchain, they will need +to follow these steps to migrate their TA to the new environment. + +### Step 1: Migrate Old Code to the New Environment + +To migrate an example project (e.g., `tls_server-rs` in `examples/`), you +can refer to the following shell script and adjust it for your TA: + +```bash +TARGET_EXAMPLE="tls_server-rs" +OLD_ROOT_PATH="/path/to/old/sdk" +NEW_PATH="/path/to/current/sdk" + +# Duplicate the hello-world example in the new path as a template +cp -r ${NEW_PATH}/examples/hello_world-rs ${NEW_PATH}/examples/${TARGET_EXAMPLE} + +# Remove the source code directory and copy from the old path to the new path +# including: src/ and Cargo.toml in host, ta, proto +(cd ${NEW_PATH}/examples/${TARGET_EXAMPLE}/host && rm -rf src/ Cargo.* && \ +cp -r ${OLD_ROOT_PATH}/examples/${TARGET_EXAMPLE}/host/src . && \ +cp ${OLD_ROOT_PATH}/examples/${TARGET_EXAMPLE}/host/Cargo.toml .) +(cd ${NEW_PATH}/examples/${TARGET_EXAMPLE}/ta && rm -rf src/ Cargo.* && \ +cp -r ${OLD_ROOT_PATH}/examples/${TARGET_EXAMPLE}/ta/src . && \ +cp ${OLD_ROOT_PATH}/examples/${TARGET_EXAMPLE}/ta/Cargo.toml .) +(cd ${NEW_PATH}/examples/${TARGET_EXAMPLE}/proto && rm -rf src/ Cargo.* && \ +cp -r ${OLD_ROOT_PATH}/examples/${TARGET_EXAMPLE}/proto/src . && \ +cp ${OLD_ROOT_PATH}/examples/${TARGET_EXAMPLE}/proto/Cargo.toml .) + +# Copy the UUID file from the old path to the new path +cp ${OLD_ROOT_PATH}/examples/${TARGET_EXAMPLE}/uuid.txt \ +${NEW_PATH}/examples/${TARGET_EXAMPLE}/uuid.txt + +# Update binary names in host/Cargo.toml and host/Makefile +sed -i "s/hello_world-rs/${TARGET_EXAMPLE}/g" \ +${NEW_PATH}/examples/${TARGET_EXAMPLE}/host/Cargo.toml +sed -i "s/hello_world-rs/${TARGET_EXAMPLE}/g" \ +${NEW_PATH}/examples/${TARGET_EXAMPLE}/host/Makefile +``` + +### Step 2: Update `Cargo.toml` + +You may need to update your `Cargo.toml` to use newer versions of crates. +The Rust toolchain for the current build environment can be found in +`rust-toolchain.toml`. + +### Step 3: Build and Fix Errors + +After updating, run the build process. Some errors might occur due to the +crate version upgrades—fix them as necessary. --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
