summaryrefslogtreecommitdiff
path: root/src/cmd/ebnflint/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'src/cmd/ebnflint/doc.go')
-rw-r--r--src/cmd/ebnflint/doc.go22
1 files changed, 22 insertions, 0 deletions
diff --git a/src/cmd/ebnflint/doc.go b/src/cmd/ebnflint/doc.go
new file mode 100644
index 000000000..f35976eea
--- /dev/null
+++ b/src/cmd/ebnflint/doc.go
@@ -0,0 +1,22 @@
+// Copyright 2009 The Go Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+/*
+
+Ebnflint verifies that EBNF productions are consistent and gramatically correct.
+It reads them from an HTML document such as the Go specification.
+
+Grammar productions are grouped in boxes demarcated by the HTML elements
+ <pre class="ebnf">
+ </pre>
+
+
+Usage:
+ ebnflint [--start production] [file]
+
+The --start flag specifies the name of the start production for
+the grammar; it defaults to "Start".
+
+*/
+package documentation