How to use and edit comps.xml for package groups

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
(Core)
(Current status: update to new comps location)
 
(13 intermediate revisions by 9 users not shown)
Line 2: Line 2:
  
 
=== Installation ===
 
=== Installation ===
 
{{admon/warning | Changes in Fedora 18 and later | There are significant changes to how comps is handled in the installer in Fedora 18 and later releases }}
 
  
 
comps is used by the installer during software selection. At the installer
 
comps is used by the installer during software selection. At the installer
Line 13: Line 11:
 
by any groups that are marked as 'uservisible' in the comps file.
 
by any groups that are marked as 'uservisible' in the comps file.
  
=== Installation (releases prior to Fedora 18) ===
+
=== Running System ===
[[Image:F10.anaconda.customize_now.initial_screen.png|200px|thumb|right|Category Selection dialog]]
+
comps is used by the installer during package selection.  At the Default Packages dialog , the user can choose to Customize Now, displaying the Category Selection dialog.
+
  
In the category selection dialog , categories (as defined by the <code>category</code> keyword in <file>comps.xml</file>) are listed down the left-hand side. If a category is selected, any groups in that category with <code>uservisible</code> set are displayed in the right-hand pane. Groups have an icon associated with them. These icons come from the <code>comps-extras</code> package; icons are read from <code>/usr/share/pixmaps/comps/<group-id>.png</code>. If an icon does not exist for a group id, the one for the category that the group is in is used.
+
In [[dnf]], groups are used by:
  
Once a group is selected, clicking the Optional Packages button shows [[Image:F10.anaconda.graphical_internet.detail.png|200px|thumb|right|Package Selection dialog]] Package Selection dialog.
+
dnf [options] group [summary] <group-spec>
 +
Display overview of how many groups are installed and available. With a spec, limit the output to the matching groups. summary is the default groups subcommand.
  
In any group, there are four levels of packages: optional, default, mandatory, and conditional:
 
  
* <code>optional</code> are not automatic but can be checked
+
dnf [options] group info <group-spec>
* <code>default</code> are, but can be unchecked in a gui tool
+
Display package lists of a group. Shows which packages are installed or available from a repo when -v is used.
* <code>mandatory</code> are always brought in (if group is selected), and not visible in the Package Selection dialog.
+
* <code>conditional</code> are brought in if their <code>requires</code> package is installed
+
  
Usually optional is the way, however if you feel that your package deserves a default or required level bring it up for discussion on the development lists.  Remember that this has effect on whether or not your package winds up on distribution media such as Live images and spins.
 
  
=== Running System ===
+
dnf [options] group install [with-optional] <group-spec>...
[[Image:Packagekit.package_selection_ui.png|200|thumb|right|PackageKit example group selection]]
+
Mark the specified group installed and install packages it contains. Also include optional packages of the group if with-optional is specified.
  
In yum, groups are used by <code>yum groupinstall</code> and <code>yum groupremove</code> commands, and can be queried with <code>yum grouplist</code> command.
 
  
In PackageKit (Add / Remove Software) the upper left quadrant shows Package collections. When this is clicked, the grouping information is loaded from the configured software repositories, and the complete list of groups, stripped from their categories, are shown in the right hand pane. Selecting a group for installation causes only the default packages within the group to be installed.
+
  dnf [options] group list <group-spec>...
 +
List all matching groups, either among installed or available groups. If nothing is specified list all known groups. Records are ordered by display_order tag defined in comps.xml file.
 +
 
 +
 
 +
dnf [options] group remove <group-spec>...
 +
Mark the group removed and remove those packages in the group from the system which are neither comprising another installed group and were not installed explicitly by the user.
 +
 
 +
 
 +
dnf [options] group upgrade <group-spec>...
 +
Upgrades the packages from the group and upgrades the group itself. The latter comprises of installing pacakges that were added to the group by the distribution and removing packages that got removed from the group as far as they were not installed explicitly by the user.
 +
 
 +
 
 +
Groups can be also be marked installed or removed without physically manipualting any packages:
 +
 
 +
dnf [options] group mark install <group-spec>...
 +
Mark the specified group installed. No packages will be installed by this command but the group is then considered installed.
 +
 
 +
 
 +
dnf [options] group mark remove <group-spec>...
 +
Mark the specified group removed. No packages will be removed by this command.
  
 
=== Tree, Release, and Image Composition ===
 
=== Tree, Release, and Image Composition ===
  
The kickstart files in [http://git.fedorahosted.org/git/?p=spin-kickstarts.git spin-kickstarts] use the group definitions from comps to compose
+
The kickstart files in [https://pagure.io/fedora-kickstarts fedora-kickstarts] use the group definitions from comps to compose
 
images and release trees.
 
images and release trees.
  
== When to Edit comps ==
+
Environment definitions should not be used in a kickstart, if you wish to use the environment of "Minimal Install" it should be the list of package groups that comprise the enviornment instead as such:
 +
@standard
 +
@guest-agents
 +
 
 +
This is found in the comps.xml under the environment you wish to use.
 +
 
 +
== When to submit changes to comps ==
  
 
* If your app should be part of one of the installation environments, or part of an option for one of them, it should be included
 
* If your app should be part of one of the installation environments, or part of an option for one of them, it should be included
Line 55: Line 72:
 
=== New groups ===
 
=== New groups ===
  
Please consult devel@lists.fedoraproject.org before adding new groups.
+
Please consult {{fplist|devel}} before adding new groups.
  
 
New user-visible group names and descriptions are '''translatable strings'''. Do not add new groups, or change their descriptions, during a [[L10N/Freezes| string freeze]]. Please check the release schedule for these dates.
 
New user-visible group names and descriptions are '''translatable strings'''. Do not add new groups, or change their descriptions, during a [[L10N/Freezes| string freeze]]. Please check the release schedule for these dates.
Line 67: Line 84:
 
=== [[SIGs/Desktop | GNOME Desktop ]] ===
 
=== [[SIGs/Desktop | GNOME Desktop ]] ===
  
The gnome-desktop group and GNOME environment definition is maintained by the [[SIGs/Desktop | Desktop SIG]]. Please run changes through desktop@lists.fedorarproject.org.
+
The gnome-desktop group and GNOME environment definition is maintained by the [[SIGs/Desktop | Desktop SIG]]. Please run changes through {{fplist|desktop}}.
  
 
=== [[SIGs/KDE | KDE Desktop ]] ===
 
=== [[SIGs/KDE | KDE Desktop ]] ===
Line 80: Line 97:
 
{{:Fonts_SIG_signature}}
 
{{:Fonts_SIG_signature}}
  
=== Language support groups ===
+
=== All other groups ===
 
+
{{admon/warning | Language support groups deprecated | Language support groups are deprecated in favor of use of the yum-langpacks plugin. This documentation is provided for reference for earlier releases }}
+
 
+
Language support groups are selected automatically if you are installing in the specified language, and manually otherwise. Language support groups require the <code>langonly</code> key, which should be set to ISO 639-1 two-letter language code for that language, or the ISO 639-2 bibliography code, if that does not exist.
+
These codes can be looked up in the <code>iso-codes</code> package.
+
 
+
Each language support group should have mandatory packages for:
+
  
* fonts required for that locale (consult the [[:Category:Fonts SIG| Fonts SIG]])
+
When making changes to the default or mandatory packages, strive for consensus, and consult the development lists as necessary. If you're unsure, you can also file a bug against the comps component in bugzilla.
* input methods, and data, required for that locale (consult the [[I18N| I18N SIG]])
+
  
Each language support group can have optional packages for:
+
== How to submit changes to comps ==
  
* additional fonts that support that locale (consult the [[:Category:Fonts SIG| Fonts SIG]])
+
Fork the fedora-comps git module in Pagure at https://pagure.io/fedora-comps. Then you can clone your fork:
 
+
New language support groups need added to the <code>language-support</code> category in the comps file.
+
 
+
=== All other groups ===
+
 
+
When making changes to the default or mandatory packages, strive for consensus, and consult the development lists as necessary. If you're unsure, you can also file a bug against the comps component in bugzilla.
+
  
== How to edit comps ==
+
<pre>git clone ssh://git@pagure.io/forks/&lt;username&gt;/fedora-comps.git</pre>
  
Clone the comps GIT module in Fedora Hosted:
+
Substitute your FAS username for &lt;username&gt; above.  Then checkout a branch, using whatever name you prefer (a descriptive name is helpful):
  
<code>git clone ssh://username@git.fedorahosted.org/git/comps.git</code>
+
<pre>git checkout -b &lt;branch-name&gt;</pre>
  
Find a reasonable group in the comps-f''n''xml.in file (where ''n'' represents the release number) for
+
Then, find a reasonable group in the comps-f''n''xml.in file (where ''n'' represents the release number) for
your package. If your package is not listed there, please add it
+
your package. If your package is not listed there, please add it using the following as a template if your package were named "foo":
using the following as a template if your package were named "foo":
+
  
 
<packagereq type="optional">foo</packagereq>
 
<packagereq type="optional">foo</packagereq>
Line 126: Line 128:
  
 
Commit your changes (<code>git commit -a</code>). You
 
Commit your changes (<code>git commit -a</code>). You
can then push your changes to the repository with <code>git push</code>.
+
can then push your changes to the repository with <code>git push origin &lt;branch-name&gt;</code>.
  
Please make sure to run <code>git pull --rebase</code> right before <code>git push</code> to
+
You can then file a pull request from your new branch in the Pagure interface.
avoid overwriting other people's changes as much as possible.
+
  
 
== Current status ==
 
== Current status ==
  
You can check our current comps status file [http://git.fedorahosted.org/git/comps.git here].
+
You can check our current comps status file [https://pagure.io/fedora-comps in the git web interface].
  
 
[[Category:Comps_SIG]][[Category:Package Maintainers]]
 
[[Category:Comps_SIG]][[Category:Package Maintainers]]

Latest revision as of 10:02, 14 June 2016

Contents

[edit] How comps is used

[edit] Installation

comps is used by the installer during software selection. At the installer software selection dialog, the user can choose between a variety of Environments on the left, and Options to those environments on the right.

Each environment consists of a list of groups, and a list of groups that are options for that environment. The list of available options is supplemented by any groups that are marked as 'uservisible' in the comps file.

[edit] Running System

In dnf, groups are used by:

dnf [options] group [summary] <group-spec>

Display overview of how many groups are installed and available. With a spec, limit the output to the matching groups. summary is the default groups subcommand.


dnf [options] group info <group-spec>

Display package lists of a group. Shows which packages are installed or available from a repo when -v is used.


dnf [options] group install [with-optional] <group-spec>...

Mark the specified group installed and install packages it contains. Also include optional packages of the group if with-optional is specified.


dnf [options] group list <group-spec>...

List all matching groups, either among installed or available groups. If nothing is specified list all known groups. Records are ordered by display_order tag defined in comps.xml file.


dnf [options] group remove <group-spec>...

Mark the group removed and remove those packages in the group from the system which are neither comprising another installed group and were not installed explicitly by the user.


dnf [options] group upgrade <group-spec>...

Upgrades the packages from the group and upgrades the group itself. The latter comprises of installing pacakges that were added to the group by the distribution and removing packages that got removed from the group as far as they were not installed explicitly by the user.


Groups can be also be marked installed or removed without physically manipualting any packages:

dnf [options] group mark install <group-spec>...

Mark the specified group installed. No packages will be installed by this command but the group is then considered installed.


dnf [options] group mark remove <group-spec>...

Mark the specified group removed. No packages will be removed by this command.

[edit] Tree, Release, and Image Composition

The kickstart files in fedora-kickstarts use the group definitions from comps to compose images and release trees.

Environment definitions should not be used in a kickstart, if you wish to use the environment of "Minimal Install" it should be the list of package groups that comprise the enviornment instead as such: @standard @guest-agents

This is found in the comps.xml under the environment you wish to use.

[edit] When to submit changes to comps

  • If your app should be part of one of the installation environments, or part of an option for one of them, it should be included
  • If you're creating a new option for an installation environment
  • Libraries should not be included - they will be pulled in via dependencies
  • Most text-mode utilities don't really fit in unless they have a pretty large established user-base.

If you have questions as to whether it makes sense or not, feel free to post to the development list.

Some guidelines on specific groups in comps follows.

[edit] New groups

Please consult devel before adding new groups.

New user-visible group names and descriptions are translatable strings. Do not add new groups, or change their descriptions, during a string freeze. Please check the release schedule for these dates.

[edit] Core

Core is not visible, so adding 'default' or 'optional' packages to it isn't needed. Boot loaders are listed as 'default' in the group so that they're pulled in by compose tools.

Core is installed on every installation, so adding packages to it is discouraged. Please run changes by the Minimal Core SIG.

[edit] GNOME Desktop

The gnome-desktop group and GNOME environment definition is maintained by the Desktop SIG. Please run changes through desktop.

[edit] KDE Desktop

The kde-desktop group and KDE environment definition is maintained by the KDE SIG. Please run changes by them.

[edit] Fonts

The following is part of the Fonts SIG packaging rules.


Fonts for a particular linguistic region used to be bundled in fonts-region packages. Nowadays this practice is frowned upon, fonts package naming reflects upstream naming like in any other Fedora package, and grouping is achieved through comps groups.

  • Font packages in a legacy format (not TTF or OTF) MUST be registered in the legacy-fonts group.
  • Font packages in a non-legacy format (TTF or OTF):
    1. MUST be registered in the fonts group:
      • except when they don't have an active upstream, in which case putting them in legacy-fonts is fine.
    2. SHOULD also be registered in every applicable xxx-support localization group:
      • except groups that only require glyphs in the basic latin range.
      • if a font package adds support for a script previously not supported by Fedora the associated localization groups MUST be created and filed, and the relevant localization teams notified.
    3. SHOULD be declared optional, unless:
      • they add support for a new script, in which case they MUST be declared required in the associated localization groups.
      • they add better support for already supported scripts, in which case, if the localization team in charge of each localization group agrees:
        • they can replace existing fonts as mandatory if this script is not covered by distribution-wide default fonts.
        • they can replace existing fonts as default if this script is covered by distribution-wide default fonts.



Idea.png
Fonts in Fedora
The Fonts SIG takes loving care of Fedora fonts. Please join this special interest group if you are interested in creating, improving, packaging, or just suggesting a font. Any help will be appreciated.

[edit] All other groups

When making changes to the default or mandatory packages, strive for consensus, and consult the development lists as necessary. If you're unsure, you can also file a bug against the comps component in bugzilla.

[edit] How to submit changes to comps

Fork the fedora-comps git module in Pagure at https://pagure.io/fedora-comps. Then you can clone your fork:

git clone ssh://git@pagure.io/forks/<username>/fedora-comps.git

Substitute your FAS username for <username> above. Then checkout a branch, using whatever name you prefer (a descriptive name is helpful):

git checkout -b <branch-name>

Then, find a reasonable group in the comps-fnxml.in file (where n represents the release number) for your package. If your package is not listed there, please add it using the following as a template if your package were named "foo":

<packagereq type="optional">foo</packagereq>

  • Make sure to preserve the alphabetical order in each group.
  • Make sure to run xmllint on the result to check you didn't make a mistake in the XML syntax.

You can use the provided xslt filter to sort, indent and check the syntax of your comps file in one run:

$ xsltproc --novalid -o sorted-file comps-cleanup.xsl original-file

The filter will warn you if it removes redundant information or if something needs to be checked by a human.

Commit your changes (git commit -a). You can then push your changes to the repository with git push origin <branch-name>.

You can then file a pull request from your new branch in the Pagure interface.

[edit] Current status

You can check our current comps status file in the git web interface.