Merge pull request #1981 from smoe/docs_HAL_TWOPASS

Docs HAL twopass

Author: hansu

docs/src/hal/twopass.adoc

@@ -14,7 +14,7 @@
 
 LinuxCNC 2.5 supports TWOPASS processing of LinuxCNC configuration files
 that can help in the modularization and readability of LinuxCNC files.
-(LinuxCNC files are specified in an LinuxCNC ini file in the LinuxCNC stanza
+(LinuxCNC files are specified in an LinuxCNC INI file in the LinuxCNC stanza
 as [LinuxCNC]HALFILE=filename).
 
 Normally, a set of one or more LinuxCNC configuration files must use a single,
@@ -45,7 +45,7 @@ and their names since when you add (or remove) a component, you
 must find and update the single loadrt directive applicable to
 the component.
 
-TWOPASS processing is enabled by including an ini file parameter in
+TWOPASS processing is enabled by including an INI file parameter in
 the [HAL] section:
 
 [source,{ini}]
@@ -67,8 +67,9 @@ loadrt and2 names=ab,ac
 loadrt and2 names=ad
 ----
 
-These commands can appear in different HALFILES.  The HALFILES
-are processed in the order of their appearance in the ini file.
+These commands can appear in different HAL files. The HAL files
+are processed in the order of their appearance in the INI file,
+in multiple HALFILE assignments.
 
 The TWOPASS option can be specified with options to add output for
 debugging (verbose) and to prevent deletion of temporary files (nodelete).
@@ -134,7 +135,7 @@ encoder_ratio, pid, siggen, and sim_encoder.
 
 Two-step processing occurs before the GUI is loaded. When using a
 [HAL]POSTGUI_HALFILE, it is convenient to place all the [HAL]POSTGUI_HALFILE
-loadrt declarations for the necessary components in a preloaded halfile.
+loadrt declarations for the necessary components in a preloaded HAL file.
 
 .Example of a HAL section when using a POSTGUI_HALFILE
 [source,{ini}]
@@ -154,10 +155,10 @@ HALUI = halui
 
 == Post GUI
 
-Some GUIs support halfiles that are processed after the GUI is started in order
-to connect LinuxCNC pins that are created by the GUI.  When using a postgui halfile with
-TWOPASS processing, include all loadrt items for components added by postgui halfiles
-in a separate halfile that is processed before the GUI.  The addf commands can also
+Some GUIs support HAL files that are processed after the GUI is started in order
+to connect LinuxCNC pins that are created by the GUI.  When using a postgui HAL file with
+TWOPASS processing, include all loadrt items for components added by postgui HAL files
+in a separate HAL file that is processed before the GUI.  The addf commands can also
 be included in the file.
 
 .Example

docs/src/ladder/classic-ladder.adoc

@@ -605,20 +605,23 @@ digit number eg. %Q3, or %B123. Q coils control HAL out pins, e.g. if
 %Q15 is energized then HAL pin classicladder.0.out-15 will be true. B
 coils are internal coils used to control program flow.
 
-* 'N.O. COIL' - (a relay coil.) When coil is energized it's N.O. contact
-  will be closed (on, true, etc)
-* 'N.C. COIL' - (a relay coil that inverses its contacts.) When coil is
-  energized it"s N.O. contact will be open (off, false, etc)
-* 'SET COIL' - (a relay coil with latching contacts) When coil is energized
-  it's N.O. contact will be latched closed.
-* 'RESET COIL' - (a relay coil with latching contacts) When coil is
-  energized It's N.0. contact will be latched open.
-* 'JUMP COIL' - (a 'goto' coil) when coil is energized ladder program jumps
-  to a rung (in the CURRENT section) -jump points are designated by a
-  rung label. (Add rung labels in the section display, top left label
-  box)
-* 'CALL COIL' - (a 'gosub' coil) when coil is energized program jumps to a
-  subroutine section designated by a subroutine number -subroutines are
+* 'N.O. COIL' - A relay coil: When coil is energized, then its contact
+  that is normally open (short: N.O.) will be closed (turned on, true,
+  etc.) and the current may pass.
+* 'N.C. COIL' - A relay coil that inverses its contacts: When coil is
+  energized, then its contact that is normally closed (short: N.C.) will be opened
+  (turned off, false, etc) and the current flow is interrupted.
+* 'SET COIL' - A relay coil with latching contacts: When coil is energized
+  then its N.O. contact will be latched closed.
+* 'RESET COIL' - A relay coil with latching contacts: When coil is
+  energized then its N.O. contact will be latched open.
+* 'JUMP COIL' - A 'goto' coil: When coil is energized then the
+  ladder program jumps
+  to a rung (in the CURRENT section) - jump points are designated by a
+  rung label. (Add rung labels in the section display, top left label box.)
+* 'CALL COIL' - A 'gosub' coil: When coil is energized then the program
+  jumps to a
+  subroutine section designated by a subroutine number - subroutines are
   designated SR0 to SR9 (designate them in the section manager)
 
 [WARNING]