From 3ef1d2ddb1b12403388cd59e053540a51cb71840 Mon Sep 17 00:00:00 2001 From: Bastian Krause Date: Tue, 8 Oct 2024 17:28:57 +0200 Subject: [PATCH] man: regenerate man pages with docutils 0.21 Signed-off-by: Bastian Krause --- man/labgrid-client.1 | 26 +++++--------- man/labgrid-coordinator.1 | 2 +- man/labgrid-device-config.5 | 72 ++++++++++++++++--------------------- man/labgrid-exporter.1 | 16 ++++----- man/labgrid-pytest.7 | 10 +++--- man/labgrid-suggest.1 | 8 ++--- 6 files changed, 54 insertions(+), 80 deletions(-) diff --git a/man/labgrid-client.1 b/man/labgrid-client.1 index 52db032db..150e7be3c 100644 --- a/man/labgrid-client.1 +++ b/man/labgrid-client.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "LABGRID-CLIENT" 1 "2017-04-15" "0.0.1" "embedded testing" +.TH "LABGRID-CLIENT" "1" "2017-04-15" "0.0.1" "embedded testing" .SH NAME labgrid-client \- labgrid-client interface to control boards .SH SYNOPSIS @@ -247,11 +247,9 @@ To retrieve a list of places run: .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX $ labgrid\-client places -.ft P -.fi +.EE .UNINDENT .UNINDENT .sp @@ -260,11 +258,9 @@ the \fBacquire command\fP and passing the placename as a \-p parameter: .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX $ labgrid\-client \-p acquire -.ft P -.fi +.EE .UNINDENT .UNINDENT .sp @@ -272,11 +268,9 @@ Open a console to the acquired place: .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX $ labgrid\-client \-p console -.ft P -.fi +.EE .UNINDENT .UNINDENT .sp @@ -284,11 +278,9 @@ Add all resources with the group \(dqexample\-group\(dq to the place example\-pl .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX $ labgrid\-client \-p example\-place add\-match */example\-group/*/* -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH SEE ALSO diff --git a/man/labgrid-coordinator.1 b/man/labgrid-coordinator.1 index 22673a065..a134cea9a 100644 --- a/man/labgrid-coordinator.1 +++ b/man/labgrid-coordinator.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "LABGRID-COORDINATOR" 1 "2024-08-06" "0.0.1" "embedded testing" +.TH "LABGRID-COORDINATOR" "1" "2024-08-06" "0.0.1" "embedded testing" .SH NAME labgrid-coordinator \- labgrid-coordinator managing labgrid resources and places .SH SYNOPSIS diff --git a/man/labgrid-device-config.5 b/man/labgrid-device-config.5 index f6de7a954..fd9e05c2e 100644 --- a/man/labgrid-device-config.5 +++ b/man/labgrid-device-config.5 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "LABGRID-DEVICE-CONFIG" 5 "2017-04-15" "0.0.1" "embedded testing" +.TH "LABGRID-DEVICE-CONFIG" "5" "2017-04-15" "0.0.1" "embedded testing" .SH NAME labgrid-device-config \- labgrid test configuration files .SH SYNOPSIS @@ -49,7 +49,7 @@ important, since they are parsed as an ordered dictionary and may depend on a previous driver. .sp For a list of available resources and drivers refer to -\fI\%https://labgrid.readthedocs.io/en/latest/configuration.html\fP\&. + \&. .SH OPTIONS .sp The \fBoptions:\fP top key configures various options such as the coordinator_address. @@ -75,13 +75,11 @@ Two configured images, one for the root filesystem, one for the bootloader: .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX images: root: \(dqplatform\-v7a/images/root.img\(dq boot: \(dqplatform\-v7a/images/barebox.img\(dq -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH TOOLS @@ -92,91 +90,89 @@ The \fBtools:\fP top key provides paths to binaries such as fastboot. .TP .B \fBdfu\-util\fP Path to the dfu\-util binary, used by the DFUDriver. -See: \fI\%https://dfu\-util.sourceforge.net/\fP +See: .TP .B \fBdpcmd\fP Path to the dpcmd binary, used by the DediprogFlashDriver. -See: \fI\%https://github.com/DediProgSW/SF100Linux\fP +See: .TP .B \fBfastboot\fP Path to the fastboot binary, used by the AndroidFastbootDriver. -See: \fI\%https://developer.android.com/studio/releases/platform\-tools\fP +See: .TP .B \fBflashrom\fP Path to the flashrom binary, used by the FlashromDriver. -See: \fI\%https://www.flashrom.org/\fP +See: .TP .B \fBimx_usb\fP Path to the imx_usb binary, used by the BDIMXUSBDriver. -See: \fI\%https://github.com/boundarydevices/imx_usb_loader\fP +See: .TP .B \fBimx\-usb\-loader\fP Path to the imx\-usb\-loader binary, used by the IMXUSBDriver. -See: \fI\%https://git.pengutronix.de/cgit/barebox/tree/scripts/imx/imx\-usb\-loader.c\fP +See: .TP .B \fBjtagconfig\fP Path to the jtagconfig binary, used by the QuartusHPSDriver. -See: \fI\%https://www.intel.com/content/www/us/en/docs/programmable/683689/current/jtagconfig.html\fP +See: .TP .B \fBmxs\-usb\-loader\fP Path to the mxs\-usb\-loader binary, used by the MXSUSBDriver. -See: \fI\%https://git.pengutronix.de/cgit/barebox/tree/scripts/mxs\-usb\-loader.c?h=v2017.03.0\fP +See: .TP .B \fBopenocd\fP Path to the openocd binary, used by the OpenOCDDriver. -See: \fI\%https://openocd.org/\fP +See: .TP .B \fBquartus_hps\fP Path to the quartus_hps binary, used by the QuartusHPSDriver. -See: \fI\%https://www.intel.com/content/www/us/en/docs/programmable/683039/22\-3/hps\-flash\-programmer.html\fP +See: .TP .B \fBrk\-usb\-loader\fP Path to the rk\-usb\-loader binary, used by the RKUSBDriver. -See: \fI\%https://git.pengutronix.de/cgit/barebox/tree/scripts/rk\-usb\-loader.c\fP +See: .TP .B \fBsd\-mux\-ctrl\fP Path to the sd\-mux\-ctrl binary, used by the USBSDWireDriver. -See: \fI\%https://git.tizen.org/cgit/tools/testlab/sd\-mux/\fP +See: .TP .B \fBsispmctl\fP Path to the sispmctl binary, used by the SiSPMPowerDriver. -See: \fI\%https://sispmctl.sourceforge.net/\fP +See: .TP .B \fBuhubctl\fP Path to the uhubctl binary, used by the USBPowerDriver. -See: \fI\%https://github.com/mvp/uhubctl\fP +See: .TP .B \fBusbmuxctl\fP Path to the usbmuxctl tool, used by the LXAUSBMuxDriver. -\fI\%https://github.com/linux\-automation/usbmuxctl\fP + .TP .B \fBusbsdmux\fP Path to the usbsdmux tool, used by the USBSDMuxDriver. -See: \fI\%https://github.com/linux\-automation/usbsdmux\fP +See: .TP .B \fBuuu\-loader\fP Path to the uuu\-loader binary, used by the UUUDriver. -See: \fI\%https://github.com/nxp\-imx/mfgtools\fP +See: .TP .B \fBykushcmd\fP Path to the ykushcmd binary, used by the YKUSHPowerDriver. -See: \fI\%https://github.com/Yepkit/ykush\fP +See: .UNINDENT .sp The QEMUDriver expects a custom key set via its \fBqemu_bin\fP argument. -See \fI\%https://www.qemu.org/\fP +See .SS TOOLS EXAMPLE .sp Configure the tool path for \fBimx\-usb\-loader\fP: .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX tools: imx\-usb\-loader: \(dq/opt/labgrid\-helper/imx\-usb\-loader\(dq -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH IMPORTS @@ -192,12 +188,10 @@ Import a local \fImyfunctions.py\fP file: .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX imports: \- myfunctions.py -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH EXAMPLES @@ -207,8 +201,7 @@ A sample configuration with one \fImain\fP target, accessible via SerialPort .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX targets: main: resources: @@ -220,8 +213,7 @@ targets: prompt: \(aqroot@\ew+:[^ ]+ \(aq login_prompt: \(aq login: \(aq username: \(aqroot\(aq -.ft P -.fi +.EE .UNINDENT .UNINDENT .sp @@ -231,8 +223,7 @@ in the loaded local python file: .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX targets: main: resources: @@ -250,8 +241,7 @@ tools: imx\-usb\-loader: \(dq/opt/lg\-tools/imx\-usb\-loader\(dq imports: \- mystrategy.py -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH SEE ALSO diff --git a/man/labgrid-exporter.1 b/man/labgrid-exporter.1 index 66d1d69e0..3e46193b6 100644 --- a/man/labgrid-exporter.1 +++ b/man/labgrid-exporter.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "LABGRID-EXPORTER" 1 "2017-04-15" "0.0.1" "embedded testing" +.TH "LABGRID-EXPORTER" "1" "2017-04-15" "0.0.1" "embedded testing" .SH NAME labgrid-exporter \- labgrid-exporter interface to control boards .SH SYNOPSIS @@ -95,7 +95,7 @@ explicitly set. .sp The exporter uses a YAML configuration file which defines groups of related resources. -See <\fI\%https://labgrid.readthedocs.io/en/latest/configuration.html#exporter\-configuration\fP> +See < > for more information. .SH ENVIRONMENT VARIABLES .sp @@ -110,11 +110,9 @@ Start the exporter with the configuration file \fImy\-config.yaml\fP: .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX $ labgrid\-exporter my\-config.yaml -.ft P -.fi +.EE .UNINDENT .UNINDENT .sp @@ -122,11 +120,9 @@ Same as above, but with name \fBmyname\fP: .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX $ labgrid\-exporter \-n myname my\-config.yaml -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH SEE ALSO diff --git a/man/labgrid-pytest.7 b/man/labgrid-pytest.7 index f23eae478..40837d252 100644 --- a/man/labgrid-pytest.7 +++ b/man/labgrid-pytest.7 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "LABGRID-PYTEST" 7 "2017-04-15" "0.0.1" "embedded testing" +.TH "LABGRID-PYTEST" "7" "2017-04-15" "0.0.1" "embedded testing" .SH NAME labgrid-pytest \- labgrid-pytest labgrid integration for pytest .SH SYNOPSIS @@ -42,18 +42,16 @@ The labgrid plugin parses the supplied configuration yaml file as described in \fBlabgrid\-device\-config\fP(5) and allows the usage of the target and environment fixtures. The complete documentation is available at -\fI\%https://labgrid.readthedocs.io/en/latest/usage.html#pytest\-plugin\fP\&. + \&. .SH EXAMPLES .sp Start tests with \fBmyconfig.yaml\fP and directory \fBtests\fP: .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX $ pytest \-\-lg\-env myconfig.yaml tests -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH SEE ALSO diff --git a/man/labgrid-suggest.1 b/man/labgrid-suggest.1 index 51efbae5e..f4f45a390 100644 --- a/man/labgrid-suggest.1 +++ b/man/labgrid-suggest.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "LABGRID-SUGGEST" 1 "2021-05-20" "0.0.1" "embedded testing" +.TH "LABGRID-SUGGEST" "1" "2021-05-20" "0.0.1" "embedded testing" .SH NAME labgrid-suggest \- labgrid-suggest generator for YAML config files .SH SYNOPSIS @@ -58,8 +58,7 @@ in the USB\-serial converter, \fBlabgrid\-suggest\fP shows two alternatives: .INDENT 0.0 .INDENT 3.5 .sp -.nf -.ft C +.EX === added device === USBSerialPort for /devices/pci0000:00/0000:00:01.3/0000:02:00.0/usb1/1\-3/1\-3.1/1\-3.1:1.0/ttyUSB0/tty/ttyUSB0 === device properties === @@ -78,8 +77,7 @@ USBSerialPort: match: ID_SERIAL_SHORT: P\-00\-03564 \-\-\- -.ft P -.fi +.EE .UNINDENT .UNINDENT .SH SEE ALSO