Started on release notes for version 6.

git-svn-id: http://svn.complang.org/ragel/trunk@402 052ea7fc-9027-0410-9066-f65837a77df0

diff --git a/ChangeLog b/ChangeLog
index 08a424c..c559614 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -21,8 +21,8 @@ Ragel 6.0 - TBR
   error action is executed.
  -The Ragel program now executes frontend and backend processes separately,
   connecting them with a temporary file in the current directory. Without the
-  -f option the "ragel" program marshals arguments and calls the frontend and
-  backend. With the -f option the "ragel" program acts as the frontend only.
+  -x option the "ragel" program marshals arguments and calls the frontend and
+  backend. With the -x option the "ragel" program acts as the frontend only.
  -Added name finding for executables. If any forward slash is found in argv0
   then it is assumed that the path is explicit and the path to the backend
   executable should be derived from that. Whe check that location and also go
@@ -39,8 +39,6 @@ Ragel 6.0 - TBR
  -Dot file generation can now be invoked using the -V option to the parent. We
   now require an input file. If standard in is used then we don't have a file
   name on which to base the output.
- -Rather than have the frontend process call the backend, the ragel program
-  now calls the frontend (itself with the -f option) and the backend.
  -Able to build native windows executables using Cygwin+MinGW. 
  -Patch from David Waite: Large arrays are now created by copying in the data
   from smaller arrays using System.arraycopy(). This eliminates the debug data

diff --git a/doc/RELEASE_NOTES_V6 b/doc/RELEASE_NOTES_V6
new file mode 100644 (file)
index 0000000..9d6daab
--- /dev/null
+++ b/doc/RELEASE_NOTES_V6
@@ -0,0 +1,69 @@
+                      RELEASE NOTES Ragel 6.X
+
+This file describes the changes in Ragel version 5.X that are not backwards
+compatible. For a list of all the changes see the ChangeLog file.
+
+The EOF Event
+=============
+
+The "write eof" command is no longer needed and was removed.
+
+Introcuded the "eof" variable for indicating the end of file. The p variable is
+checked against eof when the processing loop reaches the end of a block. If p
+== eof at this time then the EOF actions are executed. The variable is required
+only when EOF actions have been emebedded.
+
+Scanners now use EOF actions to generate tokens. This eliminates the need to
+flush the last token.
+
+Remove the "write eof" directive.
+
+If the machine has EOF actions then the "eof" variable must be declared and set
+to pe on the last buffer block.
+
+Semantics of > % and Error Actions
+==================================
+
+Gone back to 3.X semantics for >, % and error actions. The > operator also
+embeds a leaving action/priority into the start state if it is final. If EOF
+happens in a state with a leaving operator then leaving action it is executed.
+If EOF happens in a non-final state that has an error action, the error action
+is executed.
+
+Backend Automatically Executed
+==============================
+
+The Ragel program now executes frontend and backend processes separately,
+connecting them with a temporary file in the current directory. Without the -f
+option the "ragel" program marshals arguments and calls the frontend and
+backend. With the -f option the "ragel" program acts as the frontend only.
+
+Makefiles don't need to execute the backend.
+
+The fbreak Statement
+====================
+
+The fbreak statement now advances p.
+
+After an fbreak you do not need to advance p.
+
+Guarded Concatenation Operators are Stronger
+============================================
+
+In the :> :>> and <: operators it was possible for the priority assignment to
+be bypassed via the zero length string. In :> this was fixed automatically with
+the semantics change to the entering priority operator. If the start state is
+final it now embeds a leaving action into it, preventing persistance through
+the zero length string. In :>> and <: this was fixed explicitly. With <: the
+entering priority operator was used and with :> a sepecial exception was added.
+Since it uses the finishing transition operator it also adds a leaving priority
+to the start state if it is final.
+
+The tokstart and tokend Variables Renamed
+=========================================
+
+The "tokstart" and "tokend" variables were changed to "ts" and "te".
+
+Search and replace:
+    tokstart => ts
+    tokend => te