From 50e4bb4f4919bc407092261aeec005fa62cb30be Mon Sep 17 00:00:00 2001 From: Jan Staněk Date: Jul 27 2016 12:40:15 +0000 Subject: [PATCH 1/2] Add verbose comments to httpd and base-runtime - Indentation fixes --- diff --git a/modules/base-runtime/base-runtime.yaml b/modules/base-runtime/base-runtime.yaml index a0d4314..b0de1df 100644 --- a/modules/base-runtime/base-runtime.yaml +++ b/modules/base-runtime/base-runtime.yaml @@ -1,20 +1,51 @@ +# base-runtime module - Basis for running any other modules. +# For detailed description of the module metadata format, see +# https://fedoraproject.org/wiki/Fedora_Packaging_Guidelines_for_Modules + +# Document header document: modulemd +## This is the version of the modulemd specification, NOT of the module itself. version: 0 + +# Metadata section -- this is the actual module description data: + ## NVR (name, version, release) -- identification of a module's + # point-in-time version. It is best to follow the guidelines for + # RPM naming and versioning. name: base-runtime version: 0.1 release: 1 - summary: base-runtime module + + ## Human-readable description of a module. + ### Summary -- short description (one sentence, should NOT end in period) + # Each word is considered keyword when searching the modules. + summary: base runtime module + ### Expanded description (one paragraph, should end in period). description: > This module is essential for every build system. + + ## Licensing informations. Optional, recommended. license: - module: - - MIT - content: [] + ### License(s) of the module itself (in other words, license of this file). + module: + - MIT + ### Licenses of the module's content. You should list all licenses used + # by anything in the module here. + content: [] + + ## Module components -- definition of the actual module's content. Optional. components: + ### RPM content of the module. rpms: + #### Dependency solving. If set to True, the module automatically + # bundles all dependecies of requested packages, which are not + # provided by any required modules. It defaults to False, and + # cannot be overriden for production module builds in Fedora. Use + # this only as a helper when developing a module and disable it + # when finished. dependencies: True - fulltree: False + #### Module packages -- the main subsection. Each key is a SRPM + # name, details are provided as SRPM-specific key-value pairs. packages: audit: rationale: Contains the user space utilities for storing and searching the audit records generate by the audit subsystem in the Linux 2.6 kernel @@ -32,7 +63,7 @@ data: rationale: Allows the creation, destruction, resizeing, moveing, and copying of hard disk partitions policycoreutils: rationale: Policy core utilities required for basic operation of a SELinux system - selinux-policy-targeted: + selinux-policy: rationale: SELinux Reference policy targeted base module systemd: rationale: System and service manager for Linux, compatible with SysV and LSB init script diff --git a/modules/httpd/httpd.yaml b/modules/httpd/httpd.yaml index a046725..a53994e 100644 --- a/modules/httpd/httpd.yaml +++ b/modules/httpd/httpd.yaml @@ -1,23 +1,64 @@ -document: modulemd #Document type identifier -version: 0 #Version of the yaml +# httpd module - An Apache web server +# For detailed description of the module metadata format, see +# https://fedoraproject.org/wiki/Fedora_Packaging_Guidelines_for_Modules + +# Document header +document: modulemd +## This is the version of the modulemd specification, NOT of the module itself. +version: 0 + +# Metadata section -- this is the actual module description data: - name: httpd #name of the module - version: 2.4.18 #module version - release: 1 #module release + ## NVR (name, version, release) -- identification of a module's + # point-in-time version. It is best to follow the guidelines for + # RPM naming and versioning. + name: httpd + version: 2.4.18 + release: 1 + + ## Human-readable description of a module. + ### Summary -- short description (one sentence, should NOT end in period) + # Each word is considered keyword when searching the modules. summary: "HTTP daemon : A software program that runs in the background of a web server and waits for the incoming server requests" #Summary of the httpd module; each word is a keyword for the module database search - description: On the web, each server has an HTTPD, which is an HTTP daemon that waits for requests to come in from the rest of the web. This daemon processes these requests automatically, providing hypertext and multimedia documents. This package is necessary for an Apache server. #Description of the module + ### Expanded description (one paragraph, should end in period). + description: > + On the web, each server has an HTTPD, which is an HTTP daemon that waits + for requests to come in from the rest of the web. This daemon processes + these requests automatically, providing hypertext and multimedia + documents. This package is necessary for an Apache server. + + ## Licensing informations. Optional, recommended. license: - module: [ MIT ] #license of the httpd module yaml file - content: #Content license: list of licenses used by the packages in the module - - Apache License 2.0 + ### License(s) of the module itself (in other words, license of this file). + module: [ MIT ] + ### Licenses of the module's content. You should list all licenses used + # by anything in the module here. + content: + - Apache License 2.0 + + ## Module references -- links to various upstream resources. Optional. references: - community: http://httpd.markmail.org/ #Upstream community - documentation: http://httpd.apache.org/docs/current/ #Upstream documentation + ### Upstream community website. + community: http://httpd.markmail.org/ + ### Upstream documentation for the module. + documentation: http://httpd.apache.org/docs/current/ + + ## Module components -- definition of the actual module's content. Optional. components: + ### RPM content of the module. rpms: + #### Module packages -- the main subsection. Each key is a SRPM + # name, details are provided as SRPM-specific key-value pairs. packages: - httpd: #package included in the module - rationale: http daemon for processing server requests #The rationale answers: Why do we need this? - commit: 91a278 #First 6 characters of the fedora httpd git commit to use; if no commit is used, then commit (HEAD) will be used. By default, this is the repo we're using: http://pkgs.fedoraproject.org/cgit/rpms/httpd.git/ - #Since we want to use the build system configuration repository and the build system lookalike - #cache, we don't want to fill out the 'repository' or 'cache' fields + httpd: + ##### Why is this SRPM in the module. Required, free-form + # string. + rationale: http daemon for processing server requests + ##### Hash or other commit id, specifing which point in the + # VCS should be used for the build of the package. + # Recommended; if not specified, current HEAD/equivalent + # is used. + commit: 91a278 + # Since we want to use the build system configuration + # repository and the build system lookalike cache, we don't + # want to fill out the 'repository' or 'cache' fields From 8c37ea6af49dc6a1b0d3252d0338e38df69265bf Mon Sep 17 00:00:00 2001 From: Jan Staněk Date: Jul 27 2016 13:16:41 +0000 Subject: [PATCH 2/2] Clarify the optionality of licenses. --- diff --git a/modules/base-runtime/base-runtime.yaml b/modules/base-runtime/base-runtime.yaml index b0de1df..03ac8ff 100644 --- a/modules/base-runtime/base-runtime.yaml +++ b/modules/base-runtime/base-runtime.yaml @@ -24,13 +24,13 @@ data: description: > This module is essential for every build system. - ## Licensing informations. Optional, recommended. + ## Licensing informations. license: ### License(s) of the module itself (in other words, license of this file). module: - MIT ### Licenses of the module's content. You should list all licenses used - # by anything in the module here. + # by anything in the module here. Optional, recommended. content: [] ## Module components -- definition of the actual module's content. Optional. diff --git a/modules/httpd/httpd.yaml b/modules/httpd/httpd.yaml index a53994e..04069f7 100644 --- a/modules/httpd/httpd.yaml +++ b/modules/httpd/httpd.yaml @@ -27,12 +27,12 @@ data: these requests automatically, providing hypertext and multimedia documents. This package is necessary for an Apache server. - ## Licensing informations. Optional, recommended. + ## Licensing informations. license: ### License(s) of the module itself (in other words, license of this file). module: [ MIT ] ### Licenses of the module's content. You should list all licenses used - # by anything in the module here. + # by anything in the module here. Optional, recommended. content: - Apache License 2.0