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

Create Repository Layout

Jeremy Cline 2020-02-13 14:29:01 +00:00
parent 85e54a0ebd
commit 104cf35f8f
1 changed files with 74 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
Repository-Layout.md Normal file

@ -0,0 +1,74 @@
The repository is based on the upstream Linux kernel tree. However, we only push upstream tags to the repository. The branches are all downstream only.
## Branches
### master
The master branch points to the latest ARK release branch (e.g. `ark/v5.6-rc1`).
### internal
The internal branch is used for the kernel configuration and build scripts. When new configuration options are needed or the build requirements change, this is the branch to send merge requests 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 details.
### ark-patches
***This branch is regularly rebased; do not rely on commit hashes in this branch!***
This branch tracks the latest version of the kernel patches for ARK. Patches for a particular release are available via the ``ark/patches/vX.Y[-rcN]`` branches.
### fedora-patches
***This branch is regularly rebased; do not rely on commit hashes in this branch!***
This branch tracks the latest version of the kernel patches for Fedora Rawhide. Patches for a particular release are available via the ``fedora/patches/vX.Y[-rcN]`` branches. In the future the hope is to merge ark-patches and fedora-patches.
### 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.
### Release branches
Each time the kernel is rebased, a set of branches is created to track that release.
#### ark/patches/vX.Y[-rcN]
Branches in this format (e.g. ``ark/patches/v5.4-rc1`` or ``ark/patches/v5.3``) contain the kernel patches ARK carries for that particular kernel release. These are merged into the ``ark/vX.Y`` release branches.
#### ark/vX.Y[-rcN]
Branches in this format (e.g. ``ark/v5.4-rc1`` or ``ark/v5.3``) contain the set of patches that were added on top of the upstream kernel release 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.
## Tags
### vX.Y[-rcN]
Tags in this format (e.g. ``v5.4-rc1`` or ``v5.3``) are the upstream Linux kernel tags from Linus's tree.
### kernel-X.Y.Z-N.elrdy
Tags in this format (e.g. ``kernel-5.4.0-1.elrdy``) map to the RPM name-version-release tuple in the build system. These can be used to check out the source tree used to build that RPM.
## Configuration
The configuration layout is somewhat complicated. All configuration is located on the `internal` branch in `redhat/configs/`. Inside this directory there are a number of scripts used to automatically generate complete configurations, along with a number of directories that contain configuration snippets. At this time, there are three main configuration directories: `ark`, `common`, and `fedora`. `ark` and `fedora` are configuration "flavors", while `common` is shared configuration across flavors.
A flavor is defined by:
1. Adding the flavor name to `redhat/configs/flavors` on its own line.
2. Create a directory using your flavor name in `redhat/configs/` that matches the layout of other flavors.
3. Defining a configuration priority by creating a file called `redhat/configs/priority.$flavorname`. This file needs to define a number of bash variables that describe the priority of the various configuration directories and should include the directory you defined in step 2.
### common and common-pending
The `common` directory contains configuration values that are shared across all configuration "flavors". For a configuration to be in `common`, it MUST be reviewed and approved by one or more Red Hat subsystem maintainers since it affects ARK. A flavor's configurations can override settings in `common`, so it's not guaranteed settings in common are the same across all flavors. It's simply a good place to set common values across the flavors and use as a base for new flavors.
`common-pending` is where configuration options that have not been reviewed are placed. Automation creates snippets for all new configuration options exposed during a rebase of ARK in the `pending-common` directory, at which point subsystem maintainers review the options and set them as appropriate before moving them into `common`.
New ARK configurations are placed in `common-pending` because it is assumed that ARK generally has the most conservative settings, whereas other flavors like Fedora will be (for the most part) a superset of the ARK configuration.
### fedora and fedora-pending
The `fedora` directory contains settings that have been reviewed by Fedora kernel maintainers for the Fedora Rawhide kernel.
Since Fedora tends to turn on more things than ARK, it's common for a rebase to expose new configuration options that only apply to Fedora. For this reason, Fedora has a `pending-fedora` directory as well. `pending-fedora` contains settings that are not exposed by the `common` configuration set and only apply to Fedora. It is, like `pending-common`, populated automatically during a rebase. A Fedora kernel maintain can review the settings at their leisure and move them over to `fedora` as they do so.