mirror-llvm-project/orc-rt/docs
Lang Hames 4df68548fc
[orc-rt] Reorder wrapper-fn args to trailing-callback style. (#212243)
Bring the wrapper-function call and return prototypes into line with the
convention adopted for orc_rt_Session_callController: the session handle
comes first, then the payload buffer, then the completion callback
immediately followed by its threaded token, with the token last.

  orc_rt_WrapperFunctionReturn: (S, CallId, ResultBytes)
                             -> (S, ResultBytes, CallId)
  orc_rt_WrapperFunction:       (S, CallId, Return, ArgBytes)
                             -> (S, ArgBytes, Return, CallId)

The C++ adapters that mirror these signatures are updated to match --
WrapperFunction::handle, SPSWrapperFunction::handle, the
ORC_RT_SPS_WRAPPER macro, and StructuredYield -- along with the Session
dispatch path and the affected unit tests. No functional change beyond
argument order.
2026-07-28 17:14:30 +10:00
..
Building-orc-rt.md
CMakeLists.txt
CodingConventions.md [orc-rt] Reorder wrapper-fn args to trailing-callback style. (#212243) 2026-07-28 17:14:30 +10:00
conf.py [docs] Create utils/docs (#203962) 2026-06-24 15:12:48 -04:00
Design.md [orc-rt] Drop callManagedCodeAsync; tokens guard execution (#210508) 2026-07-18 23:14:34 +10:00
ErrorHandling.md [orc-rt] Add Error-handling documentation. (#177547) 2026-01-27 14:52:49 +11:00
index.md [orc-rt] Add a coding conventions doc (#208623) 2026-07-10 16:33:41 +10:00
README.txt

ORC-RT Documentation
====================

The ORC-RT documentation is written using the Sphinx documentation generator. It is
currently tested with Sphinx 5.3.0.

To build the documents into html configure ORC-RT with the following cmake options:

  * -DLLVM_ENABLE_SPHINX=ON
  * -DORC_RT_INCLUDE_DOCS=ON

After configuring ORC-RT with these options the make rule `docs-orc-rt-html`
should be available.