From bf329015399ddcf155b5df1e48aa6a76cca9ac24 Mon Sep 17 00:00:00 2001
From: Andre Maroneze <andre.maroneze@cea.fr>
Date: Fri, 17 May 2024 08:52:08 +0200
Subject: [PATCH] [analysis-scripts] standardize help messages
---
bin/frama-c-script | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/bin/frama-c-script b/bin/frama-c-script
index f92e7107be4..1950fec1444 100755
--- a/bin/frama-c-script
+++ b/bin/frama-c-script
@@ -39,9 +39,9 @@ usage() {
echo " (run 'frama-c -machdep help' to get the list of machdeps)."
echo ""
echo " - creduce [[file] args]"
- echo " Use the external tool C-Reduce to minimize C files when"
- echo " debugging crashes and fatal errors. Run without arguments for"
- echo " more details."
+ echo " Uses the external tool C-Reduce to minimize C files when"
+ echo " debugging crashes and fatal errors."
+ echo " Run 'frama-c-script c-reduce' without arguments for more details."
echo ""
echo " - estimate-difficulty file..."
echo " Applies several heuristics to try and estimate the difficulty"
@@ -72,7 +72,7 @@ usage() {
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 " specified files. Use '--dot outfile' to print it in DOT"
echo " (Graphviz) format, to [outfile]. If [outfile] is '-',"
echo " prints to stdout."
echo ""
@@ -85,11 +85,11 @@ usage() {
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 " Accepts Frama-C options (e.g. '-cpp-extra-args' for parsing)."
echo ""
echo " - make-machdep [--compiler=<cc>] [--cpp-arch-flags=<flags>]"
echo " Creates a new machdep definition for a specific target."
- echo " Use frama-c-script make-machdep --help for more information"
+ echo " Use 'frama-c-script make-machdep --help' for more information."
echo ""
echo " - make-wrapper [target] [arg...]"
echo " Runs 'make target arg...', parsing the output to suggest"
@@ -103,7 +103,7 @@ usage() {
echo " - summary [options]"
echo " Monitors and summarizes multiple analyses dispatched by a Makefile"
echo " in the current PWD."
- echo " Use frama-c-script summary --help for more information."
+ echo " Use 'frama-c-script summary --help' for more information."
exit "$1"
}
--
GitLab