Skip to content
Snippets Groups Projects
Commit 5c0142d8 authored by Andre Maroneze's avatar Andre Maroneze
Browse files

[Doc] add more Landmarks examples in devman

parent 1c3c2f62
No related branches found
No related tags found
No related merge requests found
...@@ -16,6 +16,7 @@ ...@@ -16,6 +16,7 @@
\usepackage{makeidx} \usepackage{makeidx}
\usepackage{graphicx} \usepackage{graphicx}
\usepackage{enumerate} \usepackage{enumerate}
\usepackage{longtable}
\usepackage{varwidth} \usepackage{varwidth}
\usepackage{tikz} \usepackage{tikz}
\usetikzlibrary{fit} \usetikzlibrary{fit}
......
...@@ -841,8 +841,7 @@ to your needs. See \texttt{ocamlmerlin -help} for the list of flags. ...@@ -841,8 +841,7 @@ to your needs. See \texttt{ocamlmerlin -help} for the list of flags.
\subsection{Pre-defined macros for tests commands}\label{sec:ptests-macros} \subsection{Pre-defined macros for tests commands}\label{sec:ptests-macros}
Ptests pre-defines a certain number of macros for each test about to be run. Ptests pre-defines a certain number of macros for each test about to be run.
Figure~\ref{fig:ptests-macros} gives their definition. Figure~\ref{fig:ptests-macros} gives their definition.
\begin{figure}[htbp] \begin{longtable}{|p{4.5cm}|p{10cm}|}
\begin{tabular}{|p{4.5cm}|p{10cm}|}
\hline \hline
Name & Expansion \\ Name & Expansion \\
\hline \hline
...@@ -897,9 +896,8 @@ one for regular tests (if more than one \verb|OPT|).\\ ...@@ -897,9 +896,8 @@ one for regular tests (if more than one \verb|OPT|).\\
\hline \hline
\verb|frama-c-exe| & set to the value of the \verb|TOPLEVEL_PATH| variable from \verb|./tests/ptests_config| file\\ \verb|frama-c-exe| & set to the value of the \verb|TOPLEVEL_PATH| variable from \verb|./tests/ptests_config| file\\
\hline \hline
\end{tabular}
\caption{Predefined macros for ptests}\label{fig:ptests-macros} \caption{Predefined macros for ptests}\label{fig:ptests-macros}
\end{figure} \end{longtable}
\section{Profiling with Landmarks} \label{refman:landmarks}\codeidxdef{Landmarks} \section{Profiling with Landmarks} \label{refman:landmarks}\codeidxdef{Landmarks}
...@@ -937,6 +935,17 @@ For quick usage of the library: ...@@ -937,6 +935,17 @@ For quick usage of the library:
Commonly used options include \verb+output=landmarks.log+ to output the result Commonly used options include \verb+output=landmarks.log+ to output the result
to a file instead of \texttt{stderr}. to a file instead of \texttt{stderr}.
To instrument a single file: add \verb+[@@@landmark "auto"]+ at the beginning
of the file.
To instrument a single function: add \verb+[@landmark]+ after the \texttt{let},
e.g.:
\begin{lstlisting}
let[@landmark] add_visitor vis =
\end{lstlisting}
Check \url{https://github.com/LexiFi/landmarks} for its documentation. Check \url{https://github.com/LexiFi/landmarks} for its documentation.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment