update debian/README.source regarding new BstLexer/Parser generated with ANTLR 3.2
[debian/jabref.git] / debian / README.source
index 7df3fd2cc80727ab05276022565c1cf9457787ff..64f049668e2d016b5c73307c8ac7d7b3a2e6feae 100644 (file)
@@ -4,3 +4,16 @@ debian/patches and applied during the build.
 
 See /usr/share/doc/quilt/README.source for a detailed explanation.
 
 
 See /usr/share/doc/quilt/README.source for a detailed explanation.
 
+The files ./src/java/net/sf/jabref/bst/BstLexer.java and
+./src/java/net/sf/jabref/bst/BstParser.java are generated with
+the command (also note that the Bst.g file is included in the patch
+debian/patches/05_antlrv32.patch):
+
+       antlr3 Bst.g
+
+After generation, they are hand-edited to contain the proper
+Java package name and to correct an issue with the _channel
+member field.  The maintainers are working with upstream to 
+either include the generation as part of the build process
+or to ship the upstream tarball with versions of the parser
+and lexer that operate with antlr 3.2.