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)

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

License

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

SystemRequirements

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

BuildRequires

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

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

BuildRequires: libtermcap-devel [Mandriva] libtermcap2-devel

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