From 9eb686fa0b7f741d3746f45a13038d66991aefcc Mon Sep 17 00:00:00 2001 From: Julien Signoles <julien.signoles@cea.fr> Date: Thu, 7 Jan 2021 17:00:15 +0100 Subject: [PATCH] [doc] update docs wrt last commit --- doc/userman/user-analysis.tex | 4 ++-- doc/userman/user-changes.tex | 5 +++++ man/frama-c.1 | 8 +++++++- man/frama-c.1.md | 4 ++++ 4 files changed, 18 insertions(+), 3 deletions(-) diff --git a/doc/userman/user-analysis.tex b/doc/userman/user-analysis.tex index 926fc9eecd7..0ee7a66928a 100644 --- a/doc/userman/user-analysis.tex +++ b/doc/userman/user-analysis.tex @@ -107,8 +107,8 @@ first warning triggered by the kernel. The two following options modify the behavior of output messages: \begin{description} -\item[\optiondef{-}{add-symbolic-path}] takes a list of the form $name_1:path_1, - \dots, name_n:path_n$ in argument and replaces each $path_i$ by $name_i$ when +\item[\optiondef{-}{add-symbolic-path}] takes a list of the form $path_1:name_1, + \dots, path_n:name_n$ in argument and replaces each $path_i$ with $name_i$ when displaying file locations in messages. \item[\optiondef{-}{permissive}] performs less verification on validity of command-line options. diff --git a/doc/userman/user-changes.tex b/doc/userman/user-changes.tex index 103d9a2f2a8..77cd9c6fca0 100644 --- a/doc/userman/user-changes.tex +++ b/doc/userman/user-changes.tex @@ -3,6 +3,11 @@ This chapter summarizes the changes in this documentation between each \FramaC release. First we list changes of the last release. +\begin{itemize} +\item \textbf{Platform-wide Analysis Option:} swap argument order of + \texttt{-add-symbolic-path} (now uses \texttt{path:name}). +\end{itemize} + \section*{22.0 (Titanium)} \begin{itemize} diff --git a/man/frama-c.1 b/man/frama-c.1 index f175412be20..24d66d9cad8 100644 --- a/man/frama-c.1 +++ b/man/frama-c.1 @@ -25,7 +25,7 @@ .\" using pandoc 2.0 or newer. To modify this file, edit the Markdown file .\" and run `make man/frama-c.1`. -.TH FRAMA-C 1 2020-10-07 +.TH FRAMA-C 1 2021-01-07 .SH NAME .PP frama-c[.byte] - a static analyzer for C programs @@ -123,6 +123,12 @@ By default, all numerical addresses are considered invalid. adds directories \f[I]p1\f[R] through \f[I]pn\f[R] to the list of directories in which plugins are searched. .TP +.B \-add\-symbolic\-path \f[I]p1:n1[,p2:n2[\&...,pn:nn]]\f[] +replaces each path \f[I]pi\f[] with the name \f[I]ni\f[] when displaying +file locations in messages. +.RS +.RE +.TP .B [-no]-aggressive-merging merges function definitions modulo renaming. Defaults to no. diff --git a/man/frama-c.1.md b/man/frama-c.1.md index ca5a103976c..7f71c13c8b9 100644 --- a/man/frama-c.1.md +++ b/man/frama-c.1.md @@ -85,6 +85,10 @@ By default, all numerical addresses are considered invalid. : adds directories *p1* through *pn* to the list of directories in which plugins are searched. +-add-symbolic-path *p1:n1[,p2:n2[...,pn:nn]]* +: replaces each path *pi* with the name *ni* when displaying file locations +in messages. + [-no]-aggressive-merging : merges function definitions modulo renaming. Defaults to no. -- GitLab