37.4 Создание пакетов

Внутренне пакет представляет собой просто сжатый в формате gzip архив tar-файла, содержащий каталог верхнего уровня с произвольным именем. Этот каталог в дальнейшем будет обозначаться как package и может содержать следующие файлы:

package/CITATION

Это необязательный файл, описывающий инструкции по цитированию пакета для публикации. Он будет отображен дословно функцией citation.

package/COPYING

Это обязательный файл, содержащий лицензию пакета. В целом нет ограничений на лицензию. Однако, если пакет содержит динамически подключаемые функции, лицензия должна быть совместима с GNU General Public License.

package/DESCRIPTION

Это обязательный файл, содержащий информацию о пакете. Подробности об этом файле см. в Файле DESCRIPTION.

package/ChangeLog

Это необязательный файл, описывающий все изменения, внесенные в исходные файлы пакета.

package/INDEX

Это необязательный файл, описывающий функции, предоставляемые пакетом. Если этот файл отсутствует, он будет автоматически создан из функций в пакете и ключевого слова Categories в файле DESCRIPTION. Подробности об этом файле см. в Файле INDEX.

package/NEWS

Это необязательный файл, описывающий все заслуживающие внимания изменения, видимые пользователю. По мере увеличения размера этого файла старые записи можно перемещать в package/ONEWS.

package/ONEWS

Это необязательный файл, описывающий старые записи из файла NEWS.

package/PKG_ADD

Необязательный файл, содержащий команды, которые выполняются при добавлении пакета в пользовательский путь. Обратите внимание, что директивы PKG_ADD в исходном коде пакета также будут добавлены в этот файл менеджером пакетов Octave. Обратите внимание, что в пакетах следует избегать символических ссылок, так как символические ссылки отсутствуют на некоторых файловых системах, и типичное применение этого файла — замена символической ссылки

на директиву autoload, например

Подробности о директивах PKG_ADD см. в Директивах PKG_ADD и PKG_DEL.

package/PKG_DEL

Необязательный файл, содержащий команды, которые выполняются при удалении пакета из пользовательского пути. Обратите внимание, что директивы PKG_DEL в исходном коде пакета также будут добавлены в этот файл менеджером пакетов Octave. Подробности о директивах PKG_DEL см. в Директивах PKG_ADD и PKG_DEL.

package/pre_install.m

Это необязательная функция, которая выполняется перед установкой пакета. Эта функция вызывается с единственным аргументом, структурой с полями, именами по данным в DESCRIPTION, и путями, где будут установлены функции пакета.

package/post_install.m

Это необязательная функция, которая выполняется после установки пакета. Эта функция вызывается с единственным аргументом, структурой с полями, именами по данным в DESCRIPTION, и путями, где были установлены функции пакета.

package/on_uninstall.m

Это необязательная функция, которая выполняется перед удалением пакета. Эта функция вызывается с одним аргументом, структурой с полями, именами по данным в DESCRIPTION, путями, где установлены функции пакета, и загружен ли пакет в данный момент.

Помимо вышеупомянутых файлов, пакет также может содержать один или несколько следующих каталогов:

package/inst

Необязательный каталог, содержащий любые файлы, которые непосредственно устанавливаются пакетом. Как правило, это будут любые файлы m.

package/src

Необязательный каталог, содержащий код, который должен быть скомпилирован перед установкой пакета. Менеджер пакетов Octave выполнит ./configure в этом каталоге, если этот скрипт существует, а затем вызовет make, если в этом каталоге существует файл Makefile. make install однако не будет вызван. Переменные среды MKOCTFILE, OCTAVE_CONFIG, и OCTAVE будут установлены в полных путях программ mkoctfile, octave-config, и octave, соответственно, правильной версии, когда configure и make будут вызваны. Если существует файл FILES, все файлы, указанные в нем, будут скопированы в каталог inst, поэтому они также будут установлены. Если файла FILES не существует, src/*.m и src/*.oct будут скопированы в каталог inst.

package/doc

Необязательный каталог, содержащий документацию для пакета. Файлы в этом каталоге будут непосредственно установлены в подкаталоге установленного пакета для будущей справки.

package/bin

Необязательный каталог, содержащий файлы, которые будут добавлены в Octave EXEC_PATH при загрузке пакета. В нем могут содержаться внешние скрипты и т. п., вызываемые функциями внутри пакета.