Skip to content

Commit 8d5b351

Browse files
man: fix inline interpreted text without a role
sphinx became stricter when handling interpreted text without a role, e.g. "`foo`" since [1], see [2]. This results in errors such as: sphinx.errors.SphinxError: cannot determine default role! In the past, heuristics were used to determine how to format the text (inline code, italic, ..). In labgrid, interpreted text without a role is used inconsistently. Most times it was actually meant to be either inline code ("``foo``"), italic text or links to docs sections or class definitions. Fix all such occurrences with explicit variants that actually make sense in their respective contexts. [1] sphinx-doc/sphinx@114093c [2] sphinx-doc/sphinx#13904 Signed-off-by: Bastian Krause <bst@pengutronix.de>
1 parent 8c84aad commit 8d5b351

File tree

6 files changed

+15
-15
lines changed

6 files changed

+15
-15
lines changed

man/labgrid-client.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ not at all.
238238
.sp
239239
If a target contains multiple Resources of the same type, named matches need to
240240
be used to address the individual resources. In addition to the \fImatch\fP taken by
241-
\fIadd\-match\fP, \fIadd\-named\-match\fP also takes a name for the resource. The other
241+
\fBadd\-match\fP, \fBadd\-named\-match\fP also takes a name for the resource. The other
242242
client commands support the name as an optional parameter and will inform the
243243
user that a name is required if multiple resources are found, but no name is
244244
given.

man/labgrid-client.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -229,8 +229,8 @@ LABGRID-CLIENT COMMANDS
229229
ADDING NAMED RESOURCES
230230
----------------------
231231
If a target contains multiple Resources of the same type, named matches need to
232-
be used to address the individual resources. In addition to the `match` taken by
233-
`add-match`, `add-named-match` also takes a name for the resource. The other
232+
be used to address the individual resources. In addition to the *match* taken by
233+
``add-match``, ``add-named-match`` also takes a name for the resource. The other
234234
client commands support the name as an optional parameter and will inform the
235235
user that a name is required if multiple resources are found, but no name is
236236
given.

man/labgrid-device-config.5

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ This is useful to load drivers and strategy which are contained in your
200200
testsuite, since the import is done before instantiating the targets.
201201
.SS IMPORTS EXAMPLE
202202
.sp
203-
Import a local \fImyfunctions.py\fP file:
203+
Import a local \fBmyfunctions.py\fP file:
204204
.INDENT 0.0
205205
.INDENT 3.5
206206
.sp
@@ -212,8 +212,8 @@ imports:
212212
.UNINDENT
213213
.SH EXAMPLES
214214
.sp
215-
A sample configuration with one \fImain\fP target, accessible via SerialPort
216-
\fI/dev/ttyUSB0\fP, allowing usage of the ShellDriver:
215+
A sample configuration with one \fBmain\fP target, accessible via SerialPort
216+
\fB/dev/ttyUSB0\fP, allowing usage of the ShellDriver:
217217
.INDENT 0.0
218218
.INDENT 3.5
219219
.sp
@@ -233,8 +233,8 @@ targets:
233233
.UNINDENT
234234
.UNINDENT
235235
.sp
236-
A sample configuration with \fIRemotePlace\fP, using the tools configuration and
237-
importing the local \fImystrategy.py\fP file. The \fIMyStrategy\fP strategy is contained
236+
A sample configuration with \fBRemotePlace\fP, using the tools configuration and
237+
importing the local \fBmystrategy.py\fP file. The \fBMyStrategy\fP strategy is contained
238238
in the loaded local python file:
239239
.INDENT 0.0
240240
.INDENT 3.5

man/labgrid-device-config.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ testsuite, since the import is done before instantiating the targets.
196196

197197
IMPORTS EXAMPLE
198198
~~~~~~~~~~~~~~~
199-
Import a local `myfunctions.py` file:
199+
Import a local ``myfunctions.py`` file:
200200

201201
::
202202

@@ -205,8 +205,8 @@ Import a local `myfunctions.py` file:
205205

206206
EXAMPLES
207207
--------
208-
A sample configuration with one `main` target, accessible via SerialPort
209-
`/dev/ttyUSB0`, allowing usage of the ShellDriver:
208+
A sample configuration with one ``main`` target, accessible via SerialPort
209+
``/dev/ttyUSB0``, allowing usage of the ShellDriver:
210210

211211
::
212212

@@ -222,8 +222,8 @@ A sample configuration with one `main` target, accessible via SerialPort
222222
login_prompt: ' login: '
223223
username: 'root'
224224

225-
A sample configuration with `RemotePlace`, using the tools configuration and
226-
importing the local `mystrategy.py` file. The `MyStrategy` strategy is contained
225+
A sample configuration with ``RemotePlace``, using the tools configuration and
226+
importing the local ``mystrategy.py`` file. The ``MyStrategy`` strategy is contained
227227
in the loaded local python file:
228228

229229
::

man/labgrid-exporter.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ This variable can be used to set the default coordinator in the format
106106
\fBHOST[:PORT]\fP (instead of using the \fB\-x\fP option).
107107
.SH EXAMPLES
108108
.sp
109-
Start the exporter with the configuration file \fImy\-config.yaml\fP:
109+
Start the exporter with the configuration file \fBmy\-config.yaml\fP:
110110
.INDENT 0.0
111111
.INDENT 3.5
112112
.sp

man/labgrid-exporter.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ This variable can be used to set the default coordinator in the format
9999
EXAMPLES
100100
--------
101101

102-
Start the exporter with the configuration file `my-config.yaml`:
102+
Start the exporter with the configuration file ``my-config.yaml``:
103103

104104
.. code-block:: bash
105105

0 commit comments

Comments
 (0)