Support/writedocs

Работа с документацией по Wine

Получение репозитория с документацией

Репозиторий находится здесь: http://git.etersoft.ru/projects/wine/wine-etersoft-docs.git.

Получить его можно командой

$ git clone http://git.etersoft.ru/projects/wine/wine-etersoft-docs.git

Если у вас есть логин на git.etersoft.ru, тогда

$ git clone git.eter:/projects/wine/wine-etersoft-docs.git

Описание расположения файлов

Документация составляется из разрозненных файлов, сгруппированных по каталогам. В common лежат общие описания, в programs - описания конкретных программ.

Внесение изменений

Документация пишется в кодировке utf-8, используя разметку m-k (описание находится в корне в файле README). Если система имеет другую локаль, можно запустить

$ uxterm

она изменит локаль и запустит юникодный терминал.

Исправленный файл следует обязательно проверить командой

make FILE.html

При этом должен появиться html-файл, преобразованный из m-k.

Каждое логически целостное изменение необходимо сразу коммитить. Для этого выполняем

$ git commit файл[ы]

Создание PDF или HTML

Выполнение make в каталоге booklet должно привести к формированию PDF и HTML-файлов с документацией, сформированным согласно правилам в Makefile.

Также можно сформировать руководство в каталоге manual.

Публикация изменений

Для публикации изменений на git-сервер достаточно выполнить gpush git.eter.

Если логина нет, достаточно с помощью git format-patch сформировать патчи с изменениями и отправить по почте в wine-patches@lists.etersoft.ru

Публикация на сайт и в проект

Для публикации документации на сайте в каталоге booklet выполняется команда make publish. Для публикации документации в репозиторий с релизом WINE@Etersoft

make publish в каталоге manual.

См. руководство по git.