veyron/tools/gclogs: A tool that safely deletes old log files.
This new tool can be used to safely delete old log files from log
directories.
$ gclogs --help
gclogs is a utility that safely deletes old log files.
It looks for file names that match the format of files produced by the vlog
package, and deletes the ones that have not changed in the amount of time
specified by the --cutoff flag.
Only files produced by the same user as the one running the gclogs command are
considered for deletion.
Usage:
gclogs [flags] <dir> ...
<dir> ... A list of directories where to look for log files.
The gclogs flags are:
-cutoff=24h0m0s
The age cut-off for a log file to be considered for garbage collection.
-n=false
If true, log files that would be deleted are shown on stdout, but not
actually deleted.
-program=.*
A regular expression to apply to the program part of the log file name, e.g
".*test".
-verbose=false
If true, each deleted file is shown on stdout.
Change-Id: I65f8abaf7a03c6d99d9411003d9746127d284107
diff --git a/tools/gclogs/doc.go b/tools/gclogs/doc.go
new file mode 100644
index 0000000..302fe98
--- /dev/null
+++ b/tools/gclogs/doc.go
@@ -0,0 +1,31 @@
+// This file was auto-generated via go generate.
+// DO NOT UPDATE MANUALLY
+
+/*
+gclogs is a utility that safely deletes old log files.
+
+It looks for file names that match the format of files produced by the vlog
+package, and deletes the ones that have not changed in the amount of time
+specified by the --cutoff flag.
+
+Only files produced by the same user as the one running the gclogs command are
+considered for deletion.
+
+Usage:
+ gclogs [flags] <dir> ...
+
+<dir> ... A list of directories where to look for log files.
+
+The gclogs flags are:
+ -cutoff=24h0m0s
+ The age cut-off for a log file to be considered for garbage collection.
+ -n=false
+ If true, log files that would be deleted are shown on stdout, but not
+ actually deleted.
+ -program=.*
+ A regular expression to apply to the program part of the log file name, e.g
+ ".*test".
+ -verbose=false
+ If true, each deleted file is shown on stdout.
+*/
+package main
