This is an automated email from the ASF dual-hosted git repository.
tqchen pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tvm-tirx.git
The following commit(s) were added to refs/heads/main by this push:
new 962808bf [DOCS] Simplify source build and release prerequisites (#14)
962808bf is described below
commit 962808bf32fa2fcb589dbe7e61ad50eb8bd638f8
Author: Tianqi Chen <[email protected]>
AuthorDate: Wed Oct 21 14:17:30 2026 -0400
[DOCS] Simplify source build and release prerequisites (#14)
Use the platform tar command with GNU/BSD-compatible Git metadata
exclusions when creating source releases. Simplify the source-build
environment example and let scikit-build-core supply Ninja as needed for
isolated builds, while retaining the documented CMake minimum.
---
docs/dev/release_process.rst | 9 +++------
docs/dev/source_build.rst | 6 +++---
2 files changed, 6 insertions(+), 9 deletions(-)
diff --git a/docs/dev/release_process.rst b/docs/dev/release_process.rst
index a48a7507..4159dbb4 100644
--- a/docs/dev/release_process.rst
+++ b/docs/dev/release_process.rst
@@ -33,13 +33,9 @@ publishing release artifacts.
export TIRX_RELEASE_VERSION="v0.1.0"
export ASF_USERNAME="your-apache-username"
- - Tools: ``git``, ``svn``, ``gpg``, ``gtar``, and ``shasum``.
+ - Tools: ``git``, ``svn``, ``gpg``, ``tar``, and ``shasum``.
- An ASF account and a signing key published in the project's ``KEYS`` file.
-.. important::
-
- These examples use GNU tar as ``gtar`` on macOS. Use ``tar`` on Linux.
-
Pre-release checklist (Step 0)
------------------------------
@@ -75,7 +71,8 @@ This builds and signs the source release artifacts under
(
cd "$_workdir"
git clone --recursive --branch "$_ver"
https://github.com/apache/tvm-tirx.git "$_source_dir"
- gtar --exclude-vcs -czf "$_tarball" "$_source_dir"
+ tar --exclude=.git --exclude=.gitignore --exclude=.gitattributes \
+ --exclude=.gitmodules -czf "$_tarball" "$_source_dir"
gpg --armor --output "$_tarball.asc" --detach-sig "$_tarball"
shasum -a 512 "$_tarball" > "$_tarball.sha512"
gpg --verify "$_tarball.asc" "$_tarball"
diff --git a/docs/dev/source_build.rst b/docs/dev/source_build.rst
index c548de2b..58f719c2 100644
--- a/docs/dev/source_build.rst
+++ b/docs/dev/source_build.rst
@@ -25,7 +25,7 @@ This guide provides instructions on how to build the TIRx
package from source.
- Python: 3.10 or newer.
- Compiler: a C++20-capable GCC, Clang, or MSVC toolchain.
- - Build tools: Git, CMake 3.26+, Ninja, and uv.
+ - Build tools: Git, CMake 3.26+, and uv.
- LLVM: development libraries and ``llvm-config`` from LLVM 15 or newer.
On most platforms, you can get LLVM and the build dependencies through
@@ -33,7 +33,7 @@ This guide provides instructions on how to build the TIRx
package from source.
.. code-block:: bash
- mamba create -n tirx-dev -c conda-forge python=3.12 llvmdev
"cmake>=3.26" ninja git uv
+ mamba create -n tirx-dev -c conda-forge python=3.12 llvmdev cmake git uv
mamba activate tirx-dev
llvm-config --version
@@ -65,7 +65,7 @@ Download the source via:
git submodule update --init --recursive
Build the Python package with scikit-build-core, which drives CMake to compile
-the C++ libraries:
+the C++ libraries and supplies Ninja when needed in the default isolated build:
.. code-block:: bash
