From 55cfda844eff9b0c805b805f0ab059b80cafb21a Mon Sep 17 00:00:00 2001 From: Fabian Arrotin Date: Dec 23 2021 07:16:17 +0000 Subject: consistency naming convention for variables in doc Signed-off-by: Fabian Arrotin --- diff --git a/docs/cbs.md b/docs/cbs.md index e9690e0..db5efe2 100644 --- a/docs/cbs.md +++ b/docs/cbs.md @@ -27,7 +27,7 @@ build livecd appliance image -build-configmanagement +build- livemedia ``` @@ -59,11 +59,11 @@ Our koji tag structure *must* follow always the following structure (really for `---{candidate,testing,release}` , where: - * SIG : SIG name , corresponding to IPA group, without the `sig-` prefix (so `sig-cloud` would become `cloud`) - * CentOS Version: .el version, so 7 means CentOS 7, 8s means CentOS Stream 8, and so on - * Project : the project that the SIG want to build - * Version : project version, can be a number or a string - * repo variant: one of the following : candidate, testing or release (see Delivery about the meaning for these levels) + * `SIG` : SIG name , corresponding to IPA group, without the `sig-` prefix (so `sig-cloud` would become `cloud`) + * `CentOS Version`: .el version, so el7 means CentOS 7, el8s means CentOS Stream 8, and so on + * `Project` : the project that the SIG want to build (example `openstack`) + * `Version` : project version, can be a number or a string (example `yoga` for openstack version) + * `repo variant|tag`: one of the following : candidate, testing or release (see Delivery about the meaning for these levels) Let's use one example, the `Cloud` SIG would like to build Openstack (Yoga release) for CentOS Stream 9 @@ -78,14 +78,14 @@ Before being able to submit a build task in koji, one has to be the pkg owner fo ``` for level in candidate testing release ; do - cbs add-pkg --owner= ${}-${level} + cbs add-pkg --owner= ---${level} done ``` -Now you can submit a build task by pointing to git.centos.org URL, pointing to project to build and git commit hash (assuming that you proceeded with needed steps in the [git](git.md) part : +Now you can submit a build task again your build target by pointing to git.centos.org URL, pointing to project to build and git commit hash (assuming that you proceeded with needed steps in the [git](git.md) part : ``` -cbs build git+https://git.centos.org/rpms/.git# +cbs build ---el git+https://git.centos.org/rpms/.git# ``` !!! note