You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: manual/tracy.tex
+16-23Lines changed: 16 additions & 23 deletions
Original file line number
Diff line number
Diff line change
@@ -2392,37 +2392,30 @@ \subsubsection{Bindings}
2392
2392
2393
2393
\subsubsection{Building the Python package}
2394
2394
2395
-
To build the Python package, you will need to use the CMake build system to compile the Tracy-Client.
2396
-
The CMake option \texttt{-D TRACY\_CLIENT\_PYTHON=ON} is used to enable the generation of the Python bindings in conjunction with a mandatory creation of a shared Tracy-Client library via one of the CMake options \texttt{-D BUILD\_SHARED\_LIBS=ON} or \texttt{-D DEFAULT\_STATIC=OFF}.
2397
-
2398
-
The following other variables are available in addition:
2399
-
2400
-
\begin{itemize}
2401
-
\item\texttt{EXTERNAL\_PYBIND11} --- Can be used to disable the download of pybind11 when Tracy is embedded in another CMake project that already uses pybind11.
2402
-
\item\texttt{TRACY\_CLIENT\_PYTHON\_TARGET} --- Optional directory to copy Tracy Python bindings to when Tracy is embedded in another CMake project.
2403
-
\item\texttt{BUFFER\_SIZE} --- The size of the global pointer buffer (defaults to 128) for naming Tracy profiling entities like frame marks, plots, and memory locations.
2404
-
\item\texttt{NAME\_LENGTH} --- The maximum length (defaults to 128) of a name stored in the global pointer buffer.
2405
-
\end{itemize}
2406
-
2407
-
Be aware that the memory allocated by this buffer is global and is not freed, see section~\ref{uniquepointers}.
2408
-
2409
-
See below for example steps to build the Python bindings using CMake:
2395
+
To build the Python package, run the following commands:
The created package will be in the folder \texttt{python/dist}.
2410
+
The following additional CMake options are available when building the Python package:
2411
+
2412
+
\begin{itemize}
2413
+
\item\texttt{BUFFER\_SIZE} --- The size of the global pointer buffer (defaults to 128) for naming Tracy profiling entities like frame marks, plots, and memory locations.
2414
+
\item\texttt{NAME\_LENGTH} --- The maximum length (defaults to 128) of a name stored in the global pointer buffer.
2415
+
\item\texttt{EXTERNAL\_PYBIND11} --- Can be used to disable the download of pybind11 when Tracy is embedded in another CMake project that already uses pybind11.
2416
+
\end{itemize}
2417
+
2418
+
Be aware that the memory allocated by this buffer is global and is not freed, see section~\ref{uniquepointers}.
0 commit comments