From: Clark Williams <williams@xxxxxxxxxx>
redhat/configs: update scripts and docs for ark -> rhel rename
Update documentation and scripts to deal with renaming the ark and
pending-ark to rhel and pending-rhel in redhat/configs
Signed-off-by: Clark Williams <williams@xxxxxxxxxx>
diff --git a/redhat/configs/README b/redhat/configs/README
index blahblah..blahblah 100644
--- a/redhat/configs/README
+++ b/redhat/configs/README
@@ -1,25 +1,25 @@
kernel-ark CONFIG option scheme
-------------------------------
-The kernel-ark repository contains both Fedora and ark (aka "RHEL next")
+The kernel-ark repository contains both Fedora and rhel (aka "RHEL next")
CONFIGS. This repository is constantly rebased as the upstream kernel releases
new kernel version. New configuration options are reviewed and set with each
release, typically during the -rc1 to -rc3 releases.
-The kernel-ark configs are broken out into ark, fedora, and common directories
+The kernel-ark configs are broken out into rhel, fedora, and common directories
in which each directory provides a heirarchical layout of the configs starting
with generic/CONFIG_* and debug/CONFIG_*, then generic/<arch>/CONFIG_* and
generic/<arch>/<variant>/CONFIG_*, debug/<arch>/CONFIG_*, etc. Users should be
aware that it may not necessarily be the case that architecture support is
-consistent between ark and fedora.
+consistent between rhel and fedora.
The config options are merged and properly layered according to the priority.*
files in the same directory as this README to generate the final
kernel-$VERSION-<arch>-<variant>.config files we need for building the actual
-kernels. For example, the ark variant priorities are found in priority.rhel,
+kernels. For example, the rhel variant priorities are found in priority.rhel,
and in the case of x86_64 architecture, the specific information required is,
-ORDER=common ark pending-ark custom-overrides
+ORDER=common rhel pending-rhel custom-overrides
and
@@ -30,12 +30,12 @@ This indicates that for the x86_64 variant, the order that of inheritance would
custom-overrides/generic/x86/x86_64 (highest override priority)
custom-overrides/generic/x86
custom-overrides/generic
-pending-ark/generic/x86/x86_64
-pending-ark/generic/x86
-pending-ark/generic
-ark/generic/x86/x86_64
-ark/generic/x86
-ark/generic
+pending-rhel/generic/x86/x86_64
+pending-rhel/generic/x86
+pending-rhel/generic
+rhel/generic/x86/x86_64
+rhel/generic/x86
+rhel/generic
common/generic/x86/x86_64
common/generic/x86
common/generic (lowest override priority)
@@ -50,16 +50,16 @@ Directory Layout
The configuration is broken down into several directories:
-ark - contains all configuration options that have been reviewed by kernel
-developers for the ark kernel.
+rhel - contains all configuration options that have been reviewed by kernel
+developers for the rhel kernel.
common - contains all configuration options that are common between the fedora
-and ark directories. In other words, these config settings apply to both
-fedora and ark.
+and rhel directories. In other words, these config settings apply to both
+fedora and rhel.
custom-overrides - contains an empty set of the generic and debug arch-specific
directory tree. Any config option set here is applied last and therefore will
-override anything set in the ark, fedora, or pending directories. This feature
+override anything set in the rhel, fedora, or pending directories. This feature
was added to assist users executing custom builds to easily override a config
option without altering the standard directories. Users can even maintain their
own branch with a full set of custom configuration options that can be easily
@@ -68,15 +68,15 @@ be rebased on top of os-build without worrying about conflicts.
fedora - contains all configuration options that have been reviewed by kernel
developers for the fedora kernel.
-pending-[ark][common][fedora] - These directories contain configuration options
-that have not yet been fully reviewed for inclusion for ark, fedora, and both
+pending-[rhel][common][fedora] - These directories contain configuration options
+that have not yet been fully reviewed for inclusion for rhel, fedora, and both
(common) kernels. Due to the rate at which kernel options come out, the kernel
maintainers cannot guarantee reviews of configs in these directories by the
time a build occurs. In the interest of letting the build proceed for other
testing, configuration options are staged in these pending directories.
As pending-* configs are reviewed, they are moved into the matching non-pending
-directory (ie, pending-ark -> ark, etc.) and it is expected that these
+directory (ie, pending-rhel -> rhel, etc.) and it is expected that these
directories will be empty at branch time.
Config files can be populated using the pending-* directories by using the
diff --git a/redhat/configs/README.evaluate_configs b/redhat/configs/README.evaluate_configs
index blahblah..blahblah 100644
--- a/redhat/configs/README.evaluate_configs
+++ b/redhat/configs/README.evaluate_configs
@@ -16,11 +16,11 @@ common-ppc64le y - X - - X
common-s390x y - X - - X
common-s390x-zfcpdump y - - X X X
common-aarch64 y - - - X -
-ark-x86_64 y - - - X -
-ark-ppc64le y - X - - X
-ark-s390x y - X - - X
-ark-s390x-zfcpdump y - - X X X
-ark-aarch64 y - - - X -
+rhel-x86_64 y - - - X -
+rhel-ppc64le y - X - - X
+rhel-s390x y - X - - X
+rhel-s390x-zfcpdump y - - X X X
+rhel-aarch64 y - - - X -
pending-common-x86_64 - - - - X -
pending-common-ppc64le - - X - - X
pending-common-s390x - - X - - X
@@ -44,8 +44,8 @@ da1 maps to nothing (more on this below)
da2 maps to debug-x86-x86_64
The left hand column indicates the directory and config-variant. For
-example, ark-s390x-zfcpdump is the s390x-zfcpdump variant and the
-row beside it shows the config settings in the ark directory.
+example, rhel-s390x-zfcpdump is the s390x-zfcpdump variant and the
+row beside it shows the config settings in the rhel directory.
The data contained in the output can have 5 values:
@@ -90,17 +90,17 @@ or a single CONFIG
The Evaluate Output will show a different view than the Basic Output above:
-ERROR: (hierarchy) ark/generic/CONFIG_HEADER_TEST : superseding value has y.
-|CONFIG_HEADER_TEST (ark-aarch64)
+ERROR: (hierarchy) rhel/generic/CONFIG_HEADER_TEST : superseding value has y.
+|CONFIG_HEADER_TEST (rhel-aarch64)
|g ga1 ga2 d da1 da2 g ga1 ga2 d da1 da2 g ga1 ga2 d da1 da2
|y - - - X - y - - - X - - - - - X -
-| Deleting ark/generic/CONFIG_HEADER_TEST
+| Deleting rhel/generic/CONFIG_HEADER_TEST
This view is the Basic Output's aarch64 data in a single line, From the
above output,
common-aarch64 y - - - X -
-ark-aarch64 y - - - X -
+rhel-aarch64 y - - - X -
pending-common-aarch64 - - - - X -
The Evaluate output makes it easier to visually see a conflict. One
@@ -110,7 +110,7 @@ X's in a line, then there is the possibility of a conflict.
If the CONFIG setting is found to be incorrect it it automatically removed
and a message
-| Deleting ark/generic/CONFIG_HEADER_TEST
+| Deleting rhel/generic/CONFIG_HEADER_TEST
will be output.
@@ -118,7 +118,7 @@ Evaluate common Directory
=========================
This function does a 1-to-1 comparison of CONFIG settings in the
-ark and fedora directories, and checks to see if the CONFIG should be set
+rhel and fedora directories, and checks to see if the CONFIG should be set
in the common directory.
The output is the same as the Evaluate output.
diff --git a/redhat/configs/evaluate_configs b/redhat/configs/evaluate_configs
index blahblah..blahblah 100755
--- a/redhat/configs/evaluate_configs
+++ b/redhat/configs/evaluate_configs
@@ -453,7 +453,7 @@ fix_broken_arches() { # uses ORDER, crows, columns, and configmap
done
}
-# compare the common, fedora, and ark configs.
+# compare the common, fedora, and rhel configs.
# By default this function uses the priority.common file
fix_common() { # uses cfgs, CONFIG, and ORDER
local index
@@ -467,12 +467,12 @@ fix_common() { # uses cfgs, CONFIG, and ORDER
# the priority.common array is
# common configs
- # ark configs
+ # rhel configs
# fedora configs
for index in $(seq 0 $(((crows * columns) - 1)))
do
# this string is the concatenation of the
- # common, ark, and fedora config values
+ # common, rhel, and fedora config values
value=$(for order in $(seq 0 $((numorder -1)))
do
echo -n "${cfgs[$(( (order * crows * columns) + index))]}"
@@ -539,7 +539,7 @@ fix_common() { # uses cfgs, CONFIG, and ORDER
x=$(((index % columns) + 4))
$DEBUG && echo "($x,$y) $index"
- # remove the existing ark and fedora configs
+ # remove the existing rhel and fedora configs
configentry="$(echo "$configmap" | sed "${y}q;d" | cut -d " " -f "$x" | tr "-" "/")/$CONFIG"
for order in $ORDER
do
diff --git a/redhat/configs/priority.common b/redhat/configs/priority.common
index blahblah..blahblah 100644
--- a/redhat/configs/priority.common
+++ b/redhat/configs/priority.common
@@ -1,5 +1,5 @@
# DO NOT ERASE THIS FILE. IT IS USED BY THE evaluate_configs SCRIPT.
-ORDER=common ark fedora
+ORDER=common rhel fedora
# x86_64
x86_64=generic:generic-x86
diff --git a/redhat/configs/priority.rhel b/redhat/configs/priority.rhel
index blahblah..blahblah 100644
--- a/redhat/configs/priority.rhel
+++ b/redhat/configs/priority.rhel
@@ -16,7 +16,7 @@
# kernel.config files are build on the fly based on this config,
# the first arg is arch and variant, the second is a hierarchy of
# config options, lowest priority to highest
-ORDER=common ark pending-ark custom-overrides
+ORDER=common rhel pending-rhel custom-overrides
EMPTY=armv7hl armv7hl-debug armv7hl-lpae armv7hl-lpae-debug
# x86_64
diff --git a/redhat/configs/process_configs.sh b/redhat/configs/process_configs.sh
index blahblah..blahblah 100755
--- a/redhat/configs/process_configs.sh
+++ b/redhat/configs/process_configs.sh
@@ -387,15 +387,15 @@ do
done
KVERREL="$(test -n "$1" && echo "-$1" || echo "")"
-FLAVOR="$(test -n "$2" && echo "-$2" || echo "-ark")"
+FLAVOR="$(test -n "$2" && echo "-$2" || echo "-rhel")"
# shellcheck disable=SC2015
SCRIPT=$(readlink -f "$0")
SCRIPT_DIR=$(dirname "$SCRIPT")
-# Config options for RHEL should target the pending-ark directory, not pending-common.
+# Config options for RHEL should target the pending-rhel directory, not pending-common.
if [ "$FLAVOR" = "-rhel" ]
then
- FLAVOR="-ark"
+ FLAVOR="-rhel"
fi
# to handle this script being a symlink
diff --git a/redhat/docs/faq.rst b/redhat/docs/faq.rst
index blahblah..blahblah 100644
--- a/redhat/docs/faq.rst
+++ b/redhat/docs/faq.rst
@@ -22,13 +22,13 @@ bleeding edge.
----------------------------------------------------------
During the -rc1 and -rc2 phase, this is not uncommon. Most configs should
-be autogenerated to defaults and placed in pending-ark until an official
+be autogenerated to defaults and placed in pending-rhel 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-ark/ with the config
+Creating a file under redhat/configs/pending-rhel/ with the config
settings necessary should temporarily resolve this until the maintainers can
resolve this properly.
diff --git a/redhat/docs/repository-layout.rst b/redhat/docs/repository-layout.rst
index blahblah..blahblah 100644
--- a/redhat/docs/repository-layout.rst
+++ b/redhat/docs/repository-layout.rst
@@ -16,7 +16,7 @@ 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
+tracks the latest version of the kernel patches for RHEL 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
@@ -119,7 +119,7 @@ located on the ``os-build`` 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``
+directories: ``rhel``, ``common``, and ``fedora``. ``rhel`` and ``fedora``
are configuration "flavors", while ``common`` is shared configuration
across flavors.
@@ -134,28 +134,28 @@ A flavor is defined by:
configuration directories and should include the directory you
defined in step 2.
-common and pending-ark
+common and pending-rhel
~~~~~~~~~~~~~~~~~~~~~~
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
+subsystem maintainers since it affects RHEL. 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.
-``pending-ark`` is where configuration options that have not been
+``pending-rhel`` 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-ark`` directory, at which point subsystem maintainers
+``pending-rhel`` 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 ``pending-ark`` because it is
-assumed that ARK generally has the most conservative settings, whereas
+New RHEL configurations are placed in ``pending-rhel`` because it is
+assumed that RHEL generally has the most conservative settings, whereas
other flavors like Fedora will be (for the most part) a superset of the
-ARK configuration.
+RHEL configuration.
fedora and pending-fedora
~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -163,11 +163,11 @@ fedora and pending-fedora
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
+Since Fedora tends to turn on more things than RHEL, 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-ark``, populated automatically during a rebase. A Fedora
+``pending-rhel``, 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.
diff --git a/redhat/docs/submitting-contributions.rst b/redhat/docs/submitting-contributions.rst
index blahblah..blahblah 100644
--- a/redhat/docs/submitting-contributions.rst
+++ b/redhat/docs/submitting-contributions.rst
@@ -72,11 +72,11 @@ more generic directories. Configurations that are specific to a
particular architecture should be placed in that architecture's
directory rather in the generic directory.
-Configuration changes in the ``ark`` directory requires review from Red Hat
+Configuration changes in the ``rhel`` directory requires review from Red Hat
kernel developers, where-as the configurations in ``fedora`` can be changed
with the approval of the Fedora kernel maintainers. The ``common``
-directory is for changes common to both ``ark`` and ``fedora`` and will be
-populated by a bot that periodically looks in both ``ark`` and ``fedora``
+directory is for changes common to both ``rhel`` and ``fedora`` and will be
+populated by a bot that periodically looks in both ``rhel`` and ``fedora``
for common changes.
Makefile changes
diff --git a/redhat/scripts/genspec/gen_config_patches.sh b/redhat/scripts/genspec/gen_config_patches.sh
index blahblah..blahblah 100755
--- a/redhat/scripts/genspec/gen_config_patches.sh
+++ b/redhat/scripts/genspec/gen_config_patches.sh
@@ -107,13 +107,13 @@ for f in "$config_bundles_dir"/*; do
# This loop actually grabs the help text to put in the commit
while read -r line; do
# last line is the actual config we need to put in the dir
- tail -n 1 redhat/configs/pending-ark/generic/"$line" > redhat/configs/ark/generic/"$line"
+ tail -n 1 redhat/configs/pending-rhel/generic/"$line" > redhat/configs/rhel/generic/"$line"
# get everything except the last line for the commit text
- head -n -1 redhat/configs/pending-ark/generic/"$line" | sed -e 's/^#//g' >> "$tmpdir"/commit
+ head -n -1 redhat/configs/pending-rhel/generic/"$line" | sed -e 's/^#//g' >> "$tmpdir"/commit
# add a nice separator that renders in gitlab
echo -ne "\n---\n\n" >> "$tmpdir"/commit
# remove the pending option
- rm redhat/configs/pending-ark/generic/"$line"
+ rm redhat/configs/pending-rhel/generic/"$line"
done < "$f"
if [ -n "$RHMAINTAINERS" ] && [ -f ./scripts/get_maintainer.pl ] && [ -f "$RHMAINTAINERS" ]; then
echo "" >> "$tmpdir"/commit
--
https://gitlab.com/cki-project/kernel-ark/-/merge_requests/2278
_______________________________________________
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, report it: https://pagure.io/fedora-infrastructure/new_issue
