From 9c9c11ae9e89b858fb29494d3913a996f8c60cd8 Mon Sep 17 00:00:00 2001 From: Martijn Courteaux Date: Wed, 23 Mar 2022 18:05:22 +0100 Subject: Warn the user about capstone deprecated branch in the manual. --- manual/tracy.tex | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/manual/tracy.tex b/manual/tracy.tex index 7f71c122..95922262 100644 --- a/manual/tracy.tex +++ b/manual/tracy.tex @@ -725,7 +725,7 @@ Due to the memory requirements for data storage, the Tracy server is only suppos To build the application contained in the \texttt{profiler} directory, you will need to install external libraries, which are not bundled with Tracy. -\subparagraph{Capstone library} At the time of writing, the capstone library is in a bit of disarray. The officially released version 4.0.2 can't disassemble some AVX instructions, which are successfully parsed by the \texttt{next} branch. However, the \texttt{next} branch somehow lost information about input/output registers for some functions. You may want to explore the various available versions to find one that suits your needs the best. +\subparagraph{Capstone library} At the time of writing, the capstone library is in a bit of disarray. The officially released version 4.0.2 can't disassemble some AVX instructions, which are successfully parsed by the \texttt{next} branch. However, the \texttt{next} branch somehow lost information about input/output registers for some functions. You may want to explore the various available versions to find one that suits your needs the best. Note that only the \texttt{next} branch is actively maintained. Be aware that your package manager might distribute the deprecated \texttt{master} branch. \paragraph{Windows} @@ -748,7 +748,7 @@ vcpkg install --triplet x64-windows-static freetype glfw3 capstone[arm,arm64,x86 \paragraph{Unix} -On Unix systems you will need to install the \texttt{pkg-config} utility and the following libraries: \texttt{glfw}, \texttt{freetype}, \texttt{capstone}, \texttt{GTK3}. Some Linux distributions will require you to add a \texttt{lib} prefix and a \texttt{-dev}, or \texttt{-devel} postfix to library names. You may also need to add a seemingly random number to the library name (for example: \texttt{freetype2}, or \texttt{freetype6}). The GTK library could be installed as \texttt{libgtk-3-dev} on some systems. How fun! +On Unix systems you will need to install the \texttt{pkg-config} utility and the following libraries: \texttt{glfw}, \texttt{freetype}, \texttt{capstone}, \texttt{GTK3}. Some Linux distributions will require you to add a \texttt{lib} prefix and a \texttt{-dev}, or \texttt{-devel} postfix to library names. You may also need to add a seemingly random number to the library name (for example: \texttt{freetype2}, or \texttt{freetype6}). The GTK library could be installed as \texttt{libgtk-3-dev} on some systems. Be aware that your package manager might distribute the deprecated \texttt{master}-branch version of \texttt{capstone}, and a build from source from the \texttt{next}-branch might be necesarry for you. Have fun! In addition to the beforementioned libraries, you might also have to install the \texttt{tbb} library\footnote{Technically this is not a dependency of Tracy but rather of \texttt{libstdc++} but it may still not be installed by default.}. @@ -3432,7 +3432,7 @@ Additionally, you may use the \emph{Mode} selector to decide what content should \item \emph{Combined} -- both source code and disassembly will be listed next to each other. \end{itemize} -Some modes may be unavailable in some circumstances (missing or outdated source files, lack of machine code). +Some modes may be unavailable in some circumstances (missing or outdated source files, lack of machine code). In case the \emph{Assembly} mode is unavailable, this might be due to the \texttt{capstone} disassmbly engine failing to disassamble the machine instructions. See section~\ref{buildingserver} for more information. \paragraph{Source mode} @@ -3742,7 +3742,7 @@ The following libraries are included with and used by the Tracy Profiler. Entrie \item getopt\_port -- \url{https://github.com/kimgr/getopt\_port} \item libbacktrace \faStar{} -- \url{https://github.com/ianlancetaylor/libbacktrace} \item Zstandard -- \url{https://github.com/facebook/zstd} -\item capstone -- \url{https://github.com/aquynh/capstone} +\item capstone -- \url{https://github.com/capstone-engine/capstone} \end{itemize} \item 2-clause BSD license -- cgit v1.2.3 From 2e4c63c6dd8fb7d883388f578e74c91449fab831 Mon Sep 17 00:00:00 2001 From: Bartosz Taudul Date: Wed, 23 Mar 2022 18:09:16 +0100 Subject: Fix typos. --- manual/tracy.tex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/manual/tracy.tex b/manual/tracy.tex index 95922262..d11a4b96 100644 --- a/manual/tracy.tex +++ b/manual/tracy.tex @@ -3432,7 +3432,7 @@ Additionally, you may use the \emph{Mode} selector to decide what content should \item \emph{Combined} -- both source code and disassembly will be listed next to each other. \end{itemize} -Some modes may be unavailable in some circumstances (missing or outdated source files, lack of machine code). In case the \emph{Assembly} mode is unavailable, this might be due to the \texttt{capstone} disassmbly engine failing to disassamble the machine instructions. See section~\ref{buildingserver} for more information. +Some modes may be unavailable in some circumstances (missing or outdated source files, lack of machine code). In case the \emph{Assembly} mode is unavailable, this might be due to the \texttt{capstone} disassembly engine failing to disassemble the machine instructions. See section~\ref{buildingserver} for more information. \paragraph{Source mode} -- cgit v1.2.3