Merge pull request #2537 from smoe/docs29_mac_102

Updates to documentation while reviewing translations (smoe:Docs29 mac 102)

Author: hansu

docs/man/man1/gs2_vfd.1

@@ -26,7 +26,7 @@
 .TH gs2_vfd "1" "January 1, 2009" "GS2 VFD" "LinuxCNC Documentation"
 
 .SH NAME
-\fBgs2_vfd\fR \- HAL non-realtime component for Automation Direct GS2 VFD's
+\fBgs2_vfd\fR \- HAL non-realtime component for Automation Direct GS2 VFDs
 
 .SH SYNOPSIS
 .B gs2_vfd

docs/man/man1/milltask.1

@@ -3,22 +3,16 @@
 \fBmilltask\fR \- Non-realtime task controller for LinuxCNC
 .SH DESCRIPTION
 
-\fBmilltask\fR is an internal process of LinuxCNC.  It is generally not
-invoked directly but by an INI file setting: \fB[TASK]TASK=milltask\fR.
-The \fBmilltask\fR process creates the \fBini.*\fR HAL pins listed below
-and owned by the \fBinihal\fR component.  These pins may be modified
-while LinuxCNC is running to alter values that are typically specified
-in an INI file.
+\fBmilltask\fR is an internal process of LinuxCNC.
+It is generally not invoked directly but by an INI file setting: \fB[TASK]TASK=milltask\fR.
+The \fBmilltask\fR process creates the \fBini.*\fR HAL pins listed below and owned by the \fBinihal\fR component.
+These pins may be modified while LinuxCNC is running to alter values that are typically statically specified in an INI file.
 
-The \fBinihal\fR pins are sampled in every task cycle, however, commands
-affected by their values typically use the value present at the time
-when the command is processed.  Such commands include all codes handled
-by the interpreter (\fBG-code\fR programs and \fBMDI\fR commands) and NML
-\fBjogging\fR commands issued by a GUI (including \fBhalui\fR).
-\fBWheel jogging\fR is implemented in the realtime motion module so
-\fBinihal\fR pin changes (e.g., ini.*.max_velocity,
-ini.*.max_acceleration) may be honored as soon as altered values are
-propagated to the motion module.
+The \fBinihal\fR pins are sampled in every task cycle, however,
+commands affected by their values typically use the value present at the time when the command is processed.
+Such commands include all codes handled by the interpreter (\fBG-code\fR programs and \fBMDI\fR commands)
+and NML \fBjogging\fR commands issued by a GUI (including \fBhalui\fR).
+\fBWheel jogging\fR is implemented in the realtime motion module so \fBinihal\fR pin changes (e.g., ini.*.max_velocity, ini.*.max_acceleration) may be honored as soon as altered values are propagated to the motion module.
 
 .SH PINS
 .SS Per-joint pins (N == joint number)
@@ -100,13 +94,7 @@ Allows adjustment of \fB[TRAJ]ARC_BLEND_RAMP_FREQ
 
 .SH NOTES
 
-The \fBinihal\fR pins cannot be linked or set in a HAL file that is
-specified by an INI file \fB[HAL]HALFILE\fR item because they are not created
-until \fBmilltask\fR is started.  The \fBinihal\fR pin values can be
-altered by independent halcmd programs specified by
-\fB[APPLICATION]APP\fR items or by GUIs that support a
-\fB[HAL]POSTGUI_HALFILE\fR.
+The \fBinihal\fR pins cannot be linked or set in a HAL file that is specified by an INI file \fB[HAL]HALFILE\fR item because they are not created until \fBmilltask\fR is started.
+The \fBinihal\fR pin values can be altered by independent halcmd programs specified by \fB[APPLICATION]APP\fR items or by GUIs that support a \fB[HAL]POSTGUI_HALFILE\fR.
 
-The INI file is not automatically updated with values altered by
-\fBinihal\fR pin settings  but can be updated using the calibration
-program (emccalib.tcl) when using a \fB[HAL]POSTGUI_HALFILE\fR.
+The INI file is not automatically updated with values altered by \fBinihal\fR pin settings but can be updated using the calibration program (emccalib.tcl) when using a \fB[HAL]POSTGUI_HALFILE\fR.

docs/man/man3/hal_add_funct_to_thread.3hal

@@ -32,7 +32,7 @@ This determines how often and in what order functions are executed.
 Returns a HAL status code.
 
 .SH REALTIME CONSIDERATIONS
-Call only from realtime init code, not from realtime or non-realtime code.
+Call only from realtime init code, not from other realtime or non-realtime code.
 
 .SH SEE ALSO
 \fBhal_thread_new(3hal)\fR, \fBhal_export_funct(3hal)\fR

docs/man/man3/hal_create_thread.3hal

@@ -18,23 +18,21 @@ The name of the thread
 The interval, in nanoseconds, between iterations of the thread
 
 .IP \fIuses_fp\fR
-Must be nonzero if a function which uses floating-point will be attached
-to this thread.
+Must be nonzero if a function which uses floating-point will be attached to this thread.
 
 .SH DESCRIPTION
-\fBhal_create_thread\fR establishes a realtime thread that will
-execute one or more HAL functions periodically.
+\fBhal_create_thread\fR establishes a realtime thread that will execute one or more HAL functions periodically.
 
-All thread periods are rounded to integer multiples of the hardware timer
-period, and the timer period is based on the first thread created.  Threads
-must be created in order, from the fastest to the slowest.  HAL assigns
-decreasing priorities to threads that are created later, so creating them
-from fastest to slowest results in rate monotonic priority scheduling.
+All thread periods are rounded to integer multiples of the hardware timer period,
+and the timer period is based on the first thread created.
+Threads must be created in order, from the fastest to the slowest.
+HAL assigns decreasing priorities to threads that are created later,
+so creating them from fastest to slowest results in rate monotonic priority scheduling.
 
 \fBhal_delete_thread\fR deletes a previously created thread.
 
 .SH REALTIME CONSIDERATIONS
-Call only from realtime init code, not from realtime or non-realtime code.
+Call only from realtime init code, not from other realtime or non-realtime code.
 
 .SH RETURN VALUE
 Returns a HAL status code.

docs/man/man3/hm2_allocate_bspi_tram.3hm2

@@ -22,7 +22,7 @@ This function allocates the TRAM memory and sets up the regular data transfers.
 It should be called only when all the frames have been defined by calls to hm2_tram_add_bspi_frame(). 
 
 .SH REALTIME CONSIDERATIONS
-Call only from realtime init code, not from realtime code or non-realtime components.
+Call only from realtime init code, not from other realtime code or non-realtime components.
 
 .SH RETURN VALUE
 Returns 0 on success and \-1 on failure.

docs/man/man3/hm2_bspi_set_read_function.3hm2

@@ -4,8 +4,7 @@
 .TH hm2_bspi_set_read_function "3hm2" "2011-05-31" "LinuxCNC Documentation" "Hostmot2"
 .SH NAME
 
-hm2_bspi_set_read_function \- Register a function to handle the tram write phase
-of a hostmot2 buffered SPI driver. 
+hm2_bspi_set_read_function \- Register a function to handle the tram write phase of a hostmot2 buffered SPI driver. 
 .SH SYNTAX
 .nf
 .B #include <hostmot2-serial.h>
@@ -14,28 +13,25 @@ int hm2_bspi_set_read_function(char *name, void *func, void *subdata)
 
 .SH DESCRIPTION
 \fBhm2_bspi_set_read_function\fR registers a function in an external driver
-to be called every time that the main Hostmot2
-driver calls the generic "process_tram_read" function.
-The names of the available channels are printed with rtapi_print_msg during the
-driver loading process and take the form:
+to be called every time that the main Hostmot2 driver calls the generic "process_tram_read" function.
+The names of the available channels are printed with rtapi_print_msg during the driver loading process and take the form:
 .RS
 hm2_<board name>.<board index>.bspi.<index>
 .RE
 For example hm2_5i23.0.bspi.0.
 
-"func" should be a pointer to a function in the sub driver which is to be
-called to process the results of the BSPI TRAM read phase. The function must 
-take a single argument, a pointer to an individual instance of the internal 
-driver. If defined in comp then the function must \fBnot\fP use the FUNCTION()
-convenience macro, and the argument to the function in the definition  must 
-\fBalways\fP be (struct state *inst).
+"func" should be a pointer to a function in the sub driver
+which is to be called to process the results of the BSPI TRAM read phase.
+The function must take a single argument, a pointer to an individual instance of the internal driver.
+If defined in comp then the function must \fBnot\fP use the FUNCTION() convenience macro,
+and the argument to the function in the definition  must \fBalways\fP be (struct state *inst).
 
-"subdata" is a pointer to the driver instance internal data. In the case of a
-driver written in comp this will always be "inst" in the function call and the
-call should be anywhere in the EXTRA_SETUP code. 
+"subdata" is a pointer to the driver instance internal data.
+In the case of a driver written in comp this will always be "inst" in the function call and
+the call should be anywhere in the EXTRA_SETUP code. 
 
 .SH REALTIME CONSIDERATIONS
-Call only from realtime init code, not from realtime code or non-realtime components.
+Call only from realtime init code, not from other realtime code or non-realtime components.
 
 .SH RETURN VALUE
 Returns 0 on success and \-1 on failure.

docs/man/man3/hm2_bspi_set_write_function.3hm2

@@ -4,8 +4,7 @@
 .TH hm2_bspi_set_write_function "3hm2" "2011-05-31" "LinuxCNC Documentation" "Hostmot2"
 .SH NAME
 
-hm2_bspi_set_write_function \- Register a function to handle the tram write phase
-of a hostmot2 buffered SPI driver. 
+hm2_bspi_set_write_function \- Register a function to handle the tram write phase of a hostmot2 buffered SPI driver. 
 .SH SYNTAX
 .nf
 .B #include <hostmot2-serial.h>
@@ -14,30 +13,26 @@ int hm2_bspi_set_write_function(char *name, void *func, void *subdata)
 
 .SH DESCRIPTION
 \fBhm2_bspi_set_write_function\fR registers a function in an external driver
-to be called every time that the main Hostmot2
-driver calls the generic "prepare_tram_write" functions. 
-The names of the available channels are printed with rtapi_print_msg during the
-driver loading process and take the form:
+to be called every time that the main Hostmot2 driver calls the generic "prepare_tram_write" functions. 
+The names of the available channels are printed with rtapi_print_msg during the driver loading process and take the form:
 .RS
 hm2_<board name>.<board index>.bspi.<index>
 .RE
 For example hm2_5i23.0.bspi.0.
 
-"func" should be a pointer to a function in the sub driver which is to be
-called to process the pins into BSPI write registers prior to the regular TRAM
-write phase. The function must take a single argument, a pointer to an
-individual instance of the internal driver. If defined in comp then the 
-function must \fBnot\fP use the FUNCTION() convenience macro, and the argument
-to the function in the definition  must \fBalways\fP be (struct state *inst).
+"func" should be a pointer to a function in the sub driver
+which is to be called to process the pins into BSPI write registers prior to the regular TRAM write phase.
+The function must take a single argument, a pointer to an individual instance of the internal driver.
+If defined in comp then the function must \fBnot\fP use the FUNCTION() convenience macro,
+and the argument to the function in the definition must \fBalways\fP be (struct state *inst).
 
-"subdata" is a pointer to the driver instance internal data. In the case of a
-driver written in comp this will always be "inst" in the function call.
+"subdata" is a pointer to the driver instance internal data.
+In the case of a driver written in comp this will always be "inst" in the function call.
 
-If using comp then the call to this function should be anywhere in the
-EXTRA_SETUP code. 
+If using comp then the call to this function should be anywhere in the EXTRA_SETUP code. 
 
 .SH REALTIME CONSIDERATIONS
-Call only from realtime init code, not from realtime code or non-realtime components.
+Call only from realtime init code, not from other realtime code or non-realtime components.
 
 .SH RETURN VALUE
 Returns 0 on success and \-1 on failure.

docs/man/man3/hm2_bspi_setup_chan.3hm2

@@ -56,7 +56,7 @@ Set to 1 to sample the received SPI data 1/2 SPI clock later than normal.
 This is useful when high clock rates or isolation cause significant delays from clock to received data.
 
 .SH REALTIME CONSIDERATIONS
-Call only from within realtime init/cleanup code or non-realtime components, not from relatime tasks.
+Call only from within realtime init/cleanup code or non-realtime components, not from realtime tasks.
 
 .SH RETURN VALUE
 Returns 0 on success and \-1 on failure.

docs/man/man3/hm2_tram_add_bspi_frame.3hm2

@@ -12,22 +12,18 @@ hm2_tram_add_bspi_frame \- add a register-write to the Hostmot2 TRAM
 hm2_tram_add_bspi_frame(char *name, int chan, u32 **wbuff, u32 **rbuff)
 
 .SH DESCRIPTION
-\fBhm2_tram_add_bspi_frame\fR Add a regular (every thread) write event to the 
-Hostmot2 tram for bspi instance "name". "name" is a unique string given to each 
-bspi channel during hostmot2 setup. The names of the available
-channels are printed to standard output during the driver loading process and 
-take the form:
+\fBhm2_tram_add_bspi_frame\fR Add a regular (every thread) write event to the Hostmot2 tram for bspi instance "name".
+"name" is a unique string given to each bspi channel during hostmot2 setup.
+The names of the available channels are printed to standard output during the driver loading process and take the form:
 hm2_<board name>.<board index>.bspi.<index> For example hm2_5i23.0.bspi.0
 
-This function is used to add a regular, every thread, write or write-read 
-transaction to the Translation RAM system. A write need not have a read (use 0
-for **rbuff) but it is an error to have a read without a write. Note that the 
-TRAM list is not actioned until the hm2_allocate_bspi_tram function is called. 
-The read and write parameters must be pointers to pointers, as TRAM re-maps the 
-buffers into contiguous memory. 
+This function is used to add a regular, every thread, write or write-read transaction to the Translation RAM system.
+A write need not have a read (use 0 for **rbuff) but it is an error to have a read without a write.
+Note that the TRAM list is not actioned until the hm2_allocate_bspi_tram function is called. 
+The read and write parameters must be pointers to pointers, as TRAM re-maps the buffers into contiguous memory. 
 
 .SH REALTIME CONSIDERATIONS
-Call only from realtime init code, not from realtime code or non-realtime components.
+Call only from realtime init code, not from other realtime code or non-realtime components.
 
 .SH RETURN VALUE
 Returns 0 on success and \-1 on failure.