| index : mkinitcpio-archiso32 | |
| Archlinux32 initcpio scripts used by archiso | gitolite user |
| summaryrefslogtreecommitdiff |
| -rw-r--r-- | .editorconfig | 5 | ||||
| -rw-r--r-- | AUTHORS.rst | 19 | ||||
| -rw-r--r-- | CONTRIBUTING.rst | 12 | ||||
| -rw-r--r-- | README.rst | 95 |
diff --git a/.editorconfig b/.editorconfig index 74ed4eb..fd155ac 100644 --- a/.editorconfig +++ b/.editorconfig @@ -1,8 +1,3 @@ -# EditorConfig for archiso -# https://editorconfig.org/ -# -# SPDX-License-Identifier: GPL-3.0-or-later - # Top-most EditorConfig file root = true diff --git a/AUTHORS.rst b/AUTHORS.rst index 3a03c0e..8546de1 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -1,36 +1,25 @@ -=============== -Archiso Authors -=============== +========================== +Mkinitcpio-archiso Authors +========================== * Aaron Griffin <aaron@archlinux.org> * Adam Purkrt <adam@purkrt.net> * Alexander Epaneshnikov <aarnaarn2@gmail.com> -* Chandan Singh <cks071g2@gmail.com> -* Charles Vejnar <ce@vejnar.org> * Christian Hesse <mail@eworm.de> -* Christopher Brannon <cmbrannon79@gmail.com> * Dan McGee <dan@archlinux.org> * David Runge <dvzrv@archlinux.org> * David Thurstenson <thurstylark@gmail.com> -* Dieter Plaetinck <dieter@plaetinck.be> -* Eli Schwartz <eschwartz@archlinux.org> * Florian Pritz <bluewind@xinu.at> * Francois Dupoux <fdupoux@users.sourceforge.net> * Gerardo Exequiel Pozzi <vmlinuz386@gmail.com> * Gerhard Brauer <gerbra@archlinux.de> -* James Sitegen <jamesm.sitegen@gmail.com> -* Justin Kromlinger <hashworks@archlinux.org> -* Keshav Amburay <the.ridikulus.rat@gmail.com> * Loui Chang <louipc.ist@gmail.com> * Lukas Fleischer <archlinux@cryptocrack.de> -* Martin Damian Fernandez <martin.damian.fernandez@gmail.com> * Michael Vorburger <mike@vorburger.ch> * Pierre Schmitz <pierre@archlinux.de> -* Sean Enck <enckse@voidedtech.com> * Simo Leone <simo@archlinux.org> -* Steffen Bönigk <boenki@gmx.de> +* Simon Wilper <sxw@chronowerks.de> * Sven-Hendrik Haase <svenstaro@gmail.com> * Thomas Bächler <thomas@archlinux.org> -* Yu Li-Yu <afg984@gmail.com> * nl6720 <nl6720@gmail.com> * Øyvind Heggstad <heggstad@gmail.com> diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index bffc49d..4dc8a77 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -2,13 +2,13 @@ Contributing ============ -These are the contribution guidelines for archiso. +These are the contribution guidelines for mkinitcpio-archiso. All contributions fall under the terms of the GPL-3.0-or-later (see `LICENSE <LICENSE>`_). Editorconfig ============ -A top-level editorconfig file is provided. Please configure your text editor to use it. +A top-level `editorconfig <https://editorconfig.org/>`_ file is provided. Please configure your text editor to use it. Linting ======= @@ -17,10 +17,4 @@ All ash and bash scripts are linted using shellcheck: .. code:: bash - make lint - -Testing -======= - -Contributors are expected to test their contributions by building the releng profile and running the resulting image -using `run_archiso <scripts/run_archiso.sh>`_. + make check diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..87709d3 --- /dev/null +++ b/README.rst @@ -0,0 +1,95 @@ +================== +mkinitcpio-archiso +================== + +The mkinitcpio-archiso project provides `initcpio <https://gitlab.archlinux.org/mkinitcpio/mkinitcpio>`_ integration for +`archiso <https://gitlab.archlinux.org/archlinux/archiso>`_. +The scripts offer functionality for an environment, that is running in `early user space +<https://en.wikipedia.org/wiki/Linux_startup_process#Early_user_space>`_ by modifying an `initrd +<https://man.archlinux.org/man/initrd.4>`_. + +Requirements +============ + +The following packages need to be installed to be able to use mkinitcpio-archiso on a target host: + +* bash +* ca-certificates-utils (for PXE over HTTP) +* coreutils +* curl (for PXE over HTTP) +* device-mapper +* gnupg +* mkinitcpio +* mkinitcpio-nfs-utils (for PXE over NFS) +* nbd (for PXE over NBD) +* pv (optional: for displaying status when copying the image to RAM) +* util-linux + +The following packages need to be installed to be able to check the code of mkinitcpio-archiso (when running ``make +check``): + +* shellcheck +* shfmt + +Installation +============ + +To install this project, the make target ``install`` can be used. It honors both ``DESTDIR`` and ``PREFIX`` (defaults to +``/usr/local``). + +.. code:: sh + + make install DESTDIR=/some/directory PREFIX=/usr + +Documentation +============= + +Documentation on various aspects of mkinitcpio-archiso can be found in the `docs directory <docs/>`_. + +Contribute +========== + +Development of mkinitcpio-archiso takes place on Arch Linux' Gitlab: +https://gitlab.archlinux.org/archlinux/mkinitcpio-archiso. + +Please read our distribution-wide `Code of Conduct <https://wiki.archlinux.org/title/Code_of_conduct>`_ before +contributing, to understand what actions will and will not be tolerated. + +Read our `contributing guide <CONTRIBUTING.rst>`_ to learn more about how to provide fixes or improvements for the code +base. + +Discussion around mkinitcpio-archiso takes place on the `arch-releng mailing list +<https://lists.archlinux.org/listinfo/arch-releng>`_ and in `#archlinux-releng +<ircs://irc.libera.chat/archlinux-releng>`_ on `Libera Chat <https://libera.chat/>`_. + +All past and present authors of mkinitcpio-archiso are listed in `AUTHORS <AUTHORS.rst>`_. + +Releases +======== + +`Releases of mkinitcpio-archiso <https://gitlab.archlinux.org/archlinux/mkinitcpio-archiso/-/tags>`_ are created by its +current maintainer `David Runge <https://gitlab.archlinux.org/dvzrv>`_. Tags are signed using the PGP key with the ID +``C7E7849466FE2358343588377258734B41C31549``. + + .. note:: + + Releases before v58 have been done as part of `archiso <https://gitlab.archlinux.org/archlinux/archiso>`_. After + ``archiso`` v57 mkinitcpio-archiso became its own project. + +To verify a tag, first import the relevant PGP key: + +.. code:: sh + + gpg --auto-key-locate wkd --search-keys dvzrv@archlinux.org + + +Afterwards a tag can be verified from a clone of this repository: + +.. code:: sh + + git verify-tag <tag> + +License +======= + +Mkinitcpio-archiso is licensed under the terms of the **GPL-3.0-or-later** (see `LICENSE <LICENSE>`_). |