Skip to content

Commit

Permalink
docs: replace remaining refs to autotools options by meson equivalent
Browse files Browse the repository at this point in the history
Signed-off-by: Enrico Joerns <[email protected]>
  • Loading branch information
ejoerns committed Oct 11, 2023
1 parent 3b82884 commit f1aeefb
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 13 deletions.
9 changes: 4 additions & 5 deletions docs/advanced.rst
Original file line number Diff line number Diff line change
Expand Up @@ -415,8 +415,7 @@ well as with the DBus API.
To use streaming, some prerequisites need to be fulfilled:
* make sure RAUC is built with ``-Dstreaming=true``/``--enable-streaming``
(which is the default)
* make sure RAUC is built with ``-Dstreaming=true`` (which is the default)
* create bundles using the :ref:`verity format <sec_ref_format_verity>`
* host the bundle on a server which supports HTTP Range Requests
* enable NBD (network block device) support in the kernel
Expand Down Expand Up @@ -930,8 +929,8 @@ updates are:
The possible solutions to this are:
a) migrate to the ``verity`` bundle format if possible, or
b) disable streaming support by calling ``./configure`` with
``--disable-streaming``.
b) disable streaming support by calling ``meson setup`` with
``-Dstreaming=false``.
Creating casync Bundles
~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -1299,7 +1298,7 @@ switch the first GPT partition entry between the first and second halves of a
region configured for that purpose.
This works similarly to the handling of a MBR bootloader partition entry as
described in the previous section.
It requires RAUC to be compiled with GPT support (``./configure --enable-gpt``)
It requires RAUC to be compiled with GPT support (``meson setup -Dgpt=enabled build``)
and adds a dependency on libfdisk.
The required slot type is ``boot-gpt-switch``.
Expand Down
3 changes: 1 addition & 2 deletions docs/basic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,7 @@ file.

Using streaming has a few requirements:

* make sure RAUC is built with ``-Dstreaming=true``/``--enable-streaming``
(which is the default)
* make sure RAUC is built with ``-Dstreaming=true`` (which is the default)
* create bundles using the :ref:`verity format <sec_ref_format_verity>`
* host the bundle on a server which supports HTTP Range Requests
* enable NBD support in the target kernel
Expand Down
4 changes: 2 additions & 2 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ the target partition, allowing use of the full size.
Is it possible to use RAUC without D-Bus (Client/Server mode)?
--------------------------------------------------------------

Yes. If you compile RAUC using the ``--disable-service`` configure option, you
Yes. If you compile RAUC using the ``-Dservice=false`` configure option, you
will be able to compile RAUC without service mode and without D-Bus support::

./configure --disable-service
meson setup -Dservice=false build

Then every call of the command line tool will be executed directly rather than
being forwarded to the RAUC service process running on your machine.
Expand Down
4 changes: 2 additions & 2 deletions docs/integration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -242,10 +242,10 @@ target side is GLib (minimum version 2.45.8) as utility library and OpenSSL
In order to let RAUC detect mounts correctly, GLib must be compiled
with libmount support (``--enable-libmount``) and at least be 2.49.5.

For network support (enabled with ``--enable-network``), additionally `libcurl`
For network support (enabled with ``--Dnetwork=true``), additionally `libcurl`
is required. This is only useful for the target service.

For JSON-style support (enabled with ``--enable-json``), additionally
For JSON-style support (enabled with ``-Djson=enabled``), additionally
`libjson-glib` is required.

Kernel Configuration
Expand Down
2 changes: 1 addition & 1 deletion docs/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ For more information about using the streaming support of RAUC, refer to
streaming helper process.
By default, the `nobody` user is used.
At compile time, the default can be defined using the
``--with-streaming-user=USERNAME`` configure option.
``-Dstreaming_user=USERNAME`` meson setup option.

``tls-cert``
This option can be used to set the path or PKCS#11 URL for the TLS/HTTPS
Expand Down
2 changes: 1 addition & 1 deletion docs/using.rst
Original file line number Diff line number Diff line change
Expand Up @@ -643,7 +643,7 @@ This section will lead you through the most common options you have for
debugging what actually went wrong.

In each case it is quite essential to know that RAUC, if not compiled with
``--disable-service`` runs as a service on your target that is either
``-Dservice=false`` runs as a service on your target that is either
controlled by your custom application or by the RAUC command line interface.

The frontend will always only show the 'high level' error output, e.g. when an
Expand Down

0 comments on commit f1aeefb

Please sign in to comment.