Summary: `infer help` will be used to display information about issue types and checkers, and to generate the corresponding website documentation. We can add more things in it over time. The goal is to avoid having to go read the source code of infer to figure things out that are user-facing. Reviewed By: ezgicicek Differential Revision: D21934376 fbshipit-source-id: 2788c5af1master
Jules Villard
5 years ago
committed by
Facebook GitHub Bot
parent
7310726155
commit
7ba6e015a8
@ -0,0 +1,77 @@
|
|||||||
|
NAME
|
||||||
|
infer-help - Show and generate documentation.
|
||||||
|
|
||||||
|
SYNOPSIS
|
||||||
|
infer help
|
||||||
|
infer help --help-checker checker1 ... --help-checker checkerN
|
||||||
|
infer help --help-issue-type ISSUE_TYPE1 ... --help-issue-type ISSUE_TYPEN
|
||||||
|
infer help --list-checkers
|
||||||
|
infer help --list-issue-types
|
||||||
|
infer help --write-website website_root
|
||||||
|
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
Without arguments, show the Infer manual as with infer --help
|
||||||
|
|
||||||
|
For each -help-checker or --help-issue-type option passed, display
|
||||||
|
information about the given checker or issue type.
|
||||||
|
|
||||||
|
If --list-checkers is passed, list all available checkers.
|
||||||
|
|
||||||
|
If --list-issue-types is passed, list all issue types.
|
||||||
|
|
||||||
|
Use --write-website to build some of the documentation for the
|
||||||
|
fbinfer.com website. (Used in scripts, not meant to be used except
|
||||||
|
when publishing content to fbinfer.com)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
OPTIONS
|
||||||
|
--help
|
||||||
|
Show this manual
|
||||||
|
|
||||||
|
--help-checker +checker-id
|
||||||
|
Show information about a checker, for example biabduction. To see
|
||||||
|
the list of all checkers, see --list-checkers.
|
||||||
|
|
||||||
|
--help-format { auto | groff | pager | plain }
|
||||||
|
Show this help in the specified format. auto sets the format to
|
||||||
|
plain if the environment variable TERM is "dumb" or undefined, and
|
||||||
|
to pager otherwise.
|
||||||
|
|
||||||
|
--help-full
|
||||||
|
Show this manual with all internal options in the INTERNAL OPTIONS
|
||||||
|
section
|
||||||
|
|
||||||
|
--help-issue-type +UNIQUE_ID
|
||||||
|
Show information about an issue type, for example
|
||||||
|
NULL_DEREFERENCE. To see the list of all issue types, see
|
||||||
|
--list-issue-types.
|
||||||
|
|
||||||
|
--list-checkers
|
||||||
|
Activates: Show the list of all available checkers. (Conversely:
|
||||||
|
--no-list-checkers)
|
||||||
|
|
||||||
|
--list-issue-types
|
||||||
|
Activates: Show the list of all issue types that infer might
|
||||||
|
report. (Conversely: --no-list-issue-types)
|
||||||
|
|
||||||
|
--write-website path_to_website_dir
|
||||||
|
Use to write website files documenting issue types and checkers
|
||||||
|
under path_to_website_dir/. Meant to be used within the Infer
|
||||||
|
directory to generate its website at fbinfer.com at website/.
|
||||||
|
|
||||||
|
|
||||||
|
ENVIRONMENT
|
||||||
|
INFER_ARGS, INFERCONFIG, INFER_STRICT_MODE
|
||||||
|
See the ENVIRONMENT section in the manual of infer(1).
|
||||||
|
|
||||||
|
FILES
|
||||||
|
.inferconfig
|
||||||
|
See the FILES section in the manual of infer(1).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -0,0 +1,18 @@
|
|||||||
|
(*
|
||||||
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
||||||
|
*
|
||||||
|
* This source code is licensed under the MIT license found in the
|
||||||
|
* LICENSE file in the root directory of this source tree.
|
||||||
|
*)
|
||||||
|
|
||||||
|
open! IStd
|
||||||
|
|
||||||
|
let list_checkers () = assert false
|
||||||
|
|
||||||
|
let list_issue_types () = assert false
|
||||||
|
|
||||||
|
let show_checkers _ = assert false
|
||||||
|
|
||||||
|
let show_issue_types _ = assert false
|
||||||
|
|
||||||
|
let write_website ~website_root:_ = assert false
|
||||||
@ -0,0 +1,23 @@
|
|||||||
|
(*
|
||||||
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
||||||
|
*
|
||||||
|
* This source code is licensed under the MIT license found in the
|
||||||
|
* LICENSE file in the root directory of this source tree.
|
||||||
|
*)
|
||||||
|
|
||||||
|
open! IStd
|
||||||
|
|
||||||
|
val list_checkers : unit -> unit
|
||||||
|
(** print the list of all checkers *)
|
||||||
|
|
||||||
|
val list_issue_types : unit -> unit
|
||||||
|
(** print the list of all known issue types *)
|
||||||
|
|
||||||
|
val show_checkers : Checker.t list -> unit
|
||||||
|
(** show information about the given checkers *)
|
||||||
|
|
||||||
|
val show_issue_types : IssueType.t list -> unit
|
||||||
|
(** show information about the given issue_types *)
|
||||||
|
|
||||||
|
val write_website : website_root:string -> unit
|
||||||
|
(** generate files for the fbinfer.com website *)
|
||||||
Loading…
Reference in new issue