New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: Add "service" components and their launchables #115
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| <?xml version='1.0' encoding='utf-8' ?> | ||
| <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ | ||
| <!ENTITY % BOOK_ENTITIES SYSTEM "AppStream.ent"> | ||
| %BOOK_ENTITIES; | ||
| ]> | ||
|
|
||
| <section id="sect-Metadata-Service"> | ||
| <title>Services</title> | ||
|
|
||
| <section id="spec-service-introduction"> | ||
| <title>Introduction</title> | ||
| <para> | ||
| A service component is any software that is started and supervised by | ||
| the Operating Systems "init" facility, such as systemd. | ||
| </para> | ||
| <para> | ||
| The metadata described in this document is built upon the generic component metadata with fields specific for services (see <xref linkend="sect-Metadata-GenericComponent"/>). | ||
| All tags valid for a generic component are valid for a <literal>service</literal> component as well. | ||
| </para> | ||
| <para> | ||
| In order to enhance the available metadata about their services, projects shipping a service can ship one or more metainfo files | ||
| in <filename>/usr/share/metainfo/%{id}.metainfo.xml</filename>. | ||
| </para> | ||
|
|
||
| </section> | ||
|
|
||
| <section id="spec-service-filespec"> | ||
| <title>File specification</title> | ||
|
|
||
| <para> | ||
| The basic structure for a generic component as described at <xref linkend="spec-component-filespec"/> applies. | ||
| Note that the XML root must have the <literal>type</literal> property set to <code>service</code>, while in a generic component this | ||
| property can be omitted. This clearly identified this metainfo document as describing a service. | ||
| </para> | ||
|
|
||
| <para> | ||
| The following list describes tags for <literal>service</literal> upstream metadata and provides some additional information about the values | ||
| the tags are expected to have. | ||
| If no information is given about a tag, refer to the respective tag in <xref linkend="sect-Metadata-GenericComponent"/>. | ||
| </para> | ||
|
|
||
| <variablelist> | ||
| <varlistentry id="tag-id-service-app"> | ||
| <term><id/></term> | ||
| <listitem> | ||
| <para> | ||
| For services, the <code><id/></code> tag value must follow the AppStream ID naming conventions (it should be a reverse-DNS name). | ||
| </para> | ||
| </listitem> | ||
| </varlistentry> | ||
|
|
||
| <varlistentry> | ||
| <term><metadata_license/></term> | ||
| <listitem> | ||
| <para> | ||
| The <code><metadata_license/></code> tag as described in <xref linkend="tag-metadata_license"/> must be present. | ||
| </para> | ||
| </listitem> | ||
| </varlistentry> | ||
|
|
||
| <varlistentry> | ||
| <term><name/></term> | ||
| <listitem> | ||
| <para> | ||
| A <literal>name</literal> must be present for services. See <xref linkend="tag-name"/> for a detailed description of this tag. | ||
| </para> | ||
| </listitem> | ||
| </varlistentry> | ||
|
|
||
| <varlistentry> | ||
| <term><summary/></term> | ||
| <listitem> | ||
| <para> | ||
| A <literal>summary</literal> must be present for services. See <xref linkend="tag-summary"/> for a detailed description of this tag. | ||
| </para> | ||
| </listitem> | ||
| </varlistentry> | ||
|
|
||
| <varlistentry id="tag-service-provides"> | ||
| <term><provides/> ↪ <service/></term> | ||
| <listitem> | ||
| <para> | ||
| This tag is described in detail for generic components at <xref linkend="tag-provides"/>. | ||
| </para> | ||
| </listitem> | ||
| </varlistentry> | ||
|
|
||
| <varlistentry id="tag-service-launchable"> | ||
| <term><launchable/></term> | ||
| <listitem> | ||
| <para> | ||
| This tag is described in detail for generic components at <xref linkend="tag-launchable"/>. | ||
| </para> | ||
| <para> | ||
| At least one launchable element with type "service" must be present. | ||
| The value is a name that can be used with the OS init facility to | ||
| start/stop and monitor the service. | ||
| </para> | ||
| </listitem> | ||
| </varlistentry> | ||
|
|
||
| </variablelist> | ||
|
|
||
| <para> | ||
| For a component of type <literal>service</literal>, the following tags are required and must always be present: <xref linkend="tag-id-service-app"/>, | ||
| <xref linkend="tag-metadata_license"/>, <xref linkend="tag-name"/>, <xref linkend="tag-summary"/>, <xref linkend="tag-service-provides"/>. | ||
| </para> | ||
|
|
||
| </section> | ||
| </section> | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make that "service" a
<literal>service</literal>There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not relevant anymore since the text has been removed.