Skip to content

Commit 513a305

Browse files
committed
docs: Remnant of merge, header depth
1 parent fed6f08 commit 513a305

File tree

1 file changed

+16
-22
lines changed

1 file changed

+16
-22
lines changed

docs/src/code/building-linuxcnc.adoc

Lines changed: 16 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ Building for Run-In-Place follows the steps in the <<Quick-Start,Quick Start>> s
164164
possibly with different arguments to `src/configure` and `make`.
165165

166166
[[src-configure-arguments]]
167-
==== `src/configure` arguments
167+
.`src/configure` arguments
168168

169169
The `src/configure` script configures how the source code will be compiled.
170170
It takes many optional arguments.
@@ -201,7 +201,7 @@ The most commonly used arguments are:
201201
The building of the translated documentation takes a huge amount of time, so it is recommend to skip that if not really needed.
202202

203203
[[make-arguments]]
204-
==== `make` arguments
204+
.`make`
205205

206206
The `make` command takes two useful optional arguments.
207207

@@ -258,7 +258,6 @@ that are detailed below:
258258
as described in the section <<Satisfying-Build-Dependencies,Satisfying Build Dependencies>>.
259259
* file in debian folder need to be complete that describe the package
260260

261-
<<<<<<< HEAD
262261
Build tools have been gathered as a virtual package named `build-essential`. To install it, run:
263262

264263
----
@@ -274,9 +273,7 @@ $ cd linuxcnc-dev
274273
$ ./debian/configure
275274
----
276275

277-
[NOTE]
278-
====
279-
The `debian/configure` script is different from the `src/configure` script!
276+
[NOTE]: The `debian/configure` script is different from the `src/configure` script!
280277

281278
The `debian/configure` accepts arguments depending on the platform you are building on/for,
282279
see the <<debian-configure-arguments, `debian/configure` arguments>> section.
@@ -293,23 +290,20 @@ $ dpkg-buildpackage -b -uc
293290

294291
[NOTE]
295292
====
296-
`dpkg-buildpackage` needs to run from the root of the source tree, which you mave have named `linuxcnc-source-dir`, *not* from within `linuxcnc-source-dir/debian`. +
297-
`dpkg-buildpackage` takes an optional argument ``-j``_N_ (where _N_ is a number). This enables to run multiple jobs simultaneously.
293+
`dpkg-buildpackage` needs to run from the root of the source tree, which you mave have named `linuxcnc-source-dir`, *not* from within `linuxcnc-source-dir/debian`.
294+
`dpkg-buildpackage` takes an optional argument ``-j``__N__ (where _N_ is a number). This enables to run multiple jobs simultaneously.
298295
====
299296

300-
The build system is set up to use Debian
301-
link:https://www.debian.org/doc/debian-policy/ch-source.html#s-debianrules-options[package options]
302-
and link:https://wiki.debian.org/BuildProfileSpec[package profiles] to
303-
make it optional to build documentation packages. This is done by
304-
adding `BUILD_OPTIONS=nodoc` and 1DEB_BUILD_PROFILES=nodoc` to the
305-
environment when building, for example like this:
297+
The build system is set up to use Debian link:https://www.debian.org/doc/debian-policy/ch-source.html#s-debianrules-options[package options]
298+
and link:https://wiki.debian.org/BuildProfileSpec[package profiles] to make it optional to build documentation packages.
299+
This is done by adding `BUILD_OPTIONS=nodoc` and DEB_BUILD_PROFILES=nodoc` to the environment when building, for example like this:
306300

307-
-----
308-
DEB_BUILD_OPTIONS=nodoc DEB_BUILD_PROFILES=nodoc debuild -b -uc"
309-
-----
301+
----
302+
DEB_BUILD_OPTIONS=nodoc DEB_BUILD_PROFILES=nodoc debuild -b -uc
303+
----
310304

311305
[[Satisfying-Build-Dependencies]]
312-
==== Satisfying Build Dependencies
306+
.Satisfying Build Dependencies
313307

314308
On Debian-based platforms we provide packaging meta-data that knows
315309
what external software packages need to be installed in order to build LinuxCNC.
@@ -323,10 +317,10 @@ You can use this meta-data to easily list the required packages missing from you
323317
First, go to the source tree of LinuxCNC and initiate its default self-configuration,
324318
if not already performed:
325319

326-
-----
320+
----
327321
$ cd linuxcnc-dev
328322
$ ./debian/configure
329-
-----
323+
----
330324

331325
This will prepare the file debian/control that contains lists of Debian packages
332326
to create with the runtime dependencies for those packages and for our cause also
@@ -387,7 +381,7 @@ automated:: Run `sudo apt build-dep .` .
387381

388382
If in doubt about what a particular package of a build-dep may be providing, check out the package's description with ``apt-cache show`` _packagename_.
389383

390-
==== Options for `dpkg-buildpackage`
384+
.Options for `dpkg-buildpackage`
391385

392386
For a typical Debian package to build, you would run dpkg-buildpackage without any arguments.
393387
As introduced above, the command has two extra options passed to it.
@@ -415,7 +409,7 @@ DEB_BUILD_OPTIONS=nocheck dpkg-buildpackage -uc -B
415409
----
416410
would combine all the options introduced in this section.
417411

418-
==== Installing self-built Debian packages
412+
.Installing self-built Debian packages
419413

420414
A Debian package can be recognised by its .deb extension.
421415
The tool installing it, `dpkg` is part of every Debian installation.

0 commit comments

Comments
 (0)