Add a README to the dist-git repository

Fedora users are used to the dist-git repository being a particular way.
Add some documentation so the change is less confusing.

Cc: Rado Vrbovsky <rvrbovsk@redhat.com>
Cc: Denys Vlasenko <dvlasenk@redhat.com>
Cc: Frantisek Hrbata <fhrbata@redhat.com>
Cc: Juri Lelli <jlelli@redhat.com>
Cc: Luis Claudio Goncalves <lgoncalv@redhat.com>
Cc: Clark Williams <williams@redhat.com>
Cc: Jan Stancek <jstancek@redhat.com>
Cc: "Herton R. Krzesinski" <herton@redhat.com>
Cc: Jeremy Cline <jcline@redhat.com>
Cc: Justin Forbes <jforbes@redhat.com>
Cc: Don Zickus <dzickus@redhat.com>
Signed-off-by: Jeremy Cline <jcline@redhat.com>
This commit is contained in:
Jeremy Cline 2020-04-16 10:30:14 -04:00 committed by Herton R. Krzesinski
parent 77b4c924e0
commit 911f44d944
3 changed files with 28 additions and 0 deletions

View File

@ -250,6 +250,7 @@ sources-rh: $(TARBALL)
configs/process_configs.sh \
parallel_xz.sh \
generate_bls_conf.sh \
README.rst \
$(SOURCES)/
@for KABIARCH in $(ARCH_LIST); do \
cp kabi/Module.kabi_$$KABIARCH $(SOURCES)/; \

25
redhat/README.rst Normal file
View File

@ -0,0 +1,25 @@
===================
The Kernel dist-git
===================
The kernel is maintained in a `source tree`_ rather than directly in dist-git.
The specfile is maintained as a `template`_ in the source tree along with a set
of build scripts to generate configurations, (S)RPMs, and to populate the
dist-git repository.
The `documentation`_ for the source tree covers how to contribute and maintain
the tree.
If you're looking for the downstream patch set it's available in the source
tree with "git log master..ark-patches" or
`online`_.
Each release in dist-git is tagged in the source repository so you can easily
check out the source tree for a build. The tags are in the format
name-version-release, but note release doesn't contain the dist tag since the
source can be built in different build roots (Fedora, CentOS, etc.)
.. _source tree: https://gitlab.com/cki-project/kernel-ark.git
.. _template: https://gitlab.com/cki-project/kernel-ark/-/blob/internal/redhat/kernel.spec.template
.. _documentation: https://gitlab.com/cki-project/kernel-ark/-/wikis/home
.. _online: https://gitlab.com/cki-project/kernel-ark/-/commits/ark-patches

View File

@ -698,6 +698,8 @@ Source2001: cpupower.config
Source3000: merge.pl
Source3001: kernel-local
Source4000: README.rst
## Patches needed for building this package
Patch1: patch-%{rpmversion}-redhat.patch