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

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