[OS-BUILD PATCHv3] docs: Update docs to reflect newer workflow.

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



From: Don Zickus <dzickus@xxxxxxxxxx>

docs: Update docs to reflect newer workflow.

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).

V2: Fix checkout command and setup master branch
V3: Use default upstream/master and git pull mechanism

Cc: Bastien Nocera <bnocera@xxxxxxxxxx>
Cc: Prarit Bhargava <prarit@xxxxxxxxxx>
Cc: Justin Forbes <jforbes@xxxxxxxxxx>
Signed-off-by: Don Zickus <dzickus@xxxxxxxxxx>

diff a/redhat/docs/index.rst b/redhat/docs/index.rst
--- a/redhat/docs/index.rst
+++ b/redhat/docs/index.rst
@@ -37,7 +37,6 @@ Once GitLab finishes forking the repository (this can take a while):
 
    # Install build dependencies
    sudo dnf install -y make gcc flex bison bzip2 rpm-build
-   git checkout upstream/ark-latest
    # If you're on Fedora, you need to run:
    # ln -s /usr/bin/python3 /usr/libexec/platform-python
    make dist-srpm
@@ -48,18 +47,12 @@ 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 os-build
+   git pull
    make dist-srpm
 
 You can now build the SRPM however you like:
@@ -70,6 +63,7 @@ You can now build the SRPM however you like:
    mock redhat/rpm/SRPMS/kernel*src.rpm
    # 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 a/redhat/docs/repository-layout.rst b/redhat/docs/repository-layout.rst
--- a/redhat/docs/repository-layout.rst
+++ b/redhat/docs/repository-layout.rst
@@ -63,13 +63,6 @@ along with the configuration and build scripts. They can be checked out
 and built into RPMs. The ``master`` branch points to the latest version
 of these branches.
 
-rhpatches
-~~~~~~~~~
-
-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.
-
 Tags
 ----
 
diff a/redhat/docs/submitting-contributions.rst b/redhat/docs/submitting-contributions.rst
--- a/redhat/docs/submitting-contributions.rst
+++ b/redhat/docs/submitting-contributions.rst
@@ -39,8 +39,8 @@ Patches
 Quick start:
 
 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``.

--
https://gitlab.com/cki-project/kernel-ark/-/merge_requests/772
_______________________________________________
kernel mailing list -- kernel@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe send an email to kernel-leave@xxxxxxxxxxxxxxxxxxxxxxx
Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/
List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
List Archives: https://lists.fedoraproject.org/archives/list/kernel@xxxxxxxxxxxxxxxxxxxxxxx
Do not reply to spam on the list, report it: https://pagure.io/fedora-infrastructure




[Index of Archives]     [Fedora General Discussion]     [Older Fedora Users Archive]     [Fedora Advisory Board]     [Fedora Security]     [Fedora Devel Java]     [Fedora Legacy]     [Fedora Desktop]     [ATA RAID]     [Fedora Marketing]     [Fedora Mentors]     [Fedora Package Announce]     [Fedora Package Review]     [Fedora Music]     [Fedora Packaging]     [Centos]     [Fedora SELinux]     [Coolkey]     [Yum Users]     [Tux]     [Yosemite News]     [KDE Users]     [Fedora Art]     [Fedora Docs]     [USB]     [Asterisk PBX]

  Powered by Linux