Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# po4a Version 0.57 in ubuntu 20 do not write translated adoc as
# UTF-8. Need at least version 0.62 to fix it. Using version 0.66 to
# also get fix for empty asciidoc table cells.
name: Build CI

on:
Expand Down Expand Up @@ -25,6 +28,8 @@ jobs:
run: |
./scripts/travis-install-build-deps.sh
sudo apt-get install -y eatmydata
curl -O http://snapshot.debian.org/archive/debian/20220102T084145Z/pool/main/p/po4a/po4a_0.66-1_all.deb
sudo dpkg -i po4a_0.66-1_all.deb
cd src
eatmydata ./autogen.sh
eatmydata ./configure --with-realtime=uspace --disable-check-runtime-deps
Expand All @@ -48,9 +53,13 @@ jobs:
run: |
./scripts/travis-install-build-deps.sh
sudo apt-get install -y eatmydata
curl -O http://snapshot.debian.org/archive/debian/20220102T084145Z/pool/main/p/po4a/po4a_0.66-1_all.deb
sudo dpkg -i po4a_0.66-1_all.deb
cd src
eatmydata ./autogen.sh
eatmydata ./configure --with-realtime=uspace --disable-check-runtime-deps --enable-build-documentation=html
eatmydata make -O -j$((1+$(nproc))) manpages
eatmydata make -O -j$((1+$(nproc))) translateddocs
eatmydata make -O -j$((1+$(nproc))) docs
# Note that the package build covers html docs

Expand All @@ -71,6 +80,8 @@ jobs:
git fetch --recurse-submodules=no https://github.com/linuxcnc/linuxcnc refs/tags/*:refs/tags/*
./scripts/travis-install-build-deps.sh
sudo apt-get install -y eatmydata
curl -O http://snapshot.debian.org/archive/debian/20220102T084145Z/pool/main/p/po4a/po4a_0.66-1_all.deb
sudo dpkg -i po4a_0.66-1_all.deb
codename=$(lsb_release -cs)
dch --maintmaint --distribution $codename "GitHub test package."
eatmydata debian/configure
Expand Down
1 change: 1 addition & 0 deletions debian/control.top.in
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Build-Depends:
libusb-1.0-0-dev,
libxmu-dev,
netcat,
po4a,
procps,
psmisc,
python3,
Expand Down
2 changes: 2 additions & 0 deletions debian/rules.in
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ override_dh_auto_build-arch:

override_dh_auto_build-indep:
ifneq "$(enable_build_documentation)" ""
$(MAKE) PYTHON=/usr/bin/python3 -C src manpages
$(MAKE) PYTHON=/usr/bin/python3 -C src translateddocs
$(MAKE) PYTHON=/usr/bin/python3 -C src docs
endif

Expand Down
5 changes: 0 additions & 5 deletions docs/man/man9/at_pid.9
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
.TH AT_PID "9" "2007-05-12" "LinuxCNC Documentation" "HAL Component"
.de TQ
.br
.ns
.TP \\$1
..

.SH NAME
at_pid \- proportional/integral/derivative controller with auto tuning
Expand Down
21 changes: 12 additions & 9 deletions docs/man/man9/counter.9
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
.TH COUNTER "9" "2007-01-19" "LinuxCNC Documentation" "HAL Component"
.de TQ
.br
.ns
.TP \\$1
..

.SH NAME

Expand Down Expand Up @@ -51,13 +46,21 @@ edge on \fBphase\-Z\fR is seen, \fBindex\-enable\fR is set to FALSE and the
internal counter is reset to zero.
.TP
.B \fBcounter.\fIN\fB.index\-enable\fR bit io
.TQ
.br
.ns
.TP
.B \fBcounter.\fIN\fB.reset\fR bit io
.TQ
.br
.ns
.TP
.B \fBcounter.\fIN\fB.counts\fR signed out
.TQ
.br
.ns
.TP
.B \fBcounter.\fIN\fB.position\fR float out
.TQ
.br
.ns
.TP
.B \fBcounter.\fIN\fB.velocity\fR float out
These pins function according to the canonical digital encoder interface.
.TP
Expand Down
5 changes: 0 additions & 5 deletions docs/man/man9/debounce.9
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
.TH DEBOUNCE "9" "2007-01-16" "LinuxCNC Documentation" "HAL Component"
.de TQ
.br
.ns
.TP \\$1
..

.SH NAME

Expand Down
21 changes: 12 additions & 9 deletions docs/man/man9/encoder.9
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
.TH ENCODER "9" "2009-04-15" "LinuxCNC Documentation" "HAL Component"
.de TQ
.br
.ns
.TP \\$1
..

.SH NAME
encoder \- software counting of quadrature encoder signals
Expand Down Expand Up @@ -136,13 +131,21 @@ of the quadrature waveform (four counts per full cycle). When false, it only
counts once per full cycle. In \fBcounter\-mode\fR, this parameter is ignored.
.TP
\fBencoder.\fIN\fB.latch\-input\fR bit in
.TQ
.br
.ns
.TP
\fBencoder.\fIN\fB.latch\-falling\fR bit in (default: \fBTRUE\fR)
.TQ
.br
.ns
.TP
\fBencoder.\fIN\fB.latch\-rising\fR bit in (default: \fBTRUE\fR)
.TQ
.br
.ns
.TP
\fBencoder.\fIN\fB.counts\-latched\fR s32 out
.TQ
.br
.ns
.TP
\fBencoder.\fIN\fB.position\-latched\fR float out
Update \fBcounts\-latched\fR and \fBposition\-latched\fR on the rising and/or
falling edges of \fBlatch\-input\fR as indicated by \fBlatch\-rising\fR and
Expand Down
26 changes: 15 additions & 11 deletions docs/man/man9/encoder_ratio.9
Original file line number Diff line number Diff line change
@@ -1,10 +1,4 @@

.TH ENCODER_RATIO "9" "2007-01-16" "LinuxCNC Documentation" "HAL Component"
.de TQ
.br
.ns
.TP \\$1
..

.SH NAME
encoder_ratio \- an electronic gear to synchronize two axes
Expand Down Expand Up @@ -44,11 +38,17 @@ The \fBencoder\-ratio.N.\fR format is shown in the following descriptions.

.TP
.B encoder\-ratio.\fIN\fB.master\-A\fR bit in
.TQ
.br
.ns
.TP
.B encoder\-ratio.\fIN\fB.master\-B\fR bit in
.TQ
.br
.ns
.TP
.B encoder\-ratio.\fIN\fB.slave\-A\fR bit in
.TQ
.br
.ns
.TP
.B encoder\-ratio.\fIN\fB.slave\-B\fR bit in
The encoder channels of the master and slave axes
.TP
Expand All @@ -68,12 +68,16 @@ The error in the position of the slave (in revolutions)
.SH PARAMETERS
.TP
.B encoder\-ratio.N.master\-ppr\fR unsigned rw
.TQ
.br
.ns
.TP
.B encoder\-ratio.N.slave\-ppr\fR unsigned rw
The number of pulses per revolution of the master and slave axes
.TP
.B encoder\-ratio.N.master\-teeth\fR unsigned rw
.TQ
.br
.ns
.TP
.B encoder\-ratio.N.slave\-teeth\fR unsigned rw
The number of "teeth" on the master and slave gears.

Expand Down
5 changes: 0 additions & 5 deletions docs/man/man9/gantrykins.9
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
.TH GANTRYKINS "9" "" "LinuxCNC Documentation" "Kinematics Module"
.de TQ
.br
.ns
.TP \\$1
..

.SH NAME

Expand Down
5 changes: 0 additions & 5 deletions docs/man/man9/gentrivkins.9
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
.TH GENTRIVKINS "9" "LinuxCNC Documentation" "Kinematics Module"
.de TQ
.br
.ns
.TP \\$1
..

.SH NAME

Expand Down
5 changes: 0 additions & 5 deletions docs/man/man9/gladevcp.9
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
.\"
.TH gladevcp "9" "2010-08-24" "LinuxCNC Documentation" "HAL Component"
.de TQ
.br
.ns
.TP \\$1
..

.SH NAME
gladevcp \- displays Virtual control Panels built with GTK / GLADE
Expand Down
6 changes: 1 addition & 5 deletions docs/man/man9/hm2_7i43.9
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
.TH HM2_7I43 "9" "2008-05-13" "LinuxCNC Documentation" "HAL Component"
.de TQ
.br
.ns
.TP \\$1
..

.SH NAME

hm2_7i43 \- LinuxCNC HAL driver for the Mesa Electronics 7i43 EPP Anything IO board with HostMot2 firmware.
Expand Down
6 changes: 1 addition & 5 deletions docs/man/man9/hm2_7i90.9
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
.TH HM2_7I90 "9" "2013-10-27" "LinuxCNC Documentation" "HAL Component"
.de TQ
.br
.ns
.TP \\$1
..

.SH NAME

hm2_7i90 \- LinuxCNC HAL driver for the Mesa Electronics 7i90 EPP Anything IO board with HostMot2 firmware.
Expand Down
5 changes: 0 additions & 5 deletions docs/man/man9/hm2_eth.9
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,6 @@
.\" Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
.\" USA.
.TH HM2_ETH "9" "2008-05-13" "LinuxCNC Documentation" "HAL Component"
.de TQ
.br
.ns
.TP \\$1
..

.SH NAME

Expand Down
5 changes: 0 additions & 5 deletions docs/man/man9/hm2_pci.9
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
.TH HM2_PCI "9" "2008-05-13" "LinuxCNC Documentation" "HAL Component"
.de TQ
.br
.ns
.TP \\$1
..

.SH NAME

Expand Down
5 changes: 0 additions & 5 deletions docs/man/man9/hm2_rpspi.9
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,6 @@
.\" Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
.\" USA.
.TH HM2_RPSPI "9" "2017-06-05" "LinuxCNC Documentation" "HAL Component"
.de TQ
.br
.ns
.TP \\$1
..

.SH NAME

Expand Down
6 changes: 0 additions & 6 deletions docs/man/man9/hm2_spi.9
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,8 @@
.\" Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
.\" USA.
.TH HM2_SPI "9" "2008-05-13" "LinuxCNC Documentation" "HAL Component"
.de TQ
.br
.ns
.TP \\$1
..

.SH NAME

hm2_spi \- LinuxCNC HAL driver for the Mesa Electronics SPI Anything IO boards, with HostMot2 firmware.
.SH SYNOPSIS

Expand Down
7 changes: 1 addition & 6 deletions docs/man/man9/hostmot2.9
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
.TH HOSTMOT2 "9" "2008-05-13" "LinuxCNC Documentation" "HAL Component"
.de TQ
.br
.ns
.TP \\$1
..
.SH NAME

.SH NAME
hostmot2 \- LinuxCNC HAL driver for the Mesa Electronics HostMot2 firmware.
.SH SYNOPSIS
See the config modparam section below for Mesa card configuration. Typically
Expand Down
Loading