diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 0b26743e845..8ff2869a9c6 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -150,8 +150,8 @@ Local development workflow ^^^^^^^^^^^^^^^^^^^^^^^^^^ This workflow makes it possible to test changes to the Anaconda source code locally on your machine without any dependencies -on external infrastructure. It uses two scripts, one called ``rebuild_boot_iso`` to build a fresh bootable installation image (boot.iso) -from Anaconda source code on the given branch and corresponding Fedora/CentOS Stream packages. The second script, called ``update_boot_iso`` +on external infrastructure. It uses two scripts, one called ``scripts/rebuild_boot_iso`` to build a fresh bootable installation image (boot.iso) +from Anaconda source code on the given branch and corresponding Fedora/CentOS Stream packages. The second script, called ``scripts/update_boot_iso`` uses the Anaconda updates image mechanism together with the ``mkksiso`` command provided by the Lorax project to very quickly create an updated version of the boot.iso when Anaconda code is changed. The updated boot.iso can then be booted on a VM or bare metal. @@ -172,9 +172,9 @@ This should take a couple seconds on modern hardware. For the most common use case ("I have changed the Anaconda source and want to see what it does.") just do this: -1. run ``rebuild_boot_iso`` first, this creates ``result/iso/boot.iso`` +1. run ``scripts/rebuild_boot_iso`` first, this creates ``result/iso/boot.iso`` 2. change the Anaconda source code -3. run ``update_boot_iso`` which creates the ``result/iso/updated_boot.iso`` +3. run ``scripts/update_boot_iso`` which creates the ``result/iso/updated_boot.iso`` 4. start the ``result/iso/updated_boot.iso`` in a VM or on bare metal The script also has a few command line options that might come handy: diff --git a/scripts/update_boot_iso b/scripts/update_boot_iso index 5df97523b6a..a7ea1194fc1 100755 --- a/scripts/update_boot_iso +++ b/scripts/update_boot_iso @@ -23,6 +23,8 @@ UPDATED_ISO = os.path.join(ISO_FOLDER, "updated_boot.iso") # Folder needed to include updates image into the updated ISO UPDATES_FOLDER = os.path.join(ISO_FOLDER, "images") UPDATES_IMAGE = "updates.img" +# For inst.sshd = https://anaconda-installer.readthedocs.io/en/latest/boot-options.html#inst-sshd +# For inst.nokill = https://anaconda-installer.readthedocs.io/en/latest/boot-options.html#inst-nokill BOOT_OPTIONS = "inst.sshd inst.nokill" # Command names