Update synopsis

NVIDIA · Nov 21, 2023 · 88e136e · 88e136e
1 parent 6bb0b55
commit 88e136e
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -112,6 +112,16 @@ Examples:
     Runs a basic build with default settings, i.e., builds tests, examples, and benchmarks.
     Build files will be written to <repo_root>/build/local and symlinked to <repo_root>/build/latest.
 
+  Custom Build Infix Directory:
+    $ ci/build.sh -i my_build
+    Build files will be written the <repo_root>/build/my_build directory and symlinked to <repo_root>/build/latest.
+
+  Parallel Build with Specific CUDA Architecture and CUDA Compiler:
+    $ PARALLEL_LEVEL=8 ci/build.sh --cuda /my_cuda_compiler/nvcc --arch 70;80
+    $ ci/build.sh -p 8 --cuda /my_cuda_compiler/nvcc --arch 70;80
+    Specifies parallel build level of 8 and CUDA architecture 70 and 80 with the specified CUDA compiler.
+    Build files will be written to <repo_root>/build/local and symlinked to <repo_root>/build/latest.
+
   Debug Build with Tests and Examples:
     $ CXX=g++-9 ci/build.sh -t -e -d
     $ ci/build.sh --cxx g++-9 -t -e -d
@@ -121,21 +131,12 @@ Examples:
   Custom Build Directory with Benchmarks:
     $ BUILD_BENCHMARKS=ON ci/build.sh --prefix /custom/build --infix my_build
     $ ci/build.sh --prefix /custom/build --infix my_build -b
+    Builds benchmarks.
     Build files will be written to /custom/build/my_build and symlinked to /custom/build/latest.
 
-  Custom Build Infix Directory:
-    $ ci/build.sh -i my_build
-    Builds with benchmarks in the <repo_root>/build/my_build directory and symlinked to <repo_root>/build/latest.
-
-  Parallel Build with Specific CUDA Architecture and CUDA Compiler:
-    $ PARALLEL_LEVEL=8 ci/build.sh --cuda /my_cuda_compiler/nvcc --arch 70;80
-    $ ci/build.sh -p 8 --cuda /my_cuda_compiler/nvcc --arch 70;80
-    Specifies parallel build level of 8 and CUDA architecture 70 and 80 with the specified CUDA compiler.
-    Build files will be written to <repo_root>/build/local and symlinked to <repo_root>/build/latest.
-
   Verbose Mode for Debugging:
     $ ci/build.sh -v --std 17
-    Enables verbose mode for detailed build process output and build with C++17 standard.
+    Enables verbose mode for detailed output and builds with C++17 standard.
     Build files will be written to <repo_root>/build/local and symlinked to <repo_root>/build/latest.
 ```
 

diff --git a/ci/build.sh b/ci/build.sh
@@ -76,6 +76,16 @@ function usage {
     echo "    Runs a basic build with default settings, i.e., builds tests, examples, and benchmarks."
     echo "    Build files will be written to <repo_root>/build/local and symlinked to <repo_root>/build/latest."
     echo
+    echo "  Custom Build Infix Directory:"
+    echo "    $ $0 -i my_build"
+    echo "    Build files will be written to the <repo_root>/build/my_build directory and symlinked to <repo_root>/build/latest."
+    echo
+    echo "  Parallel Build with Specific CUDA Architecture and CUDA Compiler:"
+    echo "    $ PARALLEL_LEVEL=8 $0 --cuda /my_cuda_compiler/nvcc --arch 70;80"
+    echo "    $ $0 -p 8 --cuda /my_cuda_compiler/nvcc --arch 70;80"
+    echo "    Specifies parallel build level of 8 and CUDA architecture 70 and 80 with the specified CUDA compiler."
+    echo "    Build files will be written to <repo_root>/build/local and symlinked to <repo_root>/build/latest."
+    echo
     echo "  Debug Build with Tests and Examples:"
     echo "    $ CXX=g++-9 $0 -t -e -d"
     echo "    $ $0 --cxx g++-9 -t -e -d"
@@ -85,21 +95,12 @@ function usage {
     echo "  Custom Build Directory with Benchmarks:"
     echo "    $ BUILD_BENCHMARKS=ON $0 --prefix /custom/build --infix my_build"
     echo "    $ $0 --prefix /custom/build --infix my_build -b"
+    echo "    Builds benchmarks only."
     echo "    Build files will be written to /custom/build/my_build and symlinked to /custom/build/latest."
     echo
-    echo "  Custom Build Infix Directory:"
-    echo "    $ $0 -i my_build"
-    echo "    Builds with benchmarks in the <repo_root>/build/my_build directory and symlinked to <repo_root>/build/latest."
-    echo
-    echo "  Parallel Build with Specific CUDA Architecture and CUDA Compiler:"
-    echo "    $ PARALLEL_LEVEL=8 $0 --cuda /my_cuda_compiler/nvcc --arch 70;80"
-    echo "    $ $0 -p 8 --cuda /my_cuda_compiler/nvcc --arch 70;80"
-    echo "    Specifies parallel build level of 8 and CUDA architecture 70 and 80 with the specified CUDA compiler."
-    echo "    Build files will be written to <repo_root>/build/local and symlinked to <repo_root>/build/latest."
-    echo
     echo "  Verbose Mode for Debugging:"
     echo "    $ $0 -v --std 17"
-    echo "    Enables verbose mode for detailed build process output and build with C++17 standard."
+    echo "    Enables verbose mode for detailed output and builds with C++17 standard."
     echo "    Build files will be written to <repo_root>/build/local and symlinked to <repo_root>/build/latest."
     echo
     exit 1