Send patches - preferably formatted by git format-patch - to patches at archlinux32 dot org.
summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorDavid Runge <dvzrv@archlinux.org>2020-08-24 17:53:10 +0200
committerDavid Runge <dvzrv@archlinux.org>2020-08-25 19:06:43 +0200
commitd90184a7f06c277b0749833c1690a31abfdca2fd (patch)
tree7b48affd4852f14c73a102dda19bfe9b6f2cf8fb /README.rst
parente2c5b4527ff1848a0ebaaca0ab9d05077ae08eee (diff)
Pass profile directory as parameter to mkarchiso
**archiso/mkarchiso**: Change all override option parameters (i.e. `-A`, `-C`, `-D`, `-L`, `-P` and `-g`) to not directly override the global variable they are tied to, but instead using an `override_` prefixed variable. Add `_set_overrides()` to use `override_` prefixed variables (if set) to override those without a prefix. Remove `-B` (a profile directory) from the list of parameters. The profile directory is now provided as separate non-option parameter. Add a call to `_read_profile()`, `_set_overrides()` and `command_build_profile()` to the fallthrough option of the switch-case checking `command_name` - a non-option parameter to mkarchiso. This effectively provides the possibility to set the profile directory using a non-option parameter, while still maintaining compatibility to legacy named arguments used in the configs' `build.sh` scripts. Extend the warning in regards to legacy `build.sh` based commands to mkarchiso by providing an EOL with archiso v49. Change the help output to reflect the changes and further elaborate on the legacy commands used by `build.sh` scripts. Change help output to be ordered alphabetically. Add help output for `-r` and `-g` options. Call `_set_overrides()` for legacy commands that accept one or more of the overriden options (i.e. `command_init`, `command_install`, `command_prepare` and `command_iso`). Various style fixes. **configs/{baseline,releng}/build.sh**: Change call to mkarchiso to use the profile's directory as a named argument instead of an option-argument. **README.rst**: Fix documentation on how to call mkarchiso with a profile directory. Fix wording and ordering of option arguments for run_archiso documentation. Fixes #52
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.rst b/README.rst
index 4c17082..c4774c0 100644
--- a/README.rst
+++ b/README.rst
@@ -49,7 +49,7 @@ be lost on update).
The examples below will assume an unmodified profile in a system location (unless noted otherwise).
-It is advised to check the help information of the **mkarchiso**:
+It is advised to consult the help output of **mkarchiso**:
.. code:: bash
@@ -60,7 +60,7 @@ Create images with packaged archiso
.. code:: bash
- mkarchiso -B path/to/profile -w path/to/work_dir -o path/to/out_dir build_profile
+ mkarchiso -w path/to/work_dir -o path/to/out_dir path/to/profile
Create images with local clone
------------------------------
@@ -69,13 +69,13 @@ Clone this repository and run:
.. code:: bash
- ./archiso/mkarchiso -B path/to/profile -w path/to/work_dir -o path/to/out_dir build_profile
+ ./archiso/mkarchiso -w path/to/work_dir -o path/to/out_dir path/to/profile
Testing
=======
The convenience script **run_archiso** is provided to boot into the medium using qemu.
-It is advised to read its help information:
+It is advised to consult its help output:
.. code:: bash
@@ -91,7 +91,7 @@ Run the following to boot the iso using UEFI:
.. code:: bash
- run_archiso -i path/to/an/arch.iso -u
+ run_archiso -u -i path/to/an/arch.iso
The script can of course also be executed from this repository: