From c7965fc2dcd2c6080a8c858f14a42fd7e6627f24 Mon Sep 17 00:00:00 2001 From: Adam Samalik Date: Sep 25 2018 15:09:39 +0000 Subject: [PATCH 1/2] add hosting modules section --- diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index a4f7bdd..f2f02e0 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -11,6 +11,7 @@ ** xref:making-modules/inspecting-build-failures.adoc[Inspecting Build Failures] ** xref:making-modules/building-modules-locally.adoc[Building Modules Locally] ** xref:making-modules/naming-guidelines.adoc[Naming Guidelines] +* xref:hosting-modules.adoc[Hosting Modules] * xref:using-modules.adoc[Using Modules] * xref:community.adoc[Community] ** xref:community/teams.adoc[Teams and Working Groups] diff --git a/modules/ROOT/pages/hosting-modules.adoc b/modules/ROOT/pages/hosting-modules.adoc new file mode 100644 index 0000000..c8edd44 --- /dev/null +++ b/modules/ROOT/pages/hosting-modules.adoc @@ -0,0 +1,29 @@ += Hosting modules for Fedora + +Since modules are technically collections of RPM packages with metadata, they are hosted the same way as traditional RPM packages are — in a repository. Apart from the packages, such repository must also contain the modular metadata (modulemd) that come with the modules. + +== Creating a modular repository + +Modular repositories are created in two steps: + +1. Creating the repository using `createrepo_c` +2. Adding modular metadata (modulemd) using `modifyrepo_c` + +WARNING: Modular repository must contain the modular metadata (modulemd) it the repodata. Excluding the metadata will cause all the modular packages to become standalone packages which could have negative consequences. + +To create a repository out of RPM packages, run: + +---- +$ createrepo_c DIRECTORY +---- + +* `DIRECTORY` — path to a directory with RPM packages that will be converted into a repository + +To add the modular metadata (modulemd), run: + +---- +$ modifyrepo_c --mdtype=modules modules.yaml REPO +---- + +* `modules.yaml` — YAML multidocument containing all modulemds +* `REPO` — path to the repository — the directory from the previous step \ No newline at end of file From 8e16a5f08896f932f0ec1c53435464d492beed02 Mon Sep 17 00:00:00 2001 From: Adam Samalik Date: Sep 25 2018 15:22:57 +0000 Subject: [PATCH 2/2] fix typo, clarify details --- diff --git a/modules/ROOT/pages/hosting-modules.adoc b/modules/ROOT/pages/hosting-modules.adoc index c8edd44..baa7266 100644 --- a/modules/ROOT/pages/hosting-modules.adoc +++ b/modules/ROOT/pages/hosting-modules.adoc @@ -9,7 +9,7 @@ Modular repositories are created in two steps: 1. Creating the repository using `createrepo_c` 2. Adding modular metadata (modulemd) using `modifyrepo_c` -WARNING: Modular repository must contain the modular metadata (modulemd) it the repodata. Excluding the metadata will cause all the modular packages to become standalone packages which could have negative consequences. +WARNING: Modular repository must contain the modular metadata (modulemd) in the repodata. Excluding the metadata will cause all the modular packages to become standalone packages which could have negative consequences. To create a repository out of RPM packages, run: @@ -25,5 +25,5 @@ To add the modular metadata (modulemd), run: $ modifyrepo_c --mdtype=modules modules.yaml REPO ---- -* `modules.yaml` — YAML multidocument containing all modulemds +* `modules.yaml` — YAML multidocument containing all modulemds — the final form of modulemd produced by the build system * `REPO` — path to the repository — the directory from the previous step \ No newline at end of file