Skip to content

Commit

Permalink
[web] Update the webpage
Browse files Browse the repository at this point in the history
Summary: ^^

Reviewed By: hajduakos

Differential Revision: D61542376

fbshipit-source-id: b3e3b430cc349d681a59674d542b3a60849c6eae
  • Loading branch information
skcho authored and facebook-github-bot committed Aug 21, 2024
1 parent 1727935 commit 669b32a
Show file tree
Hide file tree
Showing 271 changed files with 477 additions and 560 deletions.
8 changes: 4 additions & 4 deletions website/checkers.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
"checker-inefficient-keyset-iterator", "checker-lineage",
"checker-litho-required-props", "checker-liveness",
"checker-loop-hoisting", "checker-parameter-not-null-checked",
"checker-printf-args", "checker-pulse", "checker-purity",
"checker-racerd", "checker-resource-leak-lab", "checker-sil-validation",
"checker-siof", "checker-scope-leakage", "checker-self-in-block",
"checker-starvation", "checker-topl"
"checker-pulse", "checker-purity", "checker-racerd",
"checker-resource-leak-lab", "checker-sil-validation", "checker-siof",
"checker-scope-leakage", "checker-self-in-block", "checker-starvation",
"checker-topl"
]
}
4 changes: 4 additions & 0 deletions website/docs/all-categories.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ Issue types in this category:
The null pointer is used where a valid pointer is required, causing a memory fault and a crash. For example, it is dereferenced.

Issue types in this category:
- [BLOCK_PARAMETER_NOT_NULL_CHECKED](/docs/next/all-issue-types#block_parameter_not_null_checked)
- [COMPARED_TO_NULL_AND_DEREFERENCED](/docs/next/all-issue-types#compared_to_null_and_dereferenced)
- [NIL_BLOCK_CALL](/docs/next/all-issue-types#nil_block_call)
- [NIL_BLOCK_CALL_LATENT](/docs/next/all-issue-types#nil_block_call_latent)
- [NULLPTR_DEREFERENCE](/docs/next/all-issue-types#nullptr_dereference)
Expand Down Expand Up @@ -80,6 +82,7 @@ Issue types in this category:
- [PULSE_UNNECESSARY_COPY_OPTIONAL](/docs/next/all-issue-types#pulse_unnecessary_copy_optional)
- [PULSE_UNNECESSARY_COPY_OPTIONAL_CONST](/docs/next/all-issue-types#pulse_unnecessary_copy_optional_const)
- [PULSE_UNNECESSARY_COPY_RETURN](/docs/next/all-issue-types#pulse_unnecessary_copy_return)
- [PULSE_UNNECESSARY_COPY_THRIFT_ASSIGNMENT](/docs/next/all-issue-types#pulse_unnecessary_copy_thrift_assignment)
- [REGEX_OP_ON_UI_THREAD](/docs/next/all-issue-types#regex_op_on_ui_thread)
- [STRICT_MODE_VIOLATION](/docs/next/all-issue-types#strict_mode_violation)

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

Issue types in this category:
- [DATA_FLOW_TO_SINK](/docs/next/all-issue-types#data_flow_to_sink)
- [LINEAGE_FLOW](/docs/next/all-issue-types#lineage_flow)
- [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)
Expand Down
10 changes: 0 additions & 10 deletions website/docs/all-checkers.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,6 @@ Computes the asymptotic complexity of functions with respect to execution cost o

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

**\*\*\*DEPRECATED\*\*\*** Unmaintained due to poor precision.

[Visit here for more information.](/docs/next/checker-fragment-retains-view)

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

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

## `printf()` Argument Types

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")`

**\*\*\*DEPRECATED\*\*\*** Unmaintained.

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

## Pulse

General-purpose memory and value analysis engine.
Expand Down
30 changes: 17 additions & 13 deletions website/docs/all-issue-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ See [MEMORY_LEAK_C](#memory_leak_c).
See [RETAIN_CYCLE](#retain_cycle).
## BLOCK_PARAMETER_NOT_NULL_CHECKED

*Reported as "Block Parameter Not Null Checked" by [parameter-not-null-checked](/docs/next/checker-parameter-not-null-checked).*
*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).*

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

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

## CHECKERS_PRINTF_ARGS
## COMPARED_TO_NULL_AND_DEREFERENCED

*Reported as "Printf Args" by [printf-args](/docs/next/checker-printf-args).*

This error is reported when the argument types to a `printf` method do not match the format string.

```java
void stringInsteadOfInteger(PrintStream out) {
out.printf("Hello %d", "world");
}
```

Action: fix the mismatch between format string and argument types.
*Category: [Null pointer dereference](/docs/next/all-categories#null-pointer-dereference). Reported as "Compared To Null And Dereferenced" by [pulse](/docs/next/checker-pulse).*

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.
## CONFIG_IMPACT

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

Toy issue.
## LINEAGE_FLOW

*Category: [Sensitive data flow](/docs/next/all-categories#sensitive-data-flow). Reported as "Lineage Flow" by [lineage](/docs/next/checker-lineage).*

A Lineage taint flow has been detected from a source to a sink.

## LOCKLESS_VIOLATION

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

## PULSE_UNNECESSARY_COPY_THRIFT_ASSIGNMENT

*Category: [Perf regression](/docs/next/all-categories#perf-regression). Reported as "Unnecessary Copy Assignment into Thrift" by [pulse](/docs/next/checker-pulse).*

This is similar to [PULSE_UNNECESSARY_COPY_ASSIGNMENT](#pulse_unnecessary_copy_assignment), but is
reported when copied into thrift fields.

## PURE_FUNCTION

*Reported as "Pure Function" by [purity](/docs/next/checker-purity).*
Expand Down
2 changes: 0 additions & 2 deletions website/docs/checker-fragment-retains-view.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ description: "Detects when Android fragments are not explicitly nullified before

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

**\*\*\*DEPRECATED\*\*\*** Unmaintained due to poor precision.

Activate with `--fragment-retains-view`.

Supported languages:
Expand Down
2 changes: 1 addition & 1 deletion website/docs/checker-impurity.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Supported languages:
- C/C++/ObjC: Experimental
- C#/.Net: No
- Erlang: No
- Hack: No
- Hack: Experimental
- Java: Experimental
- Python: No

Expand Down
6 changes: 6 additions & 0 deletions website/docs/checker-lineage.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,9 @@ Supported languages:
- Java: No
- Python: No



## List of Issue Types

The following issue types are reported by this checker:
- [LINEAGE_FLOW](/docs/next/all-issue-types#lineage_flow)
25 changes: 0 additions & 25 deletions website/docs/checker-printf-args.md

This file was deleted.

2 changes: 2 additions & 0 deletions website/docs/checker-pulse.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,7 @@ The following issue types are reported by this checker:
- [BAD_RECORD_LATENT](/docs/next/all-issue-types#bad_record_latent)
- [BAD_RETURN](/docs/next/all-issue-types#bad_return)
- [BAD_RETURN_LATENT](/docs/next/all-issue-types#bad_return_latent)
- [COMPARED_TO_NULL_AND_DEREFERENCED](/docs/next/all-issue-types#compared_to_null_and_dereferenced)
- [CONFIG_USAGE](/docs/next/all-issue-types#config_usage)
- [CONSTANT_ADDRESS_DEREFERENCE](/docs/next/all-issue-types#constant_address_dereference)
- [CONSTANT_ADDRESS_DEREFERENCE_LATENT](/docs/next/all-issue-types#constant_address_dereference_latent)
Expand Down Expand Up @@ -202,6 +203,7 @@ The following issue types are reported by this checker:
- [PULSE_UNNECESSARY_COPY_OPTIONAL](/docs/next/all-issue-types#pulse_unnecessary_copy_optional)
- [PULSE_UNNECESSARY_COPY_OPTIONAL_CONST](/docs/next/all-issue-types#pulse_unnecessary_copy_optional_const)
- [PULSE_UNNECESSARY_COPY_RETURN](/docs/next/all-issue-types#pulse_unnecessary_copy_return)
- [PULSE_UNNECESSARY_COPY_THRIFT_ASSIGNMENT](/docs/next/all-issue-types#pulse_unnecessary_copy_thrift_assignment)
- [RETAIN_CYCLE](/docs/next/all-issue-types#retain_cycle)
- [RETAIN_CYCLE_NO_WEAK_INFO](/docs/next/all-issue-types#retain_cycle_no_weak_info)
- [SENSITIVE_DATA_FLOW](/docs/next/all-issue-types#sensitive_data_flow)
Expand Down
43 changes: 20 additions & 23 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.

7 changes: 7 additions & 0 deletions website/static/man/next/infer-capture.1.html

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

37 changes: 31 additions & 6 deletions 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.

Loading

0 comments on commit 669b32a

Please sign in to comment.