From: Don Zickus <dzickus(a)redhat.com>
The workflow has recently changed such that all development is done
on the 'os-build' branch. Update the docs to show how easy it is
to make a change, commit it, generate the srpm and upload it to koji.
Also add it a build dep for making a srpm: patchutils (for filterdiff).
Cc: Bastien Nocera <bnocera(a)redhat.com>
Cc: Prarit Bhargava <prarit(a)redhat.com>
Cc: Justin Forbes <jforbes(a)redhat.com>
Signed-off-by: Don Zickus <dzickus(a)redhat.com>
redhat/docs/index.rst | 16 +++++-----------
redhat/docs/repository-layout.rst | 7 -------
redhat/docs/submitting-contributions.rst | 4 ++--
3 files changed, 7 insertions(+), 20 deletions(-)
diff --git a/redhat/docs/index.rst b/redhat/docs/index.rst
index 951845cc7be3..b451b9ba49ca 100644
@@ -36,8 +36,8 @@ Once GitLab finishes forking the repository (this can take a while):
git remote add -f upstream email@example.com:cki-project/kernel-ark.git
# Install build dependencies
- sudo dnf install -y make gcc flex bison bzip2 rpm-build
- git checkout upstream/ark-latest
+ sudo dnf install -y make gcc flex bison bzip2 rpm-build patchutils
+ git checkout upstream/os-build
# If you're on Fedora, you need to run:
# ln -s /usr/bin/python3 /usr/libexec/platform-python
@@ -48,18 +48,11 @@ Building an SRPM
The configuration and build scripts are in the ``os-build`` branch and
-are regularly updated to work with Linus's master branch. To build an
-SRPM, start by checking out the source tree you'd like to build. In this
-example, we'll assume that is Linus's master branch, but it could just
-as easily be Fedora's ``ark-patches`` branch (Linus's tree + Fedora
-patches) , a sub-system maintainer's tree, or your own creation.
+are regularly updated to work with Linus's master branch.
- git checkout linus/master
- git merge -m "Merge branch 'os-build'" os-build
- # Fedora carries a patch to alter this setting, so we need to change the configuration
to build a vanilla tree.
- # If you're targeting RHEL and have brew/rhpkg installed, use "make
DIST=.elrdy dist-srpm" instead
+ git checkout upstream/os-build
You can now build the SRPM however you like:
@@ -70,6 +63,7 @@ You can now build the SRPM however you like:
# Build the SRPM in Fedora's Koji
koji build --scratch rawhide redhat/rpm/SRPMS/kernel*src.rpm
+ koji build --scratch eln redhat/rpm/SRPMS/kernel*src.rpm
Want to add a patch? Just git-cherry-pick it or apply it with git-am and
re-run ``make dist-srpm``. Change configurations in ``redhat/configs/``
diff --git a/redhat/docs/repository-layout.rst b/redhat/docs/repository-layout.rst
index 5f6dcb08a1bd..851a2c5d715b 100644
@@ -63,13 +63,6 @@ along with the configuration and build scripts. They can be checked
and built into RPMs. The ``master`` branch points to the latest version
of these branches.
-This branch is no longer used. Previously, it held the Red Hat patches
-for the kernel as a quilt series and remains for historical reasons.
-Patch history up to v5.4 is available in this branch.
diff --git a/redhat/docs/submitting-contributions.rst
index 07b25852ec66..65895a9ce49b 100644
@@ -39,8 +39,8 @@ Patches
1. ``git fetch upstream``
-2. ``git checkout upstream/os-build && git checkout -b my-build-change``
-3. Make a change to a file or files in ``redhat/``.
+2. ``git checkout -b my-build-change upstream/os-build``
+3. Make a change to a file.
4. Add your changes with ``git add -A``.
5. Commit your changes and write a nice commit message that explains the
change: ``git commit -s``.