37.4.1 Файл DESCRIPTION

Файл DESCRIPTION содержит различные сведения о пакете, такие как его название, автор и версия. Формат этого файла очень прост:

• Строки, начинающиеся с «#», являются комментариями.
• Строки, начинающиеся с пробельного символа, являются продолжением предыдущей строки.
• Все остальные строки имеют форму NameOfOption: ValueOfOption.

Ниже приведён простой пример файла DESCRIPTION:

Name: The name of my package
Version: 1.0.0
Date: 2007-18-04
Author: The name (and possibly email) of the package author.
Maintainer: The name (and possibly email) of the current
 package maintainer.
Title: The title of the package
Description: A short description of the package.  If this
 description gets too long for one line it can continue
 on the next by adding a space to the beginning of the
 following lines.
License: GPLv3+

В настоящее время менеджер пакетов распознаёт следующие ключевые слова:

Name

Название пакета.

Version

Версия пакета. Обычно версия пакета состоит из чисел, разделённых точками, но также может содержать «+», «-», «~» и буквенно-цифровые символы (в локали «C»). Например, "2.1.0+" может обозначать версию пакета для разработки. Версии сравниваются с помощью compare_versions.

Date

Дата последнего обновления.

Author

Первоначальный автор пакета.

Maintainer

Сопровождающий пакета.

Title

Краткое описание пакета в одну строку.

Description

Описание пакета в один абзац.

Categories

Необязательное ключевое слово, описывающее пакет (если файл INDEX отсутствует, это поле обязательно).

Problems

Необязательный список известных проблем.

Url

Необязательный список веб-сайтов, связанных с пакетом.

Depends

Список других пакетов Octave, от которых зависит данный пакет. Можно указать зависимость от определённых версий в следующем формате:

Depends: package (>= 1.0.0)

Допустимые операторы: <, <=, ==, >= или >. Если часть зависимости в () не указана, подходит любая версия пакета. Несколько зависимостей можно задать списком, разделённым запятыми. Так можно указать диапазон версий определённого пакета:

Depends: package (>= 1.0.0), package (< 1.5.0)

Также можно указать зависимость от определённых версий ядра Octave:

Depends: octave (>= 3.8.0)

License

Необязательное краткое описание используемой лицензии (например, GPL версии 3 или более поздней). Это поле необязательно, поскольку файл COPYING является обязательным.

SystemRequirements

Это внешние зависимости пакета для установки, которые не проверяются менеджером пакетов. Они указаны в качестве подсказки для сборщика дистрибутива. Для них используются те же соглашения, что и для ключевого слова Depends.

BuildRequires

Это внешние зависимости пакета для сборки, которые не проверяются менеджером пакетов. Они указаны в качестве подсказки для сборщика дистрибутива. Для них используются те же соглашения, что и для ключевого слова Depends. Обратите внимание, что системы сборки пакетов, такие как rpm или deb, обычно автоматически определяют зависимости для установки по зависимостям для сборки, поэтому зависимость BuildRequires обычно избавляет от необходимости указывать зависимость SystemRequirements.

Разработчик может добавлять в файл DESCRIPTION дополнительные аргументы для собственных целей. Ещё одна деталь, полезная для сборщика пакетов: ключевые слова SystemRequirements и BuildRequires могут содержать раздел, зависящий от дистрибутива, который будет использоваться при автоматической сборке. Пример такого формата:

BuildRequires: libtermcap-devel [Mandriva] libtermcap2-devel

В этом случае название первого пакета будет использоваться по умолчанию, а если RPM-пакеты собираются в дистрибутиве Mandriva, вместо него будет использоваться название второго пакета.