From 67dc394d315e47f82bb7654af61dfa295e410587 Mon Sep 17 00:00:00 2001
From: Andre Maroneze <andre.maroneze@cea.fr>
Date: Thu, 18 Mar 2021 10:22:17 +0100
Subject: [PATCH] [analysis-scripts] sort help message
---
bin/frama-c-script | 78 +++++++++++++++++++++++-----------------------
1 file changed, 39 insertions(+), 39 deletions(-)
diff --git a/bin/frama-c-script b/bin/frama-c-script
index 0fb86734d9b..4a1223b4d16 100755
--- a/bin/frama-c-script
+++ b/bin/frama-c-script
@@ -31,50 +31,28 @@ usage() {
echo ""
echo " where cmd is:"
echo ""
- echo " - help"
- echo " Display this help message and exit."
- echo ""
- echo " - make-template [dir]"
- echo " Interactively prepares a template for analyses,"
- echo " writing it to dir/GNUmakefile [default: .frama-c]."
- echo ""
- echo " - list-files [path/to/compile_commands.json]"
- echo " Lists all sources in the given compile_commands.json"
- echo " [default: ./compile_commands.json]."
- echo " Also lists files defining a 'main' function"
- echo " (heuristics-based; neither correct nor complete)."
- echo ""
- echo " - list-functions [files] [Frama-C options]"
- echo " Parses all sources in [files] and lists all function"
- echo " definitions, with source location and number of statements."
- echo " Accepts Frama-C options (e.g. -cpp-extra-args for parsing)."
+ echo " - configure machdep"
+ echo " Runs an existing configure script to only consider files"
+ echo " in Frama-C's libc; this will hopefully disable non-essential"
+ echo " and non-POSIX external libraries."
+ echo " (run 'frama-c -machdep help' to get the list of machdeps)."
echo ""
- echo " - flamegraph flamegraph.txt [dir]"
- echo " Generates flamegraph.svg and flamegraph.html in dir"
- echo " [default: FRAMAC_SESSION]."
- echo " Also opens it in a browser, unless variable NOGUI is set."
+ echo " - estimate-difficulty file..."
+ echo " Applies several heuristics to try and estimate the difficulty"
+ echo " of analyzing the specified files with Frama-C."
echo ""
echo " - find-fun function-name [dir...]"
echo " Lists files in dir... declaring or defining function-name"
echo " [default: PWD /usr/include]."
echo " Heuristics-based: neither correct nor complete."
echo ""
- echo " - summary [options]"
- echo " Monitors and summarizes multiple analyses dispatched by a Makefile"
- echo " in the current PWD."
- echo " Use $0 summary --help for more informations."
- echo ""
- echo " - configure machdep"
- echo " Runs an existing configure script to only consider files"
- echo " in Frama-C's libc; this will hopefully disable non-essential"
- echo " and non-POSIX external libraries."
- echo " (run 'frama-c -machdep help' to get the list of machdeps)."
+ echo " - flamegraph flamegraph.txt [dir]"
+ echo " Generates flamegraph.svg and flamegraph.html in dir"
+ echo " [default: FRAMAC_SESSION]."
+ echo " Also opens it in a browser, unless variable NOGUI is set."
echo ""
- echo " - heuristic-print-callgraph [--dot outfile] file..."
- echo " Prints a heuristic, syntactic-based, callgraph for the"
- echo " specified files. Use --dot outfile to print it in DOT"
- echo " (Graphviz) format, to [outfile]. If [outfile] is '-',"
- echo " prints to stdout."
+ echo " - help"
+ echo " Display this help message and exit."
echo ""
echo " - heuristic-detect-recursion file..."
echo " Uses a heuristic, syntactic-based, callgraph to detect recursive"
@@ -86,9 +64,26 @@ usage() {
echo " If [want_decls] is true, lists declarations."
echo " Results are guaranteed neither correct nor complete."
echo ""
- echo " - estimate-difficulty file..."
- echo " Applies several heuristics to try and estimate the difficulty"
- echo " of analyzing the specified files with Frama-C."
+ echo " - heuristic-print-callgraph [--dot outfile] file..."
+ echo " Prints a heuristic, syntactic-based, callgraph for the"
+ echo " specified files. Use --dot outfile to print it in DOT"
+ echo " (Graphviz) format, to [outfile]. If [outfile] is '-',"
+ echo " prints to stdout."
+ echo ""
+ echo " - list-files [path/to/compile_commands.json]"
+ echo " Lists all sources in the given compile_commands.json"
+ echo " [default: ./compile_commands.json]."
+ echo " Also lists files defining a 'main' function"
+ echo " (heuristics-based; neither correct nor complete)."
+ echo ""
+ echo " - list-functions [files] [Frama-C options]"
+ echo " Parses all sources in [files] and lists all function"
+ echo " definitions, with source location and number of statements."
+ echo " Accepts Frama-C options (e.g. -cpp-extra-args for parsing)."
+ echo ""
+ echo " - make-template [dir]"
+ echo " Interactively prepares a template for analyses,"
+ echo " writing it to dir/GNUmakefile [default: .frama-c]."
echo ""
echo " - make-wrapper target arg..."
echo " Runs 'make target arg...', parsing the output to suggest"
@@ -98,6 +93,11 @@ usage() {
echo " Applies some transformations to an existing compile_commands.json"
echo " (such as relativizing paths) to improve portability."
echo " [default: ./compile_commands.json]"
+ echo ""
+ echo " - summary [options]"
+ echo " Monitors and summarizes multiple analyses dispatched by a Makefile"
+ echo " in the current PWD."
+ echo " Use $0 summary --help for more informations."
exit "$1"
}
--
GitLab