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-ffi.git
The following commit(s) were added to refs/heads/main by this push:
new 4f1cbdc [DOCS] Clarify CStrParts error handling usage (#625)
4f1cbdc is described below
commit 4f1cbdc1d21cf547678946856d2625701f50b05b
Author: Tianqi Chen <[email protected]>
AuthorDate: Wed Jun 17 11:33:49 2026 -0400
[DOCS] Clarify CStrParts error handling usage (#625)
Summary:
- Clarify that TVMFFIErrorSetRaisedFromCStrParts is for assembling error
messages from reusable parts, not for non-null-terminated strings with
explicit lengths.
---
docs/concepts/abi_overview.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/concepts/abi_overview.rst b/docs/concepts/abi_overview.rst
index b2e1777..1d690ea 100644
--- a/docs/concepts/abi_overview.rst
+++ b/docs/concepts/abi_overview.rst
@@ -475,7 +475,7 @@ The following C code sets the TLS error and returns ``-1``
via :cpp:func:`TVMFFI
:start-after: [Error.RaiseException.begin]
:end-before: [Error.RaiseException.end]
-For non-null-terminated strings, use
:cpp:func:`TVMFFIErrorSetRaisedFromCStrParts`, which accepts explicit string
lengths.
+When an error message is assembled from reusable parts, use
:cpp:func:`TVMFFIErrorSetRaisedFromCStrParts` to avoid duplicating common
message fragments.
.. note::
You rarely need to create a :cpp:class:`~tvm::ffi::ErrorObj` directly.
