summaryrefslogtreecommitdiff
path: root/vendor/codeberg.org/gruf/go-debug/README.md
diff options
context:
space:
mode:
authorLibravatar Terin Stock <terinjokes@gmail.com>2022-04-26 20:30:25 -0700
committerLibravatar Terin Stock <terinjokes@gmail.com>2023-01-31 15:16:42 +0100
commit83b4c9ebc87d0fddf4e638f13e3af1483912e3a5 (patch)
tree47840b84c0fd3cb226eab2ecb3dbce0617163406 /vendor/codeberg.org/gruf/go-debug/README.md
parent[chore] update URLs to forked source (diff)
downloadgotosocial-83b4c9ebc87d0fddf4e638f13e3af1483912e3a5.tar.xz
[chore] remove vendor
Diffstat (limited to 'vendor/codeberg.org/gruf/go-debug/README.md')
-rw-r--r--vendor/codeberg.org/gruf/go-debug/README.md37
1 files changed, 0 insertions, 37 deletions
diff --git a/vendor/codeberg.org/gruf/go-debug/README.md b/vendor/codeberg.org/gruf/go-debug/README.md
deleted file mode 100644
index 44cbc9d5f..000000000
--- a/vendor/codeberg.org/gruf/go-debug/README.md
+++ /dev/null
@@ -1,37 +0,0 @@
-# go-debug
-
-This library provides a very simple method for compile-time or runtime determined debug checks, set using build tags.
-
-The compile-time checks use Go constants, so when disabled your debug code will not be compiled.
-
-The possible build tags are:
-
-- "debug" || "" = debug determined at compile-time
-
-- "debugenv" = debug determined at runtime using the $DEBUG environment variable
-
-An example for how this works in practice can be seen by the following code:
-
-```
-func main() {
- println("debug.DEBUG() =", debug.DEBUG())
-}
-```
-
-```
-# Debug determined at compile-time, it is disabled
-$ go run .
-debug.DEBUG() = false
-
-# Debug determined at compile-time, it is enabled
-$ go run -tags=debug .
-debug.DEBUG() = true
-
-# Debug determined at runtime, $DEBUG is not set
-$ go run -tags=debugenv .
-debug.DEBUG() = false
-
-# Debug determined at runtime, $DEBUG is set
-$ DEBUG=y go run -tags=debugenv .
-debug.DEBUG() = true
-``` \ No newline at end of file