aboutsummaryrefslogtreecommitdiffstats
path: root/admin/grammars/README
diff options
context:
space:
mode:
Diffstat (limited to 'admin/grammars/README')
-rw-r--r--admin/grammars/README20
1 files changed, 20 insertions, 0 deletions
diff --git a/admin/grammars/README b/admin/grammars/README
new file mode 100644
index 0000000000..c8328bbc88
--- /dev/null
+++ b/admin/grammars/README
@@ -0,0 +1,20 @@
+This directory contains grammar files in Bison and Wisent, used to
+generate the parser data in the lisp/semantic/bovine/ and
+lisp/semantic/wisent/ directories. You can run the parser generators
+with
+
+emacs -batch --no-site-file -l bovine-grammar.el -f semantic-mode \
+ -f semantic-grammar-batch-build-packages *.by
+
+emacs -batch --no-site-file -l wisent-grammar.el -f semantic-mode \
+ -f semantic-grammar-batch-build-packages *.wy
+
+The output files were subsequently edited by hand to fix copyright
+headers, variable names (to follow library name conventions), and
+feature names. These changes do not alter the code logic, and can be
+viewed by diffing to the files in lisp/semantic/bovine/ and
+lisp/semantic/wisent/.
+
+Currently, the parser files in lisp/ are not generated directly from
+these grammar files when making Emacs. This state of affairs, and the
+contents of this directory, will change in a future version of Emacs.