diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/HACKING.md | 18 | ||||
| -rw-r--r-- | docs/README.generic | 13 | ||||
| -rw-r--r-- | docs/RELEASE.md | 44 |
3 files changed, 12 insertions, 63 deletions
diff --git a/docs/HACKING.md b/docs/HACKING.md index 6a19434..b6789fe 100644 --- a/docs/HACKING.md +++ b/docs/HACKING.md @@ -4,9 +4,9 @@ Please make sure to follow our [Contribution Guidelines](../CONTRIBUTING.md). ## git -Currently dracut lives on github.com. +Currently dracut-ng lives on github.com. -* https://github.com/dracutdevs/dracut.git +* https://github.com/dracut-ng/dracut-ng.git Pull requests should be filed preferably on github nowadays. @@ -244,8 +244,8 @@ $ podman run --rm -it \ ``` with `[CONTAINER]` being one of the -[github `dracutdevs` containers](https://github.com/orgs/dracutdevs/packages), -e.g. `ghcr.io/dracutdevs/fedora:latest`. +[github `dracut-ng` containers](https://github.com/orgs/dracut-ng/packages), +e.g. `ghcr.io/dracut-ng/fedora:latest`. ### On bare metal @@ -253,27 +253,27 @@ For the testsuite to pass, you will have to install at least the software packag mentioned in the `test/container` Dockerfiles. ``` -$ sudo make clean check +$ make clean check ``` in verbose mode: ``` -$ sudo make V=1 clean check +$ make V=1 clean check ``` only specific test: ``` -$ sudo make TESTS="01 20 40" clean check +$ make TESTS="01 20 40" clean check ``` only runs the 01, 20 and 40 tests. debug a specific test case: ``` $ cd TEST-01-BASIC -$ sudo make clean setup run +$ make clean setup run ``` ... change some kernel parameters in `test.sh` ... ``` -$ sudo make run +$ make run ``` to run the test without doing the setup. diff --git a/docs/README.generic b/docs/README.generic deleted file mode 100644 index 58889ac..0000000 --- a/docs/README.generic +++ /dev/null @@ -1,13 +0,0 @@ -To build a generic initramfs, you have to install the following software packages: - * device-mapper - * cryptsetup-luks - * rpcbind nfs-utils - * lvm2 - * iscsi-initiator-utils - * nbd - * mdadm - * net-tools iproute - -Generic initramfs'es are huge (usually over 10 megs in size uncompressed), but -should be able to automatically boot any bootable configuration with appropriate -boot flags (root device, network configuration information, etc.)
\ No newline at end of file diff --git a/docs/RELEASE.md b/docs/RELEASE.md index b043484..bdbc60b 100644 --- a/docs/RELEASE.md +++ b/docs/RELEASE.md @@ -2,47 +2,9 @@ This documents contains the necessary steps to conduct a successful release. -1. Add all items to `NEWS.md` +1. Run `tools/release.sh` shell script - Get a first template with [`clog`](https://github.com/clog-tool/clog-cli) - ```console - $ clog -F -r https://github.com/dracutdevs/dracut - ``` - -2. Update the contributors list in NEWS.md - - Produce the list with: - ```console - $ make CONTRIBUTORS - ``` - - Append the list to the section in `NEWS.md` - -3. Update AUTHORS - - ```console - $ make AUTHORS - ``` - -4. Check in AUTHORS and NEWS.md - - ```console - $ git commit -m "docs: update NEWS.md and AUTHORS" NEWS.md AUTHORS - $ git push origin master - ``` - -5. Tag the release, validate the tag and push - - ```console - $ git tag -s 060 - $ git tag -v 060 - $ git push --tags - ``` - - Add the section from `NEWS.md` to the git tag message excluding the Rendered - view entry. - -6. Create a new release on github (https://github.com/dracutdevs/dracut/releases/new) +2. Create a new release on github (https://github.com/dracut-ng/dracut-ng/releases/new) - Add the section from `NEWS.md` to the release. -7. Open a new milestone, move all unfinished issue from the previous milestone to the new one and close the released milestone (https://github.com/dracutdevs/dracut/milestones) +3. Open a new milestone, move all unfinished issue from the previous milestone to the new one and close the released milestone (https://github.com/dracut-ng/dracut-ng/milestones) |