davidlt/kernel-ark
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update documentation with FAQ and update frequency

Browse Source 
I added an FAQ section based on questions I hear all the time
from developers.  Also based on feedback, I added how often the
different brances are updated.  Not everyone realizes it is daily.

Signed-off-by: Don Zickus <dzickus@redhat.com>
This commit is contained in:
Don Zickus 2021-10-28 14:59:24 -04:00 committed by Justin M. Forbes
parent e6fc7ccfa1
commit f65216f098
No known key found for this signature in database
GPG Key ID: B8FA7924A4B1C140
3 changed files with 93 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
redhat/docs/faq.rst Normal file
View File

@ -0,0 +1,78 @@
==========================
Frequently Asked Questions
==========================
1. The 'os-build' branch doesn't compile, what can I do?
--------------------------------------------------------
The os-build branch is auto-updated daily from upstream. While upstream
is pretty good about having code that compiles, occassionally issues pop
up.
First, check the ark-latest branch to see if any critical patches were
applied to temporarily resolve things.
Second, sometimes the problem is new and waiting 24-48 hours for a
maintainer to resolve things will be expected.
Third, you can use a release tag (ie kernel-5.14.1-0), if you do not need
bleeding edge.
2. The 'os-build' branch doesn't pass 'make dist-configs'?
----------------------------------------------------------
During the -rc1 and -rc2 phase, this is not uncommon. Most configs should
be autogenerated to defaults and placed in pending-common until an official
review has taken place.
Occassionally during the review cycle, the default changes and new configs
are revealed that are not autogenerated and leads to unresolved configs.
Creating a file under redhat/configs/pending-common/ with the config
settings necessary should temporarily resolve this until the maintainers can
resolve this properly.
Please notify us on kernel@lists.fedoraproject.org or file an issue at
https://gitlab.com/cki-project/kernel-ark/-/issues.
3. How does an MR get reviewed?
-------------------------------
Anything Fedora specific (configs, custom patches, scripts) will be decided
by the Fedora kernel maintainer with input from the community.
Any patch that is cherry-picked from a commit in an upstream tree will be
taken by the maintainer immediately with the assumption the commit will be
merged to Linus's tree within a week.
Any patch that touches infrastructure (redhat/) will need review by Red Hat
developers. Those developers are auto-added by webhooks to the MR. An
approval from 1 developer is generally good enough.
Any patch that touches kernel code that is not going upstream will need
reviews by Red Hat developers. Those developers are auto-added by webhooks
to the MR. These patches must wrapped with "#ifndef
CONFIG_RHEL_DIFFERENCES" if possible and be provided with a good reason why
it is important to include despite upstream not taking it. An approval from
all the assigned reviewers is necessary.
See https://redhat.gitlab.io/centos-stream/src/kernel/documentation/ for a
more thorough discussion.
4. Can I use build services koji or brew?
-----------------------------------------
Yes.
.. code-block:: sh
make dist-srpm
koji build --scratch eln|rawhide <srpm>
.. code-block:: sh
# use baseonly to skip building userspace tools to avoid failures
make dist-srpm-baseonly
brew build --scratch rhel-9.0.0-candidate <srpm>

1
redhat/docs/index.rst
View File

@ -90,6 +90,7 @@ Contributor Guide
repository-layout
submitting-contributions
faq
Maintainer Guide

15
redhat/docs/repository-layout.rst
View File

@ -13,24 +13,35 @@ Branches
os-build, a.k.a "the development branch"
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Frequency: Merges 'master' branch daily
The os-build branch is the development branch of the tree. The os-build branch
tracks the latest version of the kernel patches for ARK and Fedora, as well as
the kernel configuration and build scripts. This is the branch to send
merge request to. When a new release is made, this branch is merged into the
release branch. Configuration and build scripts can be found in the
``redhat/`` directory. Refer to the Configuration section below for more
``redhat/`` directory. Refer to the `Configuration`_ section below for more
details.
If this branch does not compile or boot, then please see `ark-latest`_ branch
below.
master
~~~~~~
Frequency: Mirrors Linus's tree
The master branch tracks `Linus's master
branch <git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git>`__
(i.e. "mainline").
.. _ark-latest:
ark-latest
~~~~~~~~~~
Frequency: Reset daily after os-build branch merges 'master'
This branch points to the latest release branch. This branch may differ
slightly from os-build and contain critical patches that resolve compile or
boot issues. **This is not a development branch, do not base merge requests
@ -98,6 +109,8 @@ Fedora source tree.
Fedora RPM tagging in the ARK kernel began in May 2020 for fc33. Previous
RPM tags are not available in the ARK kernel tree.
.. _Configuration:
Configuration
-------------