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, то вместо этого будет использовано второе имя пакета.