Skip to content

Commit

Permalink
[website] Updating the website
Browse files Browse the repository at this point in the history
Reviewed By: ngorogiannis

Differential Revision: D66877771

fbshipit-source-id: a93bea9cf5b99af6db3730a6c9ac1aea9cef871d
  • Loading branch information
dulmarod authored and facebook-github-bot committed Dec 6, 2024
1 parent abe6d0c commit 0c97c35
Show file tree
Hide file tree
Showing 1,801 changed files with 2,624 additions and 2,714 deletions.
2 changes: 1 addition & 1 deletion website/checkers.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"all-checkers", "all-categories", "all-issue-types",
"checker-annotation-reachability", "checker-biabduction",
"checker-bufferoverrun", "checker-config-impact-analysis",
"checker-cost", "checker-dispatch-once-static-init",
"checker-cost", "checker-static-constructor-stall-checker",
"checker-fragment-retains-view", "checker-impurity",
"checker-inefficient-keyset-iterator", "checker-lineage",
"checker-litho-required-props", "checker-liveness",
Expand Down
15 changes: 11 additions & 4 deletions website/docs/all-categories.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ Concurrent accesses to the same resource conflict in a way that can give incorre

Issue types in this category:
- [DEADLOCK](/docs/next/all-issue-types#deadlock)
- [DISPATCH_ONCE_IN_STATIC_INIT](/docs/next/all-issue-types#dispatch_once_in_static_init)
- [GUARDEDBY_VIOLATION](/docs/next/all-issue-types#guardedby_violation)
- [INTERFACE_NOT_THREAD_SAFE](/docs/next/all-issue-types#interface_not_thread_safe)
- [LOCK_CONSISTENCY_VIOLATION](/docs/next/all-issue-types#lock_consistency_violation)
- [STATIC_CONSTRUCTOR_STALL](/docs/next/all-issue-types#static_constructor_stall)
- [THREAD_SAFETY_VIOLATION](/docs/next/all-issue-types#thread_safety_violation)

## Logic error
Expand Down Expand Up @@ -69,7 +69,7 @@ Unnecessary (or blocking) computation is performed, potentially causing a perfor

Issue types in this category:
- [CHECKERS_ALLOCATES_MEMORY](/docs/next/all-issue-types#checkers_allocates_memory)
- [CHECKERS_ANNOTATION_REACHABILITY_ERROR](/docs/next/all-issue-types#checkers_annotation_reachability_error)
- [CHECKERS_CALLS_EXPENSIVE_METHOD](/docs/next/all-issue-types#checkers_calls_expensive_method)
- [CONFIG_IMPACT](/docs/next/all-issue-types#config_impact)
- [INEFFICIENT_KEYSET_ITERATOR](/docs/next/all-issue-types#inefficient_keyset_iterator)
- [IPC_ON_UI_THREAD](/docs/next/all-issue-types#ipc_on_ui_thread)
Expand Down Expand Up @@ -160,8 +160,6 @@ Issue types in this category:
- [SCOPE_LEAKAGE](/docs/next/all-issue-types#scope_leakage)
- [SENSITIVE_DATA_FLOW](/docs/next/all-issue-types#sensitive_data_flow)
- [TAINT_ERROR](/docs/next/all-issue-types#taint_error)
- [TOPL_ERROR](/docs/next/all-issue-types#topl_error)
- [TOPL_ERROR_LATENT](/docs/next/all-issue-types#topl_error_latent)

## Ungated code

Expand All @@ -170,3 +168,12 @@ Code must be under a gating mechanism but isn't.
Issue types in this category:
- [CONFIG_IMPACT_STRICT](/docs/next/all-issue-types#config_impact_strict)

## User defined property

A user defined (custom) property is violated.

Issue types in this category:
- [CHECKERS_ANNOTATION_REACHABILITY_ERROR](/docs/next/all-issue-types#checkers_annotation_reachability_error)
- [TOPL_ERROR](/docs/next/all-issue-types#topl_error)
- [TOPL_ERROR_LATENT](/docs/next/all-issue-types#topl_error_latent)

4 changes: 2 additions & 2 deletions website/docs/all-checkers.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ Computes the asymptotic complexity of functions with respect to execution cost o

[Visit here for more information.](/docs/next/checker-cost)

## dispatch-once in static init
## Static Constructor Stall Checker

Detect if dispatch_once is called from a static constructor.

[Visit here for more information.](/docs/next/checker-dispatch-once-static-init)
[Visit here for more information.](/docs/next/checker-static-constructor-stall-checker)

## Fragment Retains View

Expand Down
18 changes: 9 additions & 9 deletions website/docs/all-issue-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -359,13 +359,13 @@ class C implements I {
## CHECKERS_ANNOTATION_REACHABILITY_ERROR
*Category: [Perf regression](/docs/next/all-categories#perf-regression). Reported as "Annotation Reachability Error" by [annotation-reachability](/docs/next/checker-annotation-reachability).*
*Category: [User defined property](/docs/next/all-categories#user-defined-property). Reported as "Annotation Reachability Error" by [annotation-reachability](/docs/next/checker-annotation-reachability).*
A method annotated with an annotation `@A` transitively calls a method annotated `@B` where the combination of annotations is forbidden (for example, `@UiThread` calling `@WorkerThread`).
## CHECKERS_CALLS_EXPENSIVE_METHOD
*Reported as "Expensive Method Called" by [annotation-reachability](/docs/next/checker-annotation-reachability).*
*Category: [Perf regression](/docs/next/all-categories#perf-regression). Reported as "Expensive Method Called" by [annotation-reachability](/docs/next/checker-annotation-reachability).*
A method annotated with `@PerformanceCritical` transitively calls a method annotated `@Expensive`.
Expand Down Expand Up @@ -652,11 +652,6 @@ To suppress reports of deadlocks in a method `m()` use the
This error is reported in C++. It fires when the value assigned to a variables
is never used (e.g., `int i = 1; i = 2; return i;`).
## DISPATCH_ONCE_IN_STATIC_INIT
*Category: [Concurrency](/docs/next/all-categories#concurrency). Reported as "dispatch_once in static init" by [dispatch-once-static-init](/docs/next/checker-dispatch-once-static-init).*
Calling dispatch_once during the static initialization of objects is risky, for example it could cause deadlocks, because other objects might not have been initialized yet.
## DIVIDE_BY_ZERO
*Reported as "Divide By Zero" by [biabduction](/docs/next/checker-biabduction).*
Expand Down Expand Up @@ -2867,6 +2862,11 @@ This instructs Infer to filter out any potentially blocking calls in `m()`
due to a call to `m()`. You will need to set up your class path appropriately to
include the JAR files in `infer/annotations` for this annotation to work.
## STATIC_CONSTRUCTOR_STALL
*Category: [Concurrency](/docs/next/all-categories#concurrency). Reported as "Static Constructor Stall" by [static-constructor-stall-checker](/docs/next/checker-static-constructor-stall-checker).*
Calling certain methods, for instance dispatch_once, during the static initialization of objects is risky. It could cause deadlocks, because other objects might not have been initialized yet.
## STATIC_INITIALIZATION_ORDER_FIASCO
*Category: [Memory error](/docs/next/all-categories#memory-error). Reported as "Static Initialization Order Fiasco" by [siof](/docs/next/checker-siof).*
Expand Down Expand Up @@ -3034,7 +3034,7 @@ These annotations can be found at `com.facebook.infer.annotation.*`.

## TOPL_ERROR

*Category: [Sensitive data flow](/docs/next/all-categories#sensitive-data-flow). Reported as "Topl Error" by [topl](/docs/next/checker-topl).*
*Category: [User defined property](/docs/next/all-categories#user-defined-property). Reported as "Topl Error" by [topl](/docs/next/checker-topl).*

A violation of a Topl property (user-specified).
There is an execution path in the code that drives a Topl property from a start state to an error state.
Expand All @@ -3045,7 +3045,7 @@ See [Topl](/docs/next/checker-topl#what-is-it) for an example

## TOPL_ERROR_LATENT

*Category: [Sensitive data flow](/docs/next/all-categories#sensitive-data-flow). Reported as "Topl Error Latent" by [topl](/docs/next/checker-topl).*
*Category: [User defined property](/docs/next/all-categories#user-defined-property). Reported as "Topl Error Latent" by [topl](/docs/next/checker-topl).*

A latent [TOPL_ERROR](#topl_error). See the [documentation on Pulse latent issues](/docs/next/checker-pulse#latent-issues).
## USE_AFTER_DELETE
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: "dispatch-once in static init"
title: "Static Constructor Stall Checker"
description: "Detect if dispatch_once is called from a static constructor."
---

Detect if dispatch_once is called from a static constructor.

Activate with `--dispatch-once-static-init`.
Activate with `--static-constructor-stall-checker`.

Supported languages:
- C/C++/ObjC: Yes
Expand All @@ -20,4 +20,4 @@ Supported languages:
## List of Issue Types

The following issue types are reported by this checker:
- [DISPATCH_ONCE_IN_STATIC_INIT](/docs/next/all-issue-types#dispatch_once_in_static_init)
- [STATIC_CONSTRUCTOR_STALL](/docs/next/all-issue-types#static_constructor_stall)
34 changes: 17 additions & 17 deletions website/static/man/next/infer-analyze.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion website/static/man/next/infer-report.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

40 changes: 20 additions & 20 deletions website/static/man/next/infer.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion website/static/odoc/next/infer/ATDGenerated.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>ATDGenerated (infer.ATDGenerated)</title><meta charset="utf-8"/><link rel="stylesheet" href="../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="index.html">Up</a><a href="index.html">infer</a> &#x00BB; ATDGenerated</nav><header class="odoc-preamble"><h1 id="library-atdgenerated"><a href="#library-atdgenerated" class="anchor"></a>Library ATDGenerated</h1><p>Source code that is generated from ATD definitions.</p><p>The entry point of this library is the module <a href="ATDGenerated/index.html"><code>ATDGenerated</code></a>.</p></header><div class="odoc-content"></div></body></html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>ATDGenerated (infer.ATDGenerated)</title><meta charset="utf-8"/><link rel="stylesheet" href="../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="index.html">Up</a><a href="index.html">infer</a> &#x00BB; ATDGenerated</nav><header class="odoc-preamble"><h1 id="library-atdgenerated"><a href="#library-atdgenerated" class="anchor"></a>Library ATDGenerated</h1><p>Source code that is generated from ATD definitions.</p><p>The entry point of this library is the module <a href="ATDGenerated/index.html"><code>ATDGenerated</code></a>.</p></header><div class="odoc-content"></div></body></html>
Loading

0 comments on commit 0c97c35

Please sign in to comment.