Skip to content

Commit a567bf4

Browse files
committed
docs: added some information about building options
1 parent bc074fd commit a567bf4

1 file changed

Lines changed: 15 additions & 2 deletions

File tree

docs/src/code/building-linuxcnc.adoc

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,11 @@ The most commonly used arguments are:
155155
the docs is quite time consuming. If you are not actively working
156156
on the documentation you may want to omit this argument.
157157

158+
`--disable-build-documentation-translation`::
159+
Disable building the translated documentation for all available languages.
160+
The building of the translated documentation takes a huge amount of time, so it is
161+
recommend to skip that if not really needed.
162+
158163
[[make-arguments]]
159164
==== `make` arguments
160165

@@ -222,13 +227,18 @@ The `debian/configure` script needs different arguments depending on the platfor
222227
see the <<debian-configure-arguments, `debian/configure` arguments>> section.
223228
====
224229

225-
Once the Debian package scripts and meta-data are configured, build the package by running `dpkg-buildpackage`
226-
(note that it needs to run from the `linuxcnc-dev` directory, *not* from `linuxcnc-dev/debian`):
230+
Once the Debian package scripts and meta-data are configured, build the package by running `dpkg-buildpackage`:
227231

228232
----
229233
$ dpkg-buildpackage -b -uc
230234
----
231235

236+
[NOTE]
237+
====
238+
`dpkg-buildpackage` needs to run from the `linuxcnc-dev` directory, *not* from `linuxcnc-dev/debian`. +
239+
`dpkg-buildpackage` takes an optional argument `-jN` (where N is a number). This enables to run multiple jobs simultaneously.
240+
====
241+
232242
[[debian-configure-arguments]]
233243
==== `debian/configure` arguments
234244

@@ -238,6 +248,9 @@ It must be run before `dpkg-checkbuilddeps` and `dpkg-buildpackage` can be run.
238248
It takes a single argument which specifies the realtime or non-realtime platform to build for.
239249
The normal values for this argument are:
240250

251+
`no-docs`::
252+
Skip building documentation.
253+
241254
`uspace`::
242255
Configure the Debian package for Preempt-RT realtime or for
243256
non-realtime (these two are compatible).

0 commit comments

Comments
 (0)