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

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

 




----- Original Message -----
> From: Don Zickus <dzickus@xxxxxxxxxx>
> 
> 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@xxxxxxxxxx>
> Cc: Prarit Bhargava <prarit@xxxxxxxxxx>
> Cc: Justin Forbes <jforbes@xxxxxxxxxx>
> Signed-off-by: Don Zickus <dzickus@xxxxxxxxxx>
> ---
>  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
> --- a/redhat/docs/index.rst
> +++ b/redhat/docs/index.rst
> @@ -36,8 +36,8 @@ Once GitLab finishes forking the repository (this can take
> a while):
>     git remote add -f upstream git@xxxxxxxxxx: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

Would still be good if redhat/Makefile checked for filterdiff to be available.

https://gitlab.com/cki-project/kernel-ark/-/issues/34

> +   git checkout upstream/os-build
>     # If you're on Fedora, you need to run:
>     # ln -s /usr/bin/python3 /usr/libexec/platform-python
>     make dist-srpm
> @@ -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

Should that be:
git fetch upstream
git rebase upstream/os-build

So that the fork's os-build branch is updated and rebased from the upstream repo's
os-build branch? Otherwise you end up being on a detached branch.

>     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 --git a/redhat/docs/repository-layout.rst
> b/redhat/docs/repository-layout.rst
> index 5f6dcb08a1bd..851a2c5d715b 100644
> --- 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 --git a/redhat/docs/submitting-contributions.rst
> b/redhat/docs/submitting-contributions.rst
> index 07b25852ec66..65895a9ce49b 100644
> --- 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``

Same problem here with the branch name.

> +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``.
> --
> GitLab
> _______________________________________________
> 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
> 
_______________________________________________
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




[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