From ab6dae7277d087ad7185d7dff6d7c8839c7ca117 Mon Sep 17 00:00:00 2001
From: Victor Lanvin <vlanvin@meta.com>
Date: Wed, 28 Feb 2024 06:06:51 -0800
Subject: [PATCH] Add eqWAlizer analyses and reporting

Summary:
- Deprecate ad-hoc analysis of escape hatches
- Unified framework to write analyses in crate eqWAlizer, powered by `elp eqwalizer-stats`
- Implement analysis of escape hatches using visitor trait

Reviewed By: alanz

Differential Revision: D54063805

fbshipit-source-id: 3559f955074910877dee6a7eb8ff5a3dc5f2db6d
---
 docs/reference/stats.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 docs/reference/stats.md

diff --git a/docs/reference/stats.md b/docs/reference/stats.md
new file mode 100644
index 0000000..8b744a0
--- /dev/null
+++ b/docs/reference/stats.md
@@ -0,0 +1,20 @@
+# eqWAlizer stats
+
+This page references stats that eqWAlizer can report using command `elp eqwalize_stats`.
+
+### eqwalizer_fixme
+
+This indicates the suppression of an error message using a `%eqwalizer:fixme` escape hatch.
+This is discouraged and should be avoided at all costs.
+
+### eqwalizer_ignore
+
+This indicates the suppression of an error message using a `%eqwalizer:ignore` escape hatch.
+This is discouraged and should be avoided at all costs.
+
+### eqwalizer_nowarn
+
+This indicates the suppression of all eqWAlizer errors associated to a function,
+using a `-eqwalizer({nowarn_function, foo/n})` pragma.
+eqWAlizer will not run on such a function, thus the use of this pragma is highly
+discouraged.