Skip to content

Commit 669b32a

Browse files
skchofacebook-github-bot
authored andcommitted
[web] Update the webpage
Summary: ^^ Reviewed By: hajduakos Differential Revision: D61542376 fbshipit-source-id: b3e3b430cc349d681a59674d542b3a60849c6eae
1 parent 1727935 commit 669b32a

File tree

271 files changed

+477
-560
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

271 files changed

+477
-560
lines changed

website/checkers.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
"checker-inefficient-keyset-iterator", "checker-lineage",
99
"checker-litho-required-props", "checker-liveness",
1010
"checker-loop-hoisting", "checker-parameter-not-null-checked",
11-
"checker-printf-args", "checker-pulse", "checker-purity",
12-
"checker-racerd", "checker-resource-leak-lab", "checker-sil-validation",
13-
"checker-siof", "checker-scope-leakage", "checker-self-in-block",
14-
"checker-starvation", "checker-topl"
11+
"checker-pulse", "checker-purity", "checker-racerd",
12+
"checker-resource-leak-lab", "checker-sil-validation", "checker-siof",
13+
"checker-scope-leakage", "checker-self-in-block", "checker-starvation",
14+
"checker-topl"
1515
]
1616
}

website/docs/all-categories.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ Issue types in this category:
5050
The null pointer is used where a valid pointer is required, causing a memory fault and a crash. For example, it is dereferenced.
5151

5252
Issue types in this category:
53+
- [BLOCK_PARAMETER_NOT_NULL_CHECKED](/docs/next/all-issue-types#block_parameter_not_null_checked)
54+
- [COMPARED_TO_NULL_AND_DEREFERENCED](/docs/next/all-issue-types#compared_to_null_and_dereferenced)
5355
- [NIL_BLOCK_CALL](/docs/next/all-issue-types#nil_block_call)
5456
- [NIL_BLOCK_CALL_LATENT](/docs/next/all-issue-types#nil_block_call_latent)
5557
- [NULLPTR_DEREFERENCE](/docs/next/all-issue-types#nullptr_dereference)
@@ -80,6 +82,7 @@ Issue types in this category:
8082
- [PULSE_UNNECESSARY_COPY_OPTIONAL](/docs/next/all-issue-types#pulse_unnecessary_copy_optional)
8183
- [PULSE_UNNECESSARY_COPY_OPTIONAL_CONST](/docs/next/all-issue-types#pulse_unnecessary_copy_optional_const)
8284
- [PULSE_UNNECESSARY_COPY_RETURN](/docs/next/all-issue-types#pulse_unnecessary_copy_return)
85+
- [PULSE_UNNECESSARY_COPY_THRIFT_ASSIGNMENT](/docs/next/all-issue-types#pulse_unnecessary_copy_thrift_assignment)
8386
- [REGEX_OP_ON_UI_THREAD](/docs/next/all-issue-types#regex_op_on_ui_thread)
8487
- [STRICT_MODE_VIOLATION](/docs/next/all-issue-types#strict_mode_violation)
8588

@@ -149,6 +152,7 @@ Sensitive data is flowing where it shouldn't.
149152

150153
Issue types in this category:
151154
- [DATA_FLOW_TO_SINK](/docs/next/all-issue-types#data_flow_to_sink)
155+
- [LINEAGE_FLOW](/docs/next/all-issue-types#lineage_flow)
152156
- [SCOPE_LEAKAGE](/docs/next/all-issue-types#scope_leakage)
153157
- [SENSITIVE_DATA_FLOW](/docs/next/all-issue-types#sensitive_data_flow)
154158
- [TAINT_ERROR](/docs/next/all-issue-types#taint_error)

website/docs/all-checkers.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,6 @@ Computes the asymptotic complexity of functions with respect to execution cost o
4141

4242
Detects when Android fragments are not explicitly nullified before becoming unreachable.
4343

44-
**\*\*\*DEPRECATED\*\*\*** Unmaintained due to poor precision.
45-
4644
[Visit here for more information.](/docs/next/checker-fragment-retains-view)
4745

4846
## Impurity
@@ -87,14 +85,6 @@ An Objective-C-specific analysis to detect when a block parameter is used before
8785

8886
[Visit here for more information.](/docs/next/checker-parameter-not-null-checked)
8987

90-
## `printf()` Argument Types
91-
92-
Detect mismatches between the Java `printf` format strings and the argument types For example, this checker will warn about the type error in `printf("Hello %d", "world")`
93-
94-
**\*\*\*DEPRECATED\*\*\*** Unmaintained.
95-
96-
[Visit here for more information.](/docs/next/checker-printf-args)
97-
9888
## Pulse
9989

10090
General-purpose memory and value analysis engine.

website/docs/all-issue-types.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ See [MEMORY_LEAK_C](#memory_leak_c).
167167
See [RETAIN_CYCLE](#retain_cycle).
168168
## BLOCK_PARAMETER_NOT_NULL_CHECKED
169169

170-
*Reported as "Block Parameter Not Null Checked" by [parameter-not-null-checked](/docs/next/checker-parameter-not-null-checked).*
170+
*Category: [Null pointer dereference](/docs/next/all-categories#null-pointer-dereference). Reported as "Block Parameter Not Null Checked" by [parameter-not-null-checked](/docs/next/checker-parameter-not-null-checked).*
171171

172172
This error type is reported only in Objective-C/Objective-C++. It happens when a method has a block as a parameter,
173173
and the block is executed in the method's body without checking it for `nil` first. If a `nil` block is passed to
@@ -416,20 +416,11 @@ retain a useless reference to that `View` that will not be cleaned up until the
416416

417417
Action: Nullify the `View` in question in `onDestroyView`.
418418

419-
## CHECKERS_PRINTF_ARGS
419+
## COMPARED_TO_NULL_AND_DEREFERENCED
420420

421-
*Reported as "Printf Args" by [printf-args](/docs/next/checker-printf-args).*
422-
423-
This error is reported when the argument types to a `printf` method do not match the format string.
424-
425-
```java
426-
void stringInsteadOfInteger(PrintStream out) {
427-
out.printf("Hello %d", "world");
428-
}
429-
```
430-
431-
Action: fix the mismatch between format string and argument types.
421+
*Category: [Null pointer dereference](/docs/next/all-categories#null-pointer-dereference). Reported as "Compared To Null And Dereferenced" by [pulse](/docs/next/checker-pulse).*
432422

423+
A pointer that has both been compared to null, whcich suggests that it could be null, but has also been dereferenced without a null check.
433424
## CONFIG_IMPACT
434425

435426
*Category: [Perf regression](/docs/next/all-categories#perf-regression). Reported as "Config Impact" by [config-impact-analysis](/docs/next/checker-config-impact-analysis).*
@@ -995,6 +986,12 @@ A blocking `Binder` IPC call occurs on the UI thread.
995986
*Reported as "Lab Resource Leak" by [resource-leak-lab](/docs/next/checker-resource-leak-lab).*
996987

997988
Toy issue.
989+
## LINEAGE_FLOW
990+
991+
*Category: [Sensitive data flow](/docs/next/all-categories#sensitive-data-flow). Reported as "Lineage Flow" by [lineage](/docs/next/checker-lineage).*
992+
993+
A Lineage taint flow has been detected from a source to a sink.
994+
998995
## LOCKLESS_VIOLATION
999996

1000997
*Reported as "Lockless Violation" by [starvation](/docs/next/checker-starvation).*
@@ -2207,6 +2204,13 @@ void caller(MyClass obj) {
22072204
}
22082205
```
22092206

2207+
## PULSE_UNNECESSARY_COPY_THRIFT_ASSIGNMENT
2208+
2209+
*Category: [Perf regression](/docs/next/all-categories#perf-regression). Reported as "Unnecessary Copy Assignment into Thrift" by [pulse](/docs/next/checker-pulse).*
2210+
2211+
This is similar to [PULSE_UNNECESSARY_COPY_ASSIGNMENT](#pulse_unnecessary_copy_assignment), but is
2212+
reported when copied into thrift fields.
2213+
22102214
## PURE_FUNCTION
22112215

22122216
*Reported as "Pure Function" by [purity](/docs/next/checker-purity).*

website/docs/checker-fragment-retains-view.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ description: "Detects when Android fragments are not explicitly nullified before
55

66
Detects when Android fragments are not explicitly nullified before becoming unreachable.
77

8-
**\*\*\*DEPRECATED\*\*\*** Unmaintained due to poor precision.
9-
108
Activate with `--fragment-retains-view`.
119

1210
Supported languages:

website/docs/checker-impurity.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Supported languages:
1111
- C/C++/ObjC: Experimental
1212
- C#/.Net: No
1313
- Erlang: No
14-
- Hack: No
14+
- Hack: Experimental
1515
- Java: Experimental
1616
- Python: No
1717

website/docs/checker-lineage.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,9 @@ Supported languages:
1515
- Java: No
1616
- Python: No
1717

18+
19+
20+
## List of Issue Types
21+
22+
The following issue types are reported by this checker:
23+
- [LINEAGE_FLOW](/docs/next/all-issue-types#lineage_flow)

website/docs/checker-printf-args.md

Lines changed: 0 additions & 25 deletions
This file was deleted.

website/docs/checker-pulse.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,7 @@ The following issue types are reported by this checker:
147147
- [BAD_RECORD_LATENT](/docs/next/all-issue-types#bad_record_latent)
148148
- [BAD_RETURN](/docs/next/all-issue-types#bad_return)
149149
- [BAD_RETURN_LATENT](/docs/next/all-issue-types#bad_return_latent)
150+
- [COMPARED_TO_NULL_AND_DEREFERENCED](/docs/next/all-issue-types#compared_to_null_and_dereferenced)
150151
- [CONFIG_USAGE](/docs/next/all-issue-types#config_usage)
151152
- [CONSTANT_ADDRESS_DEREFERENCE](/docs/next/all-issue-types#constant_address_dereference)
152153
- [CONSTANT_ADDRESS_DEREFERENCE_LATENT](/docs/next/all-issue-types#constant_address_dereference_latent)
@@ -202,6 +203,7 @@ The following issue types are reported by this checker:
202203
- [PULSE_UNNECESSARY_COPY_OPTIONAL](/docs/next/all-issue-types#pulse_unnecessary_copy_optional)
203204
- [PULSE_UNNECESSARY_COPY_OPTIONAL_CONST](/docs/next/all-issue-types#pulse_unnecessary_copy_optional_const)
204205
- [PULSE_UNNECESSARY_COPY_RETURN](/docs/next/all-issue-types#pulse_unnecessary_copy_return)
206+
- [PULSE_UNNECESSARY_COPY_THRIFT_ASSIGNMENT](/docs/next/all-issue-types#pulse_unnecessary_copy_thrift_assignment)
205207
- [RETAIN_CYCLE](/docs/next/all-issue-types#retain_cycle)
206208
- [RETAIN_CYCLE_NO_WEAK_INFO](/docs/next/all-issue-types#retain_cycle_no_weak_info)
207209
- [SENSITIVE_DATA_FLOW](/docs/next/all-issue-types#sensitive_data_flow)

website/static/man/next/infer-analyze.1.html

Lines changed: 20 additions & 23 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)