More changes performed while translating

Author: smoe

docs/src/hal/basic-hal.adoc

@@ -162,10 +162,10 @@ pin works not how it is handled in HAL.
 
 A pin can be connected to a signal if it obeys the following rules:
 
-* An IN pin can always be connected to a signal
-* An IO pin can be connected unless there's an OUT pin on the signal
+* An IN pin can always be connected to a signal.
+* An IO pin can be connected unless there's an OUT pin on the signal.
 * An OUT pin can be connected only if there are no other OUT or IO pins
-  on the signal
+  on the signal.
 
 The same 'signal-name' can be used in multiple net commands to connect
 additional pins, as long as the rules above are obeyed.
@@ -319,7 +319,7 @@ A 'float' is a floating point number. In other words the decimal point
 can move as needed.
 
 - float values = a 64 bit floating point value, with approximately 53 bits of
-  resolution and over 1000 bits of dynamic range.
+  resolution and over 2^10 (~ 1000) bits of dynamic range.
 
 For more information on floating point numbers see:
 
@@ -331,14 +331,14 @@ http://en.wikipedia.org/wiki/Floating_point[http://en.wikipedia.org/wiki/Floatin
 An 's32' number is a whole number that can have a negative or positive
 value.
 
-- s32 values = integer numbers -2147483648 to 2147483647
+- s32 values = integer numbers from -2147483648 to 2147483647
 
 [[sub:hal-u32]]
 === u32(((HAL u32,u32)))
 
 A 'u32' number is a whole number that is positive only.
 
-- u32 values = integer numbers 0 to 4294967295
+- u32 values = integer numbers from 0 to 4294967295
 
 [[sec:hal-files]]
 == HAL Files(((HAL Files)))
@@ -353,7 +353,7 @@ have up to three HAL files in your config directory.
   GUI is loaded.
 - 'custom_postgui.hal' This file is loaded after the GUI loads. This is
   where you put your custom HAL commands that you want loaded after the
-  GUI is loaded. Any HAL commands that use pyVCP widgets need to be
+  GUI is loaded. Any HAL commands that use PyVCP widgets need to be
   placed here.
 
 [[sec:hal-parameters]]

docs/src/hal/canonical-devices.adoc

@@ -108,7 +108,7 @@ of values. Examples are digital to analog converters or PWM generators.
 === Parameters(((HAL Analog Output Parameters)))
 
 (float) *offset*:: This will be added to the *value* before the
-  hardware is updated
+  hardware is updated.
 (float) *scale*:: This should be set so that an input of 1 on the
   *value* pin will cause the analog output pin to read 1 volt.
 (float) *high_limit* (optional):: When calculating the value to
@@ -118,7 +118,7 @@ of values. Examples are digital to analog converters or PWM generators.
   to the hardware, if *value* + *offset* is less than *low_limit*, then
   *low_limit* will be used instead.
 (float) *bit_weight* (optional):: The value of one least significant
-  bit (LSB), in volts (or mA, for current outputs)
+  bit (LSB), in volts (or mA, for current outputs).
 (float) *hw_offset*  (optional):: The actual voltage (or current)
   that will be output if 0 is written to the hardware.
 

docs/src/hal/comp.adoc

@@ -67,7 +67,7 @@ addf ddt.0 servo-thread
 ----
 
 More information on 'loadrt' and 'addf' can be found in the
-<<cha:basic-hal-reference,Hal Basics>>.
+<<cha:basic-hal-reference,HAL Basics>>.
 
 To test your component you can follow the examples in the
 <<cha:hal-tutorial,HAL Tutorial>>.
@@ -307,8 +307,8 @@ parameters, and functions for `prefix`.
   in the automatically defined 'rtapi_app_main'.
 
 * 'option userspace yes' - (default: no)
-  If specified, this file describes a userspace (ie, non-realtime) component, rather
-  than a regular (ie, realtime) one. A userspace component may not have functions
+  If specified, this file describes a userspace (i.e., non-realtime) component, rather
+  than a regular (i.e., realtime) one. A userspace component may not have functions
   defined by the 'function'  directive. Instead, after all the
   instances are constructed, the C function `void user_mainloop(void);`
   is called. When this function returns, the component exits.
@@ -358,8 +358,8 @@ The result of using any other option is undefined. +
   license "GPL"; // indicates GPL v2 or later
 +
 For additional information on the meaning of MODULE_LICENSE() and
-additional license identifiers, see '<linux/module.h>'. or the manual page
-'rtapi_module_param(3)'
+additional license identifiers, see '<linux/module.h>' or the manual page
+'rtapi_module_param(3)'.
 +
 This declaration is *required*.
 
@@ -456,7 +456,7 @@ when its 'condition' evaluated to a nonzero value.
 * 'variable_name' - For each variable 'variable_name'  there is a macro which allows the
   name to be used on its own to refer
   to the variable. When 'variable_name' is an array, the normal C-style
-  subscript is used: 'variable_name[idx]'
+  subscript is used: 'variable_name[idx]'.
 
 * 'data' - If "option data" is specified, this macro allows access to the
   instance data.
@@ -803,10 +803,10 @@ which creates the following pins:
 - 3-input AND and XOR gates: logic.2.and, logic.2.xor, logic.2.in-00,
   logic.2.in-01, logic.2.in-02
 
-=== general functions
+=== General Functions
 
-This example shows how to call functions from the main function. +
-it also shows how to pass reference of HAL pins to those functions. +
+This example shows how to call functions from the main function.
+It also shows how to pass reference of HAL pins to those functions.
 
 [source,c]
 ----
@@ -844,7 +844,7 @@ FUNCTION(_) {
 }
 ----
 
-This component uses two general function to manipulate a HAL bit pin referenced to it. +
+This component uses two general function to manipulate a HAL bit pin referenced to it.
 
 == Command Line Usage
 

docs/src/hal/components.adoc

@@ -124,15 +124,15 @@ deadzone:: (((deadzone))) Return the center if within the threshold.
 
 hypot:: (((hypot))) Three-input hypotenuse (Euclidean distance) calculator.
 
-mult2:: (((mult2))) Product of two inputs.
+mult2:: (((mult2))) Product of two inputs (multiplexing).
 
-mux16:: (((mux16))) Select from one of sixteen input values.
+mux16:: (((mux16))) Select from one of sixteen input values (multiplexing).
 
-mux2:: (((mux2))) Select from one of two input values.
+mux2:: (((mux2))) Select from one of two input values (multiplexing).
 
-mux4:: (((mux4))) Select from one of four input values.
+mux4:: (((mux4))) Select from one of four input values (multiplexing).
 
-mux8:: (((mux8))) Select from one of eight input values.
+mux8:: (((mux8))) Select from one of eight input values (multiplexing).
 
 near:: (((near))) Determine whether two values are roughly equal.
 

docs/src/hal/hal-examples.adoc

@@ -80,7 +80,7 @@ In this example it is assumed that you're 'rolling your own'
 configuration and wish to add the HAL Manual Toolchange window. The HAL
 Manual Toolchange is primarily useful if you have presettable tools and
 you store the offsets in the tool table. If you need to touch off for
-each tool change then it is best just to split up your g code. To use
+each tool change then it is best just to split up your G-code. To use
 the HAL Manual Toolchange window you basically have to load the
 hal_manualtoolchange component then send the iocontrol 'tool change' to
 the hal_manualtoolchange 'change' and send the hal_manualtoolchange

docs/src/hal/halshow.adoc

@@ -91,7 +91,7 @@ as focused as you need.
 
 .[yellow-background]#New in 2.9#
 * Selected text from the Show tab can be copied by right-click or CTRL-C.
-* The command entry provides now a bash-like history (only for the session) for executed commands.
+* The command entry provides now a BASH-like history (only for the session) for executed commands.
 
 If we take a closer look at the tree display we can see that the six
 major parts of a HAL can all be expanded at least one level. As these
@@ -136,7 +136,6 @@ to axis position so that we could see the rate of change in position, i.e.,
 acceleration. We first need to load a HAL component named ddt, add it to the 
 servo thread, then connect it to the position pin of a joint. Once that is 
 done we can find the output of the differentiator in halscope. So let's go. 
-(Yes, I looked this one up.
 
 [source,{hal}]
 ----

docs/src/hal/intro.adoc

@@ -320,7 +320,7 @@ does - that is determined by which functions are
 connected to it. The real distinction is simply how often a thread
 runs.
 
-In LinuxCNC you might have a 50 us thread and a 1 ms thread.
+In LinuxCNC you might have a 50 µs thread and a 1 ms thread.
 These would be created based on BASE_PERIOD and SERVO_PERIOD, the
 actual times depend on the values in your ini file.
 

docs/src/hal/rtcomps.adoc

@@ -144,9 +144,9 @@ timing of the step and direction signals. In the following figure
 the meaning of these parameters is shown. The
 parameters are in nanoseconds, but will be rounded up to an integer
 multiple of the thread period for the threaed that calls
-'make_pulses()'. For example, if 'make_pulses()' is called every 16 us,
+'make_pulses()'. For example, if 'make_pulses()' is called every 16 µs,
 and steplen is 20000, then the step pulses will
-be 2 x 16 = 32 us long. The default value for all four of the parameters
+be 2 x 16 = 32 µs long. The default value for all four of the parameters
 is 1ns, but the automatic rounding takes effect the first time the code
 runs. Since one step requires 'steplen' ns high and 'stepspace' ns
 low, the maximum frequency is 1,000,000,000 divided by
@@ -210,7 +210,7 @@ threads is not supported.
   feedback, updates latches and scales position.
 
 The high speed function 'stepgen.make-pulses' should be run in a very
-fast thread, from 10 to 50 us depending on the
+fast thread, from 10 to 50 µs depending on the
 capabilities of the computer. That thread's period determines the
 maximum step frequency, since 'steplen', 'stepspace', 'dirsetup',
 'dirhold', and 'dirdelay' are all rounded up to a integer multiple of
@@ -332,7 +332,7 @@ not supported.
 
 * '(funct) pwmgen.make-pulses' - High speed function to generate PWM waveforms
   (no floating point). The high speed function 'pwmgen.make-pulses' should be
-  run in the base (fastest) thread, from 10 to 50 us depending on the
+  run in the base (fastest) thread, from 10 to 50 µs depending on the
   capabilities of the computer. That thread's period determines the maximum PWM
   carrier frequency, as well as the resolution of the PWM or PDM signals. If
   the base thread is 50,000nS then every 50uS the module decides if it is time
@@ -355,10 +355,10 @@ rates of 10kHz to perhaps up to 50kHz.
 
 The base thread should be 1/2 count speed to allow for noise and timing
 variation. For example if you have a 100 pulse per revolution encoder on the
-spindle and your maximnum RPM is 3000 the maximum base thread should be 25 us.
+spindle and your maximnum RPM is 3000 the maximum base thread should be 25 µs.
 A 100 pulse per revolution encoder will have 400 counts. The spindle speed
 of 3000 RPM = 50 RPS (revolutions per second). 400 * 50 = 20,000 counts per
-second or 50 us between counts.
+second or 50 µs between counts.
 
 The Encoder Counter Block Diagram is a block diagram of one channel of an
 encoder counter.

docs/src/hal/tutorial.adoc

@@ -221,7 +221,7 @@ should probably disappear.]
 To actually run the code contained in the function 'siggen.0.update',
 we need a realtime thread. The component called 'threads' that is used
 to create a new thread. Lets create a thread called 'test-thread' with
-a period of 1 ms (1,000 us or 1,000,000 ns):
+a period of 1 ms (1,000 µs or 1,000,000 ns):
 
 ----
 halcmd: loadrt threads name1=test-thread period1=1000000
@@ -892,7 +892,7 @@ left click on the samples box.
 image::images/halscope-01.png["Realtime function not linked dialog",align="center"]
 
 This dialog is where you set the sampling rate for the oscilloscope.
-For now we want to sample once per millisecond, so click on the 989 us
+For now we want to sample once per millisecond, so click on the 989 µs
 thread 'slow' and leave the multiplier at 1. We will also leave the
 record length at 4000 samples, so that we can use up to four channels
 at one time. When you select a thread and then click 'OK', the dialog
@@ -1037,11 +1037,11 @@ position slider to determine which part of the zoomed waveform is
 visible. However, sometimes simply expanding the waveforms isn't enough
 and you need to increase the sampling rate. For example, we would like
 to look at the actual step pulses that are being generated in our
-example. Since the step pulses may be only 50 us long, sampling at 1KHz
+example. Since the step pulses may be only 50 µs long, sampling at 1KHz
 isn't fast enough. To change the sample rate, click on the button that
 displays the number of samples and sample rate to bring up the 'Select
 Sample Rate' dialog, figure . For this example, we will click on the
-50 us thread, 'fast', which gives us a sample rate of about 20KHz. Now
+50 µs thread, 'fast', which gives us a sample rate of about 20KHz. Now
 instead of displaying about 4 seconds worth of data, one record is 4000
 samples at 20KHz, or about 0.20 seconds.