summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRob Pike <r@golang.org>2009-11-03 22:19:56 -0800
committerRob Pike <r@golang.org>2009-11-03 22:19:56 -0800
commitca3cf3dd6309bf0b9b11ec59bdb12b443ed25c7e (patch)
tree3380cb4c85c937c901cb6b0562527308da84227d
parentb2000a623a783af4ff57f494a4d2d9280b0a37c1 (diff)
downloadgolang-ca3cf3dd6309bf0b9b11ec59bdb12b443ed25c7e.tar.gz
document ebnflint
R=gri http://go/go-review/1016034
-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..d395a3468
--- /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.
+
+/*
+
+The ebnflint program verifies that EBNF productions in an HTML document
+such as the Go specification document are consistent and grammatically correct.
+
+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