Skip to content

Commit 6cfd6d6

Browse files
committed
docs: add syntax highlighting for updating-linuxcnc.adoc
1 parent ea52c64 commit 6cfd6d6

1 file changed

Lines changed: 45 additions & 25 deletions

File tree

docs/src/getting-started/updating-linuxcnc.adoc

Lines changed: 45 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,7 @@ the HAL pin changes.
267267
With incorporation of joints_axes functionality, some names were
268268
changed to clarify available functionality.
269269

270+
[source,{ini}]
270271
----
271272
was: [TRAJ]MAX_VELOCITY is: [TRAJ]MAX_LINEAR_VELOCITY
272273
was: [TRAJ]DEFAULT_VELOCITY is: [TRAJ]DEFAULT_LINEAR_VELOCITY
@@ -285,6 +286,7 @@ branches. To convert, it is necessary to change the name.
285286

286287
HAL file examples:
287288

289+
[source,{hal}]
288290
----
289291
was: loadrt gentrivkins
290292
is: loadrt trivkins
@@ -298,6 +300,7 @@ kinstype= parameter set to BOTH (for KINEMATICS_BOTH).
298300

299301
HAL file example:
300302

303+
[source,{hal}]
301304
----
302305
was: loadrt gantrykins coordinates=xyyz
303306
is: loadrt trivkins coordinates=xyyz kinstype=BOTH
@@ -380,6 +383,7 @@ Examples:
380383

381384
Three axis Cartesian machine using trivkins (KINEMATICS_IDENTITY):
382385

386+
[source,{ini}]
383387
-----
384388
[KINS]KINEMATICS = trivkins
385389
[KINS]JOINTS = 3
@@ -389,6 +393,7 @@ Three axis Cartesian machine using trivkins (KINEMATICS_IDENTITY):
389393
Two axis lathe using trivkins (KINEMATICS_IDENTITY) with non-consecutive
390394
axis letters:
391395

396+
[source,{ini}]
392397
-----
393398
[KINS]KINEMATICS = trivkins coordinates=XZ
394399
[KINS]JOINTS = 2
@@ -398,6 +403,7 @@ axis letters:
398403
Gantry using trivkins with duplicated axis letters and KINEMATICS_BOTH to
399404
allow individual joint positioning (for homing):
400405

406+
[source,{ini}]
401407
-----
402408
[KINS]KINEMATICS = trivkins coordinates=XYYZ kinstype=BOTH
403409
[KINS]JOINTS = 4
@@ -407,6 +413,7 @@ allow individual joint positioning (for homing):
407413
Gantry using trivkins (KINEMATICS_BOTH) with duplicated axis letters
408414
and a rotary axis with skipped axis letters (A,B skipped):
409415

416+
[source,{ini}]
410417
-----
411418
[KINS]KINEMATICS = trivkins coordinates=XYYZC kinstype=BOTH
412419
[KINS]JOINTS = 5
@@ -416,6 +423,7 @@ and a rotary axis with skipped axis letters (A,B skipped):
416423
Linear Delta Robot with non-identity kins (KINEMATICS_BOTH) working in Cartesian frame
417424
with an additional rotary coordinate:
418425

426+
[source,{ini}]
419427
-----
420428
[KINS]KINEMATICS = lineardeltakins
421429
[KINS]JOINTS = 4
@@ -429,6 +437,7 @@ Joints are assigned to axis letters in a defined manner ('$ man trivkins').
429437

430438
Note: For trivkins module loading, do not include spaces about the = sign or letters:
431439

440+
[source,{ini}]
432441
----
433442
This: [KINS]KINEMATICS = trivkins coordinates=XZ
434443
NOT This: [KINS]KINEMATICS = trivkins coordinates = X Z
@@ -537,12 +546,14 @@ of the value, not a comment character.
537546

538547
For example, lines like this will no longer be accepted:
539548

549+
[source,{ini}]
540550
-----
541551
MAX_VELOCITY = 7.5 # This is the max velocity of the axis.
542552
-----
543553

544554
They could be transformed into pairs of lines like this:
545555

556+
[source,{ini}]
546557
-----
547558
# This is the max velocity of the axis.
548559
MAX_VELOCITY = 7.5
@@ -642,32 +653,40 @@ both joint and teleop (world) jogging.
642653

643654
=== INI HAL pins
644655

645-
HAL pins are created for INI file items for both joints ([JOINT_N]
646-
stanzas) and axes ([AXIS_L] stanzas):
647-
648-
For N = 0 ... [KINS](JOINTS -1)
649-
INI File Item HAL pin name
650-
[JOINT_N]BACKLASH ini.N.backlash
651-
[JOINT_N]FERROR ini.N.ferror
652-
[JOINT_N]MIN_FERROR ini.N.min_ferror
653-
[JOINT_N]MIN_LIMIT ini.N.min_limit
654-
[JOINT_N]MAX_LIMIT ini.N.max_limit
655-
[JOINT_N]MAX_VELOCITY ini.N.max_velocity
656-
[JOINT_N]MAX_ACCELERATION ini.N.max_acceleration
657-
[JOINT_N]HOME ini.N.home
658-
[JOINT_N]HOME_OFFSET ini.N.home_offset
659-
660-
For L = x y z a b c u v w:
661-
INI File Item HAL pin name
662-
[AXIS_L]MIN_LIMIT ini.L.min_limit
663-
[AXIS_L]MAX_LIMIT ini.L.max_limit
664-
[AXIS_L]MAX_VELOCITY ini.L.max_velocity
665-
[AXIS_L]MAX_ACCELERATION ini.L.max_acceleration
666-
667-
NOTE: In prior versions of LinuxCNC (before joints_axes updates), the
656+
HAL pins are created for INI file items for both joints ([JOINT_N]) and axes ([AXIS_L]):
657+
658+
For N = 0 ... [KINS](JOINTS-1):
659+
660+
[source,{ini}]
661+
----
662+
INI file item HAL pin name
663+
[JOINT_N]BACKLASH ini.N.backlash
664+
[JOINT_N]FERROR ini.N.ferror
665+
[JOINT_N]MIN_FERROR ini.N.min_ferror
666+
[JOINT_N]MIN_LIMIT ini.N.min_limit
667+
[JOINT_N]MAX_LIMIT ini.N.max_limit
668+
[JOINT_N]MAX_VELOCITY ini.N.max_velocity
669+
[JOINT_N]MAX_ACCELERATION ini.N.max_acceleration
670+
[JOINT_N]HOME ini.N.home
671+
[JOINT_N]HOME_OFFSET ini.N.home_offset
672+
----
673+
674+
For L = x y z a b c u v w:
675+
676+
[source,{ini}]
677+
----
678+
INI file item HAL pin name
679+
[AXIS_L]MIN_LIMIT ini.L.min_limit
680+
[AXIS_L]MAX_LIMIT ini.L.max_limit
681+
[AXIS_L]MAX_VELOCITY ini.L.max_velocity
682+
[AXIS_L]MAX_ACCELERATION ini.L.max_acceleration
683+
----
684+
685+
[NOTE]
686+
In prior versions of LinuxCNC (before joints_axes updates), the
668687
HAL pin names 'ini.N.*' referred to axes with 0==>x, 1==>y, etc. (pins
669-
were created for all 9 axes) See the man page ('$ man milltask') for
670-
more information
688+
were created for all 9 axes). See the man page of 'milltask' for
689+
more information.
671690

672691
== HAL Changes (Other 2.8.x)
673692

@@ -1104,6 +1123,7 @@ options: '-no_make_ddts', '-no_simulated_home', '-no_use_hal_manualtoolchange',
11041123

11051124
For example, to omit creation of ddts:
11061125

1126+
[source,{ini}]
11071127
----
11081128
HALFILE = LIB:basic_sim.tcl -no_make_ddts
11091129
----

0 commit comments

Comments
 (0)