aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/golangci/go-misc/deadcode/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/golangci/go-misc/deadcode/README.md')
-rw-r--r--vendor/github.com/golangci/go-misc/deadcode/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/vendor/github.com/golangci/go-misc/deadcode/README.md b/vendor/github.com/golangci/go-misc/deadcode/README.md
new file mode 100644
index 000000000..550423128
--- /dev/null
+++ b/vendor/github.com/golangci/go-misc/deadcode/README.md
@@ -0,0 +1,18 @@
+# deadcode
+
+`deadcode` is a very simple utility which detects unused declarations in a Go package.
+
+## Usage
+```
+deadcode [-test] [packages]
+
+ -test Include test files
+ packages A list of packages using the same conventions as the go tool
+```
+
+## Limitations
+
+* Self-referential unused code is not currently reported
+* A single package can be tested at a time
+* Unused methods are not reported
+