#180 Doc change "rexxref"

[Erich]

This patch changes the following 16 documents in docs/branches/4.1.3/trunk/rexxref
classes.xml
collclasses.xml
dire.xml
funct.xml
fundclasses.xml
instrc.xml
intro.xml
iostrms.xml
numarit.xml
oneof.xml
parsingch.xml
provide.xml
rexutil.xml
spvard.xml
streamclasses.xml
utilityclasses.xml

In addition, templates3.odg was also changed and thus is also referenced in the attached rexxref.patch, but it seems that changes to binary files cannot be transported through the SVN DIFF mechanism.
--- templates3.odg
9.8.2. Combining String and Positional Patterns: "Put characters 1 through 1 in var1 (stopping
point is 3)" -> ""Put characters 1 through 2 "...

--- classes.xml (revision 9242)
Corrected link target in "and the <link linkend="clsTimeSpan">WeakReference class</link>"

--- collclasses.xml (revision 9242)
(4x) Corrected typo "subclasses" in "method that must be implemented by a subclasses"
Removed superfluous full-stop in "should not rely on any order.)."
Added "in" after "items" in "Adds all items <emphasis role="italic">collection</emphasis>"
Corrected typo "Oredered" in "of OrederedCollection class"
Removed superfluous full-stop in "should not rely on any order.)."
Changed "classes" to "class" in "The Array classes uses this only to allocate the initial array"
"Nil" -> "NIL" in "/ The Nil object /""
Removed duplicate "the" in "from the receiver that the the argument collection"
Removed superfluous "in" in "that are in also in the argument collection"
(4x) "stacklike" -> "stack-like" in "Last-in, first-out order (stacklike)."
"than" -> "then" in "If the circular queue is full, than the last item stored in the circular queue"
(2x) Removed "first letter of the option" from "Only the first letter of the option capitalized letter is required"
(2x) Removed duplicate "before" in "in the queue will be removed before before"
(2x) Removed superfluous partial sentence in "is added to the queue. removed before the operation is performed."
"than" -> "then" in "If the circular queue is full, than the first item will be deleted"
Removed (duplicate) colon in "<note>"
Corrected typo "Nill" in "the Nill object is returned."
Corrected typo "This" in "Thie is the same as the"
Corrected typo "converted" in "Duplicate indexes can be removed easily by converted the array"
"hasIndex" -> "hasItem" in "If index is specified, hasIndex()"
Corrected typo "iterams" in "The supplier iterams the items in an unspecified order."

--- dire.xml (revision 9242)
Corrected typo "diffent" in "-- same function, but a diffent internal name"

--- funct.xml (revision 9242)
Added space after full-stop in "A function can have a variable number of arguments.You need to specify only those"
Corrected typo "methos" in "Many of the built-in functions invoked methos of the"
(5x) Added missing bracket after "years that are not divisible by 400."
"that" -> "than" in "more digits that the default"
(3x) "that" -> "than" in "more digits that the default NUMERIC DIGITS setting"
Corrected typo "formating" in "formating numbers"
(2x) Addded "is not specfied," after "length" in "If length the default is to convert"
Removed superfluous space before comma in "Registers the function ,"
Corrected typo "prodcure" in "the exported prodcure inside"
Added missing closing bracket after "<link linkend="bifValue">VALUE</link>."
Added missing closing bracket after "<link linkend="bifEndlocal">ENDLOCAL</link>"
Corrected output to "4ab3" in "TRANSLATE("4123", "abcd", "1234", , 2, 2) -> "4ab1""
Addded missing closing """ in "value("MYVAR", ","
Added missing opening bracket before "that" in "name is the name of a variable, that is,"

--- fundclasses.xml (revision 9242)
Added spaces after "E" in "say points[3] / Says: "E"Points is still an array /"
"Nil" -> "NIL" in "say .object~superclass -- displays "The Nil object""
"The Nil" -> "The NIL" in "matches the string value of the Nil object ("The Nil object")."
Addded "is not specfied," after "length" in "If length the default is to convert"
Corrected typo to "optional and" in "argument is opitonal must""
Corrected output to "4ab3" in "4123"~translate("abcd", "1234", , 2, 2) -> "4ab1""
Addded "is not specfied," after "length" in "If length the default is to convert"
Removed superfluous "function." in "the location of the native method. function."
Removed superfluous "function." in "the location of the native routine. function."

--- instrc.xml (revision 9242)
Removed superfluous bracket in "in DO instruction)"
Corrected typo "unassing" in "unassing variables"
Added missing closing bracket in "a 16-bit signed integer (within the range -(215) to (215-1)."
Removed superfluous bracket in "in LOOP instruction)"
Corrected typo "Optiions" in "Optiions might control how the interpreter optimizes code"
Removed superfluous ".)" in "enables implementation-dependent features, etc.)."
Removed duplicate "the" in "or the the value returned"
Corrected typo "orignal" in "The data traced is the orignal name"

--- intro.xml (revision 9242)
Corrected typo "interchangably" in "can be used interchangably"
Corrected ">" to "<" in "less than or equal to operator (>=)"
Removed duplicate "(<=)" in "<= (less than or equal operator(<=)"
Removed superfluous trailing bracket in "<link linkend="ensym">Environment symbols</link>)"
Removed superfluous trailing bracket in "<link linkend="compsym">compound variable</link>)"
"override" -> "overrides" in "the assigned name override the default stem name"
Removed duplicate "the" in "will replace the the Stem object"
Removed superfluous word "a" in "referring to a the same Stem object"
Added missing bracket after "when first used."

--- iostrms.xml (revision 9242)
Corrected typo "reaised" in "reaised by stream errors"

--- numarit.xml (revision 9242)
To match following railroad diagram, added "Ignoring <link linkend="expnot">exponential notation</link>," before "A number in Rexx is defined as follows:"
Corrected description "0 raised to the 123 power"
Corrected description "1 raised to the 342 power"

--- oneof.xml (revision 9242)
Removed superfluous trailing bracket in "<link linkend="clsRexxContext">The RexxContext Class</link>)"

--- parsingch.xml (revision 9242)
Corrected output to "REXX" in "Concatenates variables; displays: "Rexx""

--- provide.xml (revision 9242)
Added missing bracket after "(You usually do this by specifying the special variable <link linkend="xself">SELF</link>."

--- rexutil.xml (revision 9242)
Corrected typo "Pus" in "Pus, since May 2006"
Removed ", if they would like to" from "help the Rexx programmer locate the MSDN Library, if they would like to."
Corrected text from "section on the error codes" to "link to the online MSDN Library" in "A Google search of MSDN Library will turn up .."
Corrected typo "Windown" in "If the Windown system error code"
Changed to Windows 7 "6.01" in "Say SysVersion() -> "WindowsNT 5.00""

--- spvard.xml (revision 9242)
Corrected typo "superperclass" in "will always be the superperclass of the mixin class"

--- streamclasses.xml (revision 9242)
(2x) Corrected typo "Steams" in "unsupported operation for InputSteams"
(4x) Corrected typo "Steams" in "unsupported operation for OutputSteams"
Corrected typo "positve" in "value must be a positve whole number"
Removed superfluous "emphasis." in "<emphasis role="bold">charIn</emphasis>emphasis."
Removed superfluous "emphasis" in "<emphasis role="bold">lines</emphasis>emphasis"

--- utilityclasses.xml (revision 9242)
Added missing bracket after "years that are not divisible by 400."
Corrected typo "particilar" in "Many Comparator implementations are specific to particilar object types."
(2x) Addded "is not specfied," after "length" in "If length the default is to convert"
Corrected typo "itertion" in "itertion progresses."
Removed superfluous space before comma "If the two paths are equal , 0 is returned. If the target path is larger, 1 is returned. -1 if the"
Corrected typo "childrens" in "Returns an array of files/directories names which are immediate childrens of the directory"
Corrected typo "childrens" in "Returns an array of files/directories which are immediate childrens of the directory"

[Mark Miesfeld]

[Mark Miesfeld]

Thanks Erich.

I don't have time to look at this tonight. Just wanted to mention that for a binary file change, just add the file to this ticket as an attachment. A short note is nice, like xxxY file replaces xxxY file in zz/aa directory. Or xxxY file should be added to zz/aa directory.

[Mark Miesfeld]

Thank Erich. The patch looks good and applied cleanly. Work on the doc is especially helpful in my mind.

1.) If you want the image file changed, you need to attach the new file to this patch.

2.) The 4.1.3 docs tree is a branch of the docs that will be included with ooRexx 4.1.3. This tree is branched from: /p/oorexx/code-0/docs/branches/4.1/trunk. Which is itself branched from: /p/oorexx/code-0/docs/trunk

So, to get the changes into the docs permanently, the changes need to be applied to both the 4.1 branch and the main trunk. I call the 4.1 branch the fixes branch. I have also applied the patch to the 4.1 fixes branch.

Unfortunately, in the main trunk we have switched to a different build toolset (publican) and the patch won't apply to trunk because of changes to the source code. If you would like to generate a patch for trunk, that would be cool.

3.) I changed the wording of your fix to the CircularQueue class doc. It is only the first letter of the option that is needed. Case is insignificant.

Thanks again for the patch. I've updated my working copy and will commit the changes tonight.

[Erich]

Mark,

re 1) here's attached the updated docs/branches/4.1.3/trunk/rexxref/templates3.odg as mentioned in above patch description

--- templates3.odg
9.8.2. Combining String and Positional Patterns: "Put characters 1 through 1 in var1 (stopping point is 3)" was changed to "Put characters 1 through 2 "...

re 2) a new patch for main trunk due to different toolset:
I don't (yet) understand a) in what respect the patch won't apply and b) what exactly I will have to do fix it, but I'll look into it.

Are there any error messages (or such) available? Can I test-apply the patch locally to main trunk to see what happens? What would be the appropriate SVN command?

Most important: is there a way to do doc changes, such that patches will apply to all three--4.1.3 branch, 4.1 branch, and main trunk? I guess I need some education as to why we have three active working sets (should an SVN not protect us from such a mess?). Why are we retro-fixing 4.1? Didn't 4.1.2 and now 4.1.3 supersede 4.1 (and as such make it only of historical interest?)

[Mark Miesfeld]

Erich thanks for the binary file.

The reason the patch won't apply is that we changed the toolset used to compile the source code into the doc. This toolset required changes to the source code. This change is only in the main doc trunk.

The patch you created from source A applies to source B (the 4.1 fixes branch) because source A and source B were exactly the same. The patch will not apply to source C (docs/trunk) because source C is very different from source A. Too different for the patch tool to be able to figure out what to do.

To create a patch for trunk, you need to check out docs/trunk into a working copy on you system. Then create a patch from that working copy.

Normally during a beta, if you fix something in the beta, you will have 2 trees to update, always. You will have to update the branch and update the source of the branch. This is always true. Typically the beta period is short and there are only a few things to patch.

However, in the interpreter source code trunk we have code changes that are not complete. To do a bug fix release we can not branch from trunk (currently ooRexx 4.2.0) because that code is not in a form that can be released.

This prevents us from doing any bug fix releases. To fix that problem, we created a branch from the last official release, at the time, and starting applying bug fix only changes to both trunk and this new branch (4.1 fixes). Then to create a bug fix only release, we branch from 4.1.fixes instead of trunk.

A similar thing applies to the doc. The trunk doc, documents things that are not in the code being released. In order to produce doc for the bug fix we also need a 4.1 fixes branch of the doc.

Follow up with questions on the devel list rather than here. That way the discussion will be visible to more people. (I know you already have a post there unanswered, I've just been to busy to reply.)

[Mark Miesfeld]

Committed revision 9259. [r9259] 4.1.3 branch
Committed revision 9260. [r9260] 4.1 fixes branch