Commit graph

386 commits

Author SHA1 Message Date
Petter Reinholdtsen
319f60b1da Improve io(1) and iov2(1) manual pages
Remove duplicate entries under "Additional IO v2 pins" in iov2
and add missing periods at the end of sentences in both io(1) and iov2(1)
to make sure the identical strings stay the same to save translators
duplicate work.
2022-07-02 15:22:56 +02:00
Petter Reinholdtsen
e7f312f6be Enable translations for more manual pages
Some manual pages uses roff macros and other features not handled by
po4a.  Make more manual pages translatable by removing the use of such
macros where it is trivial to do.
2022-06-08 20:15:14 +02:00
Steffen Moeller
a69d183551 docs: Series of changes to bring _es man pages in sync 2022-06-03 15:26:32 +02:00
Bob Bond
79f121caf7 MDRO initial version
MDRO is a simple GUI meant to provide access to the DRO scales on
a machine when using it in a manual (hand-cranked) mode.
2022-05-14 11:54:29 -07:00
Greg Carl
7a98bcd5f0 docs: remove bad unicode characters
there are more in the .po files, as well as some of the language 
versions. I left those alone as to not mess with translation efforts, 
but can fix there too if needed.
2022-03-24 07:45:00 -04:00
Hans
1781e9ab8b
Merge pull request #1629 from hansu/docs
Improved docs, mostly Modbus to Hal
2022-03-13 12:53:14 +01:00
Hans Unzner
2d92c5c778 mb2hal: added pins to manpage 2022-03-13 12:04:59 +01:00
Phillip Carter
38e416630d qtplasmac: change sim-torch to a userspace component 2022-02-26 17:33:30 +11:00
Phillip Carter
0786cc1d84 latency-test: fixes for using servo-thread only.
some doc changes
2022-02-01 16:34:35 +11:00
Hans Unzner
5daea1b40e docs: Updated/extended halshow doc 2022-01-31 14:05:22 +01:00
c-morley
ca22fa0af1
Merge pull request #1552 from hansu/docs
Some work on docs
2022-01-30 18:12:41 -08:00
Steffen Moeller
36735d950a g-code -> G-code 2022-01-18 14:38:59 +01:00
Steffen Moeller
1e06bf4e93 gcode -> G-code 2022-01-18 14:26:27 +01:00
CMorley
d42398ede7 mitsub -add new VFDs required pr 549 setting
also make it more obvious we are usinh computer link protocol.
2022-01-15 16:29:05 -08:00
CMorley
8e5570e8a1 mitsub_vfd -fix error in docs for data/stop setting 2022-01-14 20:06:03 -08:00
CMorley
e051d96c78 halcmd -add print statement
To aid debugging HAL files
2021-12-23 20:39:25 -08:00
Sebastian Kuzminsky
319ced032c Merge 2.8 at commit '1c0bc247bd19ebd565da08517c1dd985b0bd822e'
* commit '1c0bc247bd19ebd565da08517c1dd985b0bd822e':
  plasmac: fix date typo
  plasmac: fix reconfigure mode for breakaway switch
  gscreen -fix INI parsing of jog increments that uses space as a delimiter
  Update axis.tcl
  runtest: fix remap introspection
  emc: add a system param :_metric_machine
  FIxed IRC webclient URL
  Remove use of unknown .HTML macro.
  Docs: spell out abbreviation at least once
  Update M51 description
2021-12-11 14:23:19 -07:00
Petter Reinholdtsen
f599a9be99 Remove use of unknown .HTML macro.
As far as I can tell this <br> do not make it into HTML pages, and
it is useless in the 'man' rendering of the text.
2021-11-15 15:50:45 -07:00
luz paz
9d5d892847 Added more typos 2021-11-10 06:32:09 -05:00
Sebastian Kuzminsky
925475abeb remove a bunch of stray execute bits 2021-11-08 12:55:13 -07:00
Phillip Carter
a0548d5cb3 docs: add missing man pages for qtplasmac assistants 2021-10-28 15:17:03 +11:00
Petter Reinholdtsen
b4ccedcfbb Added missing whatis information to NAME section of xhc-hb04-accels(1)
This will quiet down lintian.  Not quite sure what the script is doing
and the manual page is a bit vague on the topic, so feel free to
improve the description.
2021-10-14 07:53:53 +02:00
andypugh
1e906924de
Merge pull request #1238 from havardAasen/patch_master
Packaging and other, minor changes.
2021-08-25 12:39:36 +01:00
john
f35426946b remove my name from hal components I didn't work on 2021-08-24 07:20:23 -05:00
John
a0a1c237b9 remove my name from hal components I didn't work on
Signed-off-by: John <jthornton@gnipsel.com>
2021-08-24 07:02:09 -05:00
Håvard Flaget Aasen
6119db46fc
man-page: Display SI unit of time. 2021-08-21 19:29:01 +02:00
Jeff Epler
5a59816b77 Merge remote-tracking branch 'origin/2.8' 2021-08-20 10:39:32 -05:00
Håvard Flaget Aasen
cdd14572a9
Update man-pages for latency-* scripts.
Create content for man-page latency-histogram and latency-plot. The
man-pages consist of information found in '--help' option in the
actual script, and documentation found in 'docs/' path in LinuxCNC
repository.
2021-08-17 10:49:04 +02:00
Dewey Garrett
17886d3ee5 Merge 'origin/2.8' to master 2021-07-05 14:38:41 -07:00
john
6d29f1458c Merge branch '2.7' into 2.8 2021-07-02 19:14:08 -05:00
john
ee4cacf1b0 fix author name 2021-07-02 19:12:32 -05:00
Chris Morley
cfe3ccef98 Merge branch '2.8' 2021-06-30 18:05:54 -07:00
Sebastian Kuzminsky
ec6f65e029 shuttle: finish support for Shuttle PRO2
It's much like the Shuttle PRO, but with two more buttons and a different
USB ID.
2021-06-24 17:43:12 -06:00
Sebastian Kuzminsky
992f3dedaf docs: fix out-of-date info about shuttle HAL pin names
They all begin with just `shuttle` now (like the component name), not
different HAL pin names for different shuttle devices.
2021-06-24 17:41:11 -06:00
Sebastian Kuzminsky
3dacc7ff12 docs: add a note about reloading udev rules for shuttle driver 2021-06-24 17:21:48 -06:00
andypugh
381bbfeb5d
Merge branch 'master' into typos-docs-tests 2021-05-14 00:00:13 +01:00
andypugh
da81e8ac17 Merge branch '2.8' 2021-05-13 19:44:03 +01:00
andypugh
ad607f03e0
Merge pull request #1138 from hansu/iocontrol-doc
docs: reworked iocontrol/io/iov2 man pages part 2
2021-05-10 21:26:38 +01:00
Hans Unzner
5f1500ccef docs: fixed merge errors
Partly regarding this commit: 2dbb2f640f
2021-04-21 20:29:19 +02:00
andypugh
1c11906e2b Merge branch '2.8'
Signed-off-by: andypugh <andy@bodgesoc.org>
2021-04-18 12:15:49 +01:00
Hans Unzner
2f2442d2d4 docs: reworked iocontrol/io/iov2 man pages part 2 2021-04-18 12:41:22 +02:00
andypugh
78a9bceaeb
Merge pull request #1127 from hansu/iocontrol-doc
docs: reworked iocontrol/io/iov2 man pages
2021-04-18 10:41:41 +01:00
Hans Unzner
3b3b3224ec docs: reworked iocontrol/io/iov2 man pages 2021-04-08 20:05:39 +02:00
andypugh
05f82e72ab Revert "docs: Experimentally unescape the hyphens in man1/halui"
This reverts commit 02387e36e8.

The fix was to switch the documets building buildslave to Buster.
2021-03-20 19:14:44 +00:00
andypugh
02387e36e8 docs: Experimentally unescape the hyphens in man1/halui
There seems to be a problem only when the docs are uploaded and web-served
from wlo that - becomes &minus become –.
And the long dash doesn't work as a HAL pin name.

Signed-off-by: andypugh <andy@bodgesoc.org>
2021-03-05 21:06:41 +00:00
luz paz
fa855db600 fix typos in docs/ and tests/
Found via codespell
2021-02-24 12:25:33 -05:00
Chris Morley
76dc29eaee Merge branch '2.8' 2021-02-11 21:03:10 -08:00
Hans Unzner
a5ab550b22 docs: removed warnings 2021-02-06 18:34:49 +01:00
Håvard Flaget Aasen
a92f32a231
man-page: Minor typo's reported by lintian 2021-02-03 13:37:12 +01:00
Dewey Garrett
2dbb2f640f tooldata: refactor and add database intfc db73
Note: this branch is force pushed, rebased to master at 890187289

================================================================
This commit refactors internal tool data handling to:
1) Update and consolidate functions in a new directory:
     src/emc/tooldata
2) Define an applications interface: src/emc/tooldata/tooldata.hh
3) Support a new interface to a user-provided tool database
   management program specified by [EMCIO]DB_PROGRAM
4) Use a new mmapped tooldata interface between
   EMCIO and TASK while maintaining number of allowed
   pockets specified by CANON_POCKETS_MAX=1001
5) Deprecate tooldata in nml messages between EMCIO and TASK
   (legacy nml message method remains available using
     configure --enable-toolnml until removal)
6) Minimize impact to current users of master branch and
   continue to pass the suite of runtests on all supported
   buildbot machines.
7) Clarify program variable names that use a sequential
   index (idx) for accessing internal tooldata.
   Note: some legacy variable names like:
      pocketPrepped, selected_pocket,current_pocket
   are still used in a few places because of their inclusion
   in fielded user remap scripts or the tests suite.
   These items may be renamed in the future.

================================================================
Change Summary:
 1) new directory: src/emc/tooldata
    tooldata.hh  ------------ api
    tooldata_common.cc  ----- shared functions
    tooldata_mmap.cc  ------- mmap tooldata
    tooldata_nml.cc  -------- nml tooldata
    tooldata_db.cc  --------- database interface functions
    tool_watch.cc  ---------- test utility
    tool_mmap_read.cc  ------ test utility for mmap

 3) updated docs:
    docs/src/getting-started/updating-linuxcnc.txt
    docs/src/config/ini-config.txt
    docs/src/code/code-notes.txt
    docs/src/gcode/overview.txt
    docs/src/gcode/tool-compensation.txt
    docs/src/remap/remap.txt
    docs/man1/iocontrol*.1
    docs/src/tooldatabase/tooldatabase.txt (new)

 3) removed (consolidated into other files):
       src/emc/task/iotaskintf.cc
       src/emc/ini/initool.hh
       src/emc/ini/initool.cc
       src/emc/rs274ngc/tool_parse.h
       src/emc/rs274ngc/tool_parse.cc
       src/emc/toolstore/

 4) emccanon call: removed GET_EXTERNAL_POCKETS_MAX
    (superseded by CANON_POCKETS_MAX)

 5) hal: params to pins:
    iocontrol.N.tool-prep-index

 6) gui updates (axis gui only)
    Print message if both [EMCIO]TOOL_TABLE and DB_PROGRAM
    are specified.  Allow specifying tooleditor for a DB_PROGRAM
    Issue message for db_program/tool_table ambiguities

 7) simulation configs:
      configs/sim/axis/db_demo/db_ran.ini
      configs/sim/axis/db_demo/db_nonran.ini

================================================================
Notes:
    1) Testing has been aided by the extensive set of tests
       exercised by the runtests program employed to ensure
       the integrity of buildbot created deb packages.  However,
       numerous functions are NOT tested by the runtests suite.
       Examples:
         a) remapped tool handling
         b) user-interfaces (ui) support for tool changes
         c) iov2 (ioControl_v2.cc -- no maintainer, deprecated)
    2) Use of the mmapped interface between EMCIO and TASK
       reduces the EMC_TOOL_STAT message size from 112224 bytes
       to 224 bytes (64bit architecture)
    3) The complete toolTable[] data for all (1001)
       CANON_POCKETS_MAX is no longer available should someone
       implement a *remote* ui with TASK and EMCIO
       implemented on *separate* machines via networked (TCP)
       nml messages.  A single tool table instance for
       the current tool in spindle is included in the
       EMC_TOOL_STAT message.
2021-01-31 10:35:55 -07:00