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

[Kernel] add documentation for option -print-config-json

parent 0427f750
No related branches found
No related tags found
No related merge requests found
......@@ -6,6 +6,8 @@ release. First we list changes of the last release.
\section*{\nextframacversion}
\begin{itemize}
\item \textbf{Getting Started:} added option
\texttt{-print-config-json}.
\item \textbf{Getting Started:} added option
\texttt{-autocomplete}.
\item \textbf{Getting Started:} updated installation instructions.
......
......@@ -146,6 +146,10 @@ all documented with \texttt{-kernel-h}:
There are many aliases for these options, but for backward compatibility purposes only.
Those listed above should be used for scripting.
For a more thorough display of configuration-related data, in JSON format,
use option \optiondef{-}{print-config-json}. Note that the data output by this
option is likely to change in future releases.
\subsection{Options Outline}
The batch and interactive versions of \FramaC obey a number of
......
......@@ -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-09-21
.TH FRAMA-C 1 2020-10-07
.SH NAME
.PP
frama-c[.byte] - a static analyzer for C programs
......@@ -437,6 +437,9 @@ Defaults to no.
.B -print-cpp-commands
outputs the preprocessing commands for all input files.
.TP
.B -print-config-json
outputs extensive Frama-C configuration data in JSON format.
.TP
.B [-no]-print-libc
expands \f[B]#include\f[R] directives in the pretty-printed CIL code for
files in the Frama-C standard library.
......
......@@ -25,4 +25,4 @@
.\" 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-09-21
.TH FRAMA-C 1 2020-10-07
......@@ -340,6 +340,9 @@ See also **-cpp-frama-c-compliant**.
-print-cpp-commands
: outputs the preprocessing commands for all input files.
-print-config-json
: outputs extensive Frama-C configuration data in JSON format.
[-no]-print-libc
: expands **#include** directives in the pretty-printed CIL code for files in
the Frama-C standard library. Defaults to no.
......
......@@ -51,6 +51,7 @@ let dump_to_json () =
"major_version", `Int Fc_config.major_version ;
"minor_version", `Int Fc_config.minor_version ;
"is_gui", `Bool !Fc_config.is_gui ;
"lablgtk", `String Fc_config.lablgtk ;
"ocamlc", `String Fc_config.ocamlc ;
"ocamlopt", `String Fc_config.ocamlopt ;
"ocaml_wflags", `String Fc_config.ocaml_wflags ;
......
......@@ -21,7 +21,7 @@
(**************************************************************************)
val dump_to_json : unit -> Yojson.Basic.t
(** Builds a Json object describing the Frama-C configuration *)
(** Builds a Json object describing the Frama-C configuration. *)
val dump_to_stdout : unit -> unit
(** Dumps a Json object to describing the Frama-C configuration to stdout *)
(** Dumps a Json object describing the Frama-C configuration to stdout. *)
......@@ -425,8 +425,8 @@ module PrintConfigJson =
(struct
let module_name = "PrintConfigJson"
let option_name = "-print-config-json"
let help = "print several information about frama-configuration inside a \
JSON object"
let help = "prints extensive data about Frama-C's configuration, in \
JSON format, and exits."
end)
let () = Parameter_customize.set_group help
......
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