Jump to content Jump to page navigation: previous page [access key p]/next page [access key n]
AppStream
AppStream › Upstream Metadata › Driver
AppStream › Upstream Metadata › Driver
Top
←→

## 2.13 Driver #

### 2.13.1 Introduction #

The `driver` component type describes drivers for hardware devices as well as other Linux kernel drivers for e.g. virtualization support. It usually `provides` one or multiple modaliases.

Drivers can ship one or more files in `/usr/share/metainfo/%{id}.metainfo.xml`.

### 2.13.2 Example file #

A driver metainfo file can look like this:

    <?xml version="1.0" encoding="UTF-8"?>
    <component type="driver">
      <id>com.nvidia.GeForce</id>
      <name>NVIDIA GeForce</name>
      <summary>NVIDIA Graphics Driver</summary>
      <description>
        <p>
          The NVIDIA Accelerated Linux Graphics Driver brings accelerated 2D
          functionality and high-performance OpenGL support to Linux x86 with the
          use of NVIDIA graphics processing units.
        </p>
        ...
      </description>
      <url type="homepage">http://www.nvidia.com/Download/index.aspx</url>
      <metadata_license>CC0-1.0</metadata_license>
      <project_license>LicenseRef-proprietary:NVIDIA</project_license>

      <developer id="nvidia.com">
        <name>NVIDIA Corporation</name>
      </developer>

      <provides>
        <modalias>pci:v000010DEd*sv*sd*bc03sc00i00*</modalias>
        ...
      </provides>
    </component>

### 2.13.3 File specification #

Note that the XML root must have the `type` property set to `driver`. This clearly identifies this metainfo document as describing a driver.

<id/> #

  For drivers, the value of the `<id/>` tag must follow the reverse-DNS scheme as described for generic components. It is sometimes useful to suffix the ID with `.driver` to make it more unique.

<provides/> ↪ <modalias/> #

  The `provides/modalias` tags contain all the modaliases the described driver supports and allow to automatically offer installation of the described driver on systems where hardware matching the modalias has been detected.

  Using wildcards for modaliases is permitted.

  Example:

      <provides>
        <modalias>pci:v000010DEd00001194sv*sd*bc03sc*i*</modalias>
        <modalias>pci:v000010DEd00001199sv*sd*bc03sc*i*</modalias>
      </provides>

For a component of type `driver`, the following tags are required and must be present for a valid document: <id/>, <name/>, <summary/>, <metadata_license/>, <provides/> ↪ <modalias/>.