From 6cf82d4a8085fa7ac08e796da31a654071f321b3 Mon Sep 17 00:00:00 2001 From: tampsa <122342280+tampsa@users.noreply.github.com> Date: Thu, 4 May 2023 10:32:35 +0300 Subject: [PATCH] doc: Update Werror flag instructions --- BUILDING.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index c432d46..5bc75d9 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -110,15 +110,14 @@ It is possible to silence all prints coming from uvgRTP by enabling following pa cmake -DUVGRTP_DISABLE_PRINTS=1 .. ``` -## Allow compiler warnings by disabling Werror +## Disallow compiler warnings by enabling Werror flag -If the compiler warnings are causing your build to fail without you making any modifications, you may use this option to disable the `-Werror`-flag: +`-Werror`-flag is disabled by default, but you can enable it by disabling the following flag: ``` -cmake -DUVGRTP_DISABLE_WERROR=1 .. +cmake -DUVGRTP_DISABLE_WERROR=0 .. ``` - -Creation of an issue on Github that describes these warnings is also appreciated. +This is recommended before making a pull request. ## Not building examples or tests