src/HOL/TPTP/TPTP_Parser/README
changeset 46846 9e99afaade17
parent 46844 5d9aab0c609c
child 57797 7d319d6ccde0
--- a/src/HOL/TPTP/TPTP_Parser/README	Fri Mar 09 15:39:00 2012 +0000
+++ b/src/HOL/TPTP/TPTP_Parser/README	Fri Mar 09 15:39:06 2012 +0000
@@ -1,9 +1,11 @@
 The TPTP parser is generated using ML-Yacc and relies on the ML-Yacc
 library to function. The ML-Yacc library is an external piece of
-software that needs a small modification for use in Isabelle.  The
-file "make_tptp_parser" patches the ML-Yacc library, generates the
-TPTP parser, and patches that to conform to Isabelle's naming
-conventions.
+software that needs a small modification for use in Isabelle. The
+relationship between Isabelle and ML-Yacc is similar to that with
+Metis (see src/Tools/Metis).
+
+The file "make_tptp_parser" generates the TPTP parser and patches it
+to conform to Isabelle's naming conventions.
 
 In order to generate the parser from its lex/yacc definition you need
 to have the ML-Yacc binaries. The sources can be downloaded via SVN as
@@ -14,20 +16,17 @@
 
 ML-Yacc is usually distributed with Standard ML of New Jersey, and its
 binaries can also be obtained as packages for some distributions of
-Linux.
+Linux. The script "make_tptp_parser" will produce a file called
+tptp_lexyacc.ML -- this is a compilation of the SML files (generated
+by ML-Yacc) making up the TPTP parser.
 
 The generated parser needs ML-Yacc's library. This is distributed with
-ML-Yacc's source code, in the lib/ directory.
-
-Assuming that you've got the ml-lex and ml-yacc binaries, and have a
-copy of the ML-Yacc sources in this directory, then running
-"make_tptp_parser" will generate two files:
-
- ml_yacc_lib.ML -- this is a compilation of slightly modified files
-                   making up ML-Yacc's library.
-
- tptp_lexyacc.ML -- this is a compilation of the SML files making up
-                    the TPTP parser.
+ML-Yacc's source code, in the lib/ directory. The ML-Yacc library
+cannot be used directly and must be patched. The script
+"make_mlyacclib" takes the ML-Yacc library (for instance, as
+downloaded from the ML-Yacc repo) and produces the file ml_yacc_lib.ML
+-- this is a compilation of slightly modified files making up
+ML-Yacc's library.
 
 Nik Sultana
-8th March 2012
\ No newline at end of file
+9th March 2012
\ No newline at end of file