From 265fa03fa0c467c9c41d803ebe2a538e758cba20 Mon Sep 17 00:00:00 2001
From: jvoisin
Date: Wed, 24 Apr 2024 14:49:52 +0200
Subject: Disable pedantic checks by default

They can be re-enabled via `PEDANTIC_CHECKS`
---
 README.md | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 21d3ccf..9b9a956 100644
--- a/README.md
+++ b/README.md
@@ -28,8 +28,10 @@ on Clang. It was initially intended to be used on
   [significant coverage](https://jvoisin.github.io/fortify-headers/)
 - Defining `USE_NATIVE_CHK` will make use of compiler-provided builtin `_chk`
   functions, which might be a bit better in term of diagnostics,
-  but won't necesarily provide the same amount of security checks.
-
+  but won't necessarily provide the same amount of security checks.
+- Defining `PEDANTIC_CHECKS` will enable pedantic checks, that while technically
+  correct, might break some programs relying on widely accepted
+  undefined-behaviours.
 
 # Sample usage
 
-- 
cgit v1.3