From 0927acd80c96fa2e6ab78b34eb1f57d652159ecf Mon Sep 17 00:00:00 2001 From: Jacob Gordon Date: Mon, 23 Dec 2024 20:42:12 +0000 Subject: [PATCH] docs(development.md): restructures the "Initiate Build" section - less repetitive - emphasizes that the targets can be superimposed --- docs/development.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/docs/development.md b/docs/development.md index e18e5f4cba14..0af745e708d6 100644 --- a/docs/development.md +++ b/docs/development.md @@ -183,31 +183,34 @@ For workflows that demand frequent rebuilds, the following steps will allow you ### Initiate Build 1. [Configure the build](#configure-for-building) if you haven't already done so. -1. Use one of the following commands to build the project: - - Build everything (including LLVM if in-tree) +1. Append the base command: - ```shell - cmake --build build - ``` + ```shell + cmake --build build + ``` - - Build just torch-mlir (not all of LLVM) +1. **If you want to...** + - **...build _just_ torch-mlir (not all of LLVM)**, append: ```shell - cmake --build build --target tools/torch-mlir/all + --target tools/torch-mlir/all ``` - - Run unit tests. + - NOTE: skipping this will result in _everything_ being built, which includes LLVM if configured as "in-tree" + - **...run unit tests**, append: ```shell - cmake --build build --target check-torch-mlir + --target check-torch-mlir ``` - - Run Python regression tests. + - **...run Python regression tests**, append: ```shell - cmake --build build --target check-torch-mlir-python + --target check-torch-mlir-python ``` +1. Execute the command with the desired targets, if any. + ## Setup Python Environment to export the built Python packages ### Linux and macOS