[newbies] советы по мотивам spec-файла

[newbies] советы по мотивам spec-файла

[Artem Zolochevskiy]

hi all

В процессе упаковки одного из пакетов хочется задать вопросы, которые
у меня в связи с ним возникают.
Конкретно речь идёт об asciidoc: http://tinyurl.com/yl3by83
Так что можно рассматривать мой пример как обсуждаемое в @devel линчевание.

 Однако, хотелось бы получить рекомендации не только про "в этом
конкретном случае", а и "вообще".
Пишу именно в эту рассылку ожидая характерную для этой рассылки
степень подробности реакции.

Итак мои сомнения:
1. В процессе установки ПО Makе-файлом  в каталоге /usr/bin/ (
$(bindir) ) предусмотрено:
  * Два питоновских файла: asciidoc.py и a2x.py
  * симлинки на них в этом же какталоге: asciidoc и a2x соовтетсвенно.

Собственно, в обиходе при работе используются именно имена симлинков.
Тут вопрос вот какой: Нет ли тогда более подходящего места для
asciidoc.py и a2x.py?

2. Вопрос по установке документации. Обычно я просто использовал в
спеке %doc <список фалов> и они попадали туда, куда следует. Но вот
asciidoc распилен на подпакеты, и они устанавливают свои файлы в
/usr/share/doc/asciidoc-<version>. В связи с этим этот каталог по идее
надо как-то явно указывать. Вот и есть вопрос с использованием в спеке
каталога /usr/share/doc . Для его использования, видимо, надо бы
использовать что-то из: $RPM_DOC_DIR? %_defaultdocdir? %_docdir?
  * какие-то может я ещё варианты упустил?
  * так что же использовать то?
  * всё ли из перечисленного что является "макросами"? Например я
видел использование в спеке $RPM_DOC_DIR. Это по крайней мере выгладит
не как макрос, который вроде как всегда начинаются с %?
  * отчего  rpm --eval %_docdir не даёт мне ожидаемого /usr/share/doc ?

3. Вопрос по именованию. Я уже говорил, что asciidoc распилен на
подпакеты. Это ПО содержит две большие утилиты: asciidoc и a2x. Так
вот пакеты в итоге и именуются:
  * asciidoc (для всего, что относится к утилите asciidoc)
  * asciidoc-a2x (для всего, что относится к утилите a2x)
  * asciidoc-doc (документация по этим утилитам)
  * есть ещё плагин для vim, но, думаю, сейчас это не принципиально.
Вопроса тут два:
  * не использовать ли имя пакета asciidoc для именования пакета,
устанавливающего _все_ компоненты? (надо, конечно будет тогда
придумать имя для пакета, который сейчас именуется asciidoc)
  * стоит ли ставить зависимость: пакет документации зависит от пакета
самой программы? Каковы тут правила/традиция?

Пока, думаю вопросов достаточно.

Спасибо!
-- 
Артём Золочевский

Re: [newbies] советы по мотивам spec-файла

[Aleksey Avdeev]

[-- Attachment #1: Type: text/plain, Size: 1660 bytes --]

10.10.2009 22:05, Artem Zolochevskiy пишет:
> hi all
> 
> В процессе упаковки одного из пакетов хочется задать вопросы, которые
> у меня в связи с ним возникают.
> Конкретно речь идёт об asciidoc: http://tinyurl.com/yl3by83
> Так что можно рассматривать мой пример как обсуждаемое в @devel линчевание.
> 
...
> 
> 2. Вопрос по установке документации. Обычно я просто использовал в
> спеке %doc <список фалов> и они попадали туда, куда следует. Но вот
> asciidoc распилен на подпакеты, и они устанавливают свои файлы в
> /usr/share/doc/asciidoc-<version>. В связи с этим этот каталог по идее
> надо как-то явно указывать. Вот и есть вопрос с использованием в спеке
> каталога /usr/share/doc . Для его использования, видимо, надо бы
> использовать что-то из: $RPM_DOC_DIR? %_defaultdocdir? %_docdir?
>   * какие-то может я ещё варианты упустил?
>   * так что же использовать то?
>   * всё ли из перечисленного что является "макросами"? Например я
> видел использование в спеке $RPM_DOC_DIR. Это по крайней мере выгладит
> не как макрос, который вроде как всегда начинаются с %?
>   * отчего  rpm --eval %_docdir не даёт мне ожидаемого /usr/share/doc ?

  Макроса %_docdir нет. Есть %_defaultdocdir.

> 
> 3. Вопрос по именованию. Я уже говорил, что asciidoc распилен на
> подпакеты. Это ПО содержит две большие утилиты: asciidoc и a2x. Так
> вот пакеты в итоге и именуются:
...
>   * стоит ли ставить зависимость: пакет документации зависит от пакета
> самой программы? Каковы тут правила/традиция?

  Лучше не надо: возможность поставить документацию не ставя сам пакет
-- весьма полезна.

-- 

С уважением. Алексей.



[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 554 bytes --]

Re: [newbies] советы по мотивам spec-файла

[Alexey I. Froloff]

[-- Attachment #1: Type: text/plain, Size: 920 bytes --]

On Sat, Oct 10, 2009 at 09:05:05PM +0300, Artem Zolochevskiy wrote:
>   * Два питоновских файла: asciidoc.py и a2x.py
>   * симлинки на них в этом же какталоге: asciidoc и a2x соовтетсвенно.
Расширение .py никому не нужно.  Переименовать.

>   * какие-то может я ещё варианты упустил?
Если docdir заполняется на стадии %install и плюс к этому хочется
использовать %doc в %files, обязательно сделать:

%define _customdocdir %_defaultdocdir/%name-%version

и %doc использовать только в одном пакете.  Вместо %doc в %files
можно раскладывать всю документацию на стадии %install, а в
%files ссылаться на %_customdocdir/foo (не забываем про %dir
%%_customdocdir в каждом пакете).

>   * стоит ли ставить зависимость: пакет документации зависит от пакета
> самой программы? Каковы тут правила/традиция?
Conflicts: %name < %version-%release
Conflicts: %name > %version-%release

-- 
Regards,
Sir Raorn.

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 198 bytes --]

Re: [newbies] советы по мотивам spec-файла

[Alexey I. Froloff]

[-- Attachment #1: Type: text/plain, Size: 537 bytes --]

On Sat, Oct 10, 2009 at 09:05:05PM +0300, Artem Zolochevskiy wrote:
>   * не использовать ли имя пакета asciidoc для именования пакета,
> устанавливающего _все_ компоненты? (надо, конечно будет тогда
> придумать имя для пакета, который сейчас именуется asciidoc)
Это сложный философский вопрос.  Кто пользуется asciidoc ради
a2x?  Если количество таких пользователей пренебрежимо мало, то
можно и не напрягаться.  В противном случае надо обеспечить
присутствие a2x после обновления основного пакета.

-- 
Regards,
Sir Raorn.

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 198 bytes --]

Re: [newbies] советы по мотивам spec-файла

[Michael Shigorin]

On Sat, Oct 10, 2009 at 09:05:05PM +0300, Artem Zolochevskiy wrote:
> 2. Вопрос по установке документации. [...]
>   * какие-то может я ещё варианты упустил?

Можно смотреть в libalsa.spec, там документация из libalsa-docs
складывается в каталог /usr/share/doc/libalsa-%version/ (и точно
так же можно из нескольких подпакетов, как рядом и расписано --
просто сам обычно в таких случаях помню, что "libalsa", и лезу
посмотреть туда):

%define pkgdocdir %_docdir/%name-%version

[...]

%install
#...
mkdir -p %buildroot%pkgdocdir
install -pm644 NOTES MEMORY-LEAK TODO %buildroot%pkgdocdir/
cp -a doc/doxygen/html %buildroot%pkgdocdir/

[...]

%files docs
%dir %pkgdocdir
%pkgdocdir/[D-Z]*
%pkgdocdir/html

> 3. Вопрос по именованию. Я уже говорил, что asciidoc распилен
> на подпакеты. Это ПО содержит две большие утилиты: asciidoc и
> a2x.

Они настолько велики сами по себе или различны по наборам
зависимостей, что в распиле пакета есть реальный смысл?

[посмотрел: asciidoc тащит только питон с кучкой модулей,
a2x -- вдобавок lynx xsltproc docbook-style-xsl dblatex;
пожалуй, оправданно, хотя размер подпакета -a2x минимален]

>   * стоит ли ставить зависимость: пакет документации зависит от
>     пакета самой программы? Каковы тут правила/традиция?

По-моему, хорошая традиция -- это знать меру и не доходить
до оверинжиниринга. :)  А вообще документацию порой ставят
и без программы -- на почитать.  Сейчас это скорее редкость,
но раз уж ты спрашиваешь...


On Sun, Oct 11, 2009 at 03:18:15AM +0400, Alexey I. Froloff wrote:
> >   * не использовать ли имя пакета asciidoc для именования пакета,
> > устанавливающего _все_ компоненты? (надо, конечно будет тогда
> > придумать имя для пакета, который сейчас именуется asciidoc)
> Это сложный философский вопрос.  Кто пользуется asciidoc ради
> a2x?  Если количество таких пользователей пренебрежимо мало, то
> можно и не напрягаться.  В противном случае надо обеспечить
> присутствие a2x после обновления основного пакета.

Насколько понимаю, можно не напрягаться.  Если всё-таки ошибся
и вылезут недовольные пользователи сизифа, то ради избежания
недовольства обновляющих дистрибутивы можно и сделать.

-- 
 ---- WBR, Michael Shigorin <mike@altlinux.ru>
  ------ Linux.Kiev http://www.linux.kiev.ua/

Re: [newbies] советы по мотивам spec-файла

[Artem Zolochevskiy]

11 октября 2009 г. 2:13 пользователь Alexey I. Froloff
<raorn@altlinux.org> написал:
> On Sat, Oct 10, 2009 at 09:05:05PM +0300, Artem Zolochevskiy wrote:
>>   * Два питоновских файла: asciidoc.py и a2x.py
>>   * симлинки на них в этом же какталоге: asciidoc и a2x соовтетсвенно.
> Расширение .py никому не нужно.  Переименовать.

Точно! А что мне такое просто решение в голову не пришло. А то я было
думал куда то в недра /usr/share/ эти .py выносить, в а bindir делать
симлинки с именами без разширений.

>>   * какие-то может я ещё варианты упустил?
> Если docdir заполняется на стадии %install и плюс к этому хочется
> использовать %doc в %files, обязательно сделать:
>
> %define _customdocdir %_defaultdocdir/%name-%version
>
> и %doc использовать только в одном пакете.  Вместо %doc в %files
> можно раскладывать всю документацию на стадии %install, а в
> %files ссылаться на %_customdocdir/foo (не забываем про %dir
> %%_customdocdir в каждом пакете).

Если я всё верно понял, то примерно где-то так оно и сделано. Ну за
исключением, что %doc всё же в нескольких подпакетах используется,
правда с вкраплениями %exclude

А вот с макросами я так и пойму. Тут из разряда "на вкус и цвет"?
Например у меня используется
%define docdir %_docdir/%name-%version
А где-то видел ещё и $RPM_DOC_DIR в использовании.

Заодно и ещё один момент. Я верно понимаю, что традиция (а может ещё
какие причины?) такова, что если уж и делать %define на каталог, то
хорошо бы в любом случае начинать с "_" ?

--
Артём Золочевский

Re: [newbies] советы по мотивам spec-файла

[Artem Zolochevskiy]

11 октября 2009 г. 13:06 пользователь Michael Shigorin
<mike@osdn.org.ua> написал:
>
>>   * стоит ли ставить зависимость: пакет документации зависит от
>>     пакета самой программы? Каковы тут правила/традиция?
>
> По-моему, хорошая традиция -- это знать меру и не доходить
> до оверинжиниринга. :)  А вообще документацию порой ставят
> и без программы -- на почитать.  Сейчас это скорее редкость,
> но раз уж ты спрашиваешь...

Да да, я потому и спрашиваю. Т.е. мнение за не ставить вообще никаких
зависимостей?
Даже вот как Алексей предлагает?
Conflicts: %name < %version-%release
Conflicts: %name > %version-%release

-- 
Артём Золочевский

Re: [newbies] советы по мотивам spec-файла

[Andrey Rahmatullin]

[-- Attachment #1: Type: text/plain, Size: 573 bytes --]

On Tue, Oct 13, 2009 at 04:38:50PM +0800, REAL wrote:
> > Точно! А что мне такое просто решение в голову не пришло. А то я было
> > думал куда то в недра /usr/share/ эти .py выносить, в а bindir делать
> > симлинки с именами без разширений.
> Тогда уж в %python_sitelibdir :-D
Нет, т.к. это не модули.

-- 
WBR, wRAR (ALT Linux Team)
Powered by the ALT Linux fortune(6):

> [...] новая сборка sendmail для слаки уже есть. А у нас нету,
> тут уж я проверил ;-)
Куда торопиться?  Те, кто пользуются sendmail'ом, обычно никуда не
торопятся.
		-- ldv in devel@

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 490 bytes --]

Re: [newbies] советы по мотивам spec-файла

[REAL]

Artem Zolochevskiy пишет:
> Точно! А что мне такое просто решение в голову не пришло. А то я было
> думал куда то в недра /usr/share/ эти .py выносить, в а bindir делать
> симлинки с именами без разширений.

Тогда уж в %python_sitelibdir :-D

> А вот с макросами я так и пойму. Тут из разряда "на вкус и цвет"?
> Например у меня используется
> %define docdir %_docdir/%name-%version
> А где-то видел ещё и $RPM_DOC_DIR в использовании.

$RPM_DOC_DIR - это уж скорее наследие редхата, когда оттуда попадаются 
спеки, постоянно приходится от подобного мусора избавляться.

> Заодно и ещё один момент. Я верно понимаю, что традиция (а может ещё
> какие причины?) такова, что если уж и делать %define на каталог, то
> хорошо бы в любом случае начинать с "_" ?

Точно не знаю, но, видимо, это для "системных" макросов (тех, что в 
/usr/lib/rpm | /etc/rpm). По крайней мере, в своих спеках макросы на 
каталоги делаю без _.

-- 

REAL aka Евгений Ростовцев, программист ЦНИТ КемГУ

Re: [newbies] советы по мотивам spec-файла

[Alexey I. Froloff]

[-- Attachment #1: Type: text/plain, Size: 1235 bytes --]

On Tue, Oct 13, 2009 at 11:16:38AM +0300, Artem Zolochevskiy wrote:
> >>   * Два питоновских файла: asciidoc.py и a2x.py
> >>   * симлинки на них в этом же какталоге: asciidoc и a2x соовтетсвенно.
> > Расширение .py никому не нужно.  Переименовать.
> Точно! А что мне такое просто решение в голову не пришло.
Когда-то давно rpm-build-python не умел смотреть в шебанг:

* Tue Nov 20 2007 Alexey Tourbin <at@altlinux> 0.33-alt1
- python.req.py: relaxed fatal error condition for possibly non-pythonish
  files; files with *.py suffix or shebang line considered pythonish

> А вот с макросами я так и пойму. Тут из разряда "на вкус и цвет"?
> Например у меня используется
> %define docdir %_docdir/%name-%version
Тут всё очень забавно.  Если в %files есть %doc, то каталог с
документацией удаляется перед обработкой %files и всё что попало
в докдир на стадии %install благополучно херится.  Если определён
макрос %_customdocdir, этого не происходит.

Зато потом, при заполнении этого %_customdocdir в %install и
использовании %doc в разных подпакетах, файлы в этом
%_customdocdir начинают странным образом дублироваться.  Я не
стал разбираться, просто отметил для себя такое поведение.

-- 
Regards,
Sir Raorn.

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 198 bytes --]

Re: [newbies] советы по мотивам spec-файла

[Alexey I. Froloff]

[-- Attachment #1: Type: text/plain, Size: 321 bytes --]

On Tue, Oct 13, 2009 at 11:22:05AM +0300, Artem Zolochevskiy wrote:
> Даже вот как Алексей предлагает?
> Conflicts: %name < %version-%release
> Conflicts: %name > %version-%release
Это означает что пакет %name как бы не требуется, но если он
установлен, то должен быть такой же версии.

-- 
Regards,
Sir Raorn.

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 198 bytes --]

Re: [newbies] советы по мотивам spec-файла

[Michael Shigorin]

On Tue, Oct 13, 2009 at 11:22:05AM +0300, Artem Zolochevskiy wrote:
> >>   * стоит ли ставить зависимость: пакет документации зависит от
> >>     пакета самой программы? Каковы тут правила/традиция?
> > По-моему, хорошая традиция -- это знать меру и не доходить
> > до оверинжиниринга. :)  А вообще документацию порой ставят
> > и без программы -- на почитать.  Сейчас это скорее редкость,
> > но раз уж ты спрашиваешь...
> Да да, я потому и спрашиваю. Т.е. мнение за не ставить вообще
> никаких зависимостей?  Даже вот как Алексей предлагает?
> Conflicts: %name < %version-%release
> Conflicts: %name > %version-%release

Такие можно, если использование не той версии документации
чревато.  По крайней мере не должно помешать, даже если
документация от сборки двухгодичной давности применима
к текущей версии (или наоборот). :)

-- 
 ---- WBR, Michael Shigorin <mike@altlinux.ru>
  ------ Linux.Kiev http://www.linux.kiev.ua/

Re: [newbies] советы по мотивам spec-файла

[Artem Zolochevskiy]

13 октября 2009 г. 11:57 пользователь Alexey I. Froloff
<raorn@altlinux.org> написал:
> On Tue, Oct 13, 2009 at 11:16:38AM +0300, Artem Zolochevskiy wrote:
>> >>   * Два питоновских файла: asciidoc.py и a2x.py
>> >>   * симлинки на них в этом же какталоге: asciidoc и a2x соовтетсвенно.
>> > Расширение .py никому не нужно.  Переименовать.
>> Точно! А что мне такое просто решение в голову не пришло.
> Когда-то давно rpm-build-python не умел смотреть в шебанг:
Хорошо, пришли к тому, что в bindir питоновские скрипты вполне живут и
без расрширения.
Теперь вытекает другой вопрос. Как это лучше организовать то?
Что приходит в голову:
* просто в спеке например сделать mv name.py name
* править апстримный Makefile, чтоб оно автоматом устанавливалось без расширения
Может ещё какие варианты?

Каким путём пойти? Чем руководствоваться?

-- 
Артём Золочевский

Re: [newbies] советы по мотивам spec-файла

[Michael Shigorin]

On Fri, Oct 16, 2009 at 09:49:03AM +0300, Artem Zolochevskiy wrote:
> * просто в спеке например сделать mv name.py name

Ага.

> Чем руководствоваться?

Здравым смыслом, естественно.

-- 
 ---- WBR, Michael Shigorin <mike@altlinux.ru>
  ------ Linux.Kiev http://www.linux.kiev.ua/

Re: [newbies] советы по мотивам spec-файла

[Artem Zolochevskiy]

16 октября 2009 г. 10:11 пользователь Michael Shigorin
<mike@osdn.org.ua> написал:
> On Fri, Oct 16, 2009 at 09:49:03AM +0300, Artem Zolochevskiy wrote:
>> * просто в спеке например сделать mv name.py name
>
> Ага.

Отлично. Так и сделаем. По этой правке остался распоследний вопрос.
Достойно ли отсутствие .py в bindir упоминания в changelog? Смотрел
рекомендации на wiki, не смог самостоятельно определиться.

-- 
Артём Золочевский

Re: [newbies] советы по мотивам spec-файла

[Michael Shigorin]

On Fri, Oct 16, 2009 at 10:20:18AM +0300, Artem Zolochevskiy wrote:
> >> * просто в спеке например сделать mv name.py name
> > Ага.
> Отлично. Так и сделаем. По этой правке остался распоследний
> вопрос.  Достойно ли отсутствие .py в bindir упоминания в
> changelog? Смотрел рекомендации на wiki, не смог самостоятельно
> определиться.

Ну упомяни:

- executables: drop .py suffix

-- 
 ---- WBR, Michael Shigorin <mike@altlinux.ru>
  ------ Linux.Kiev http://www.linux.kiev.ua/

Re: [newbies] советы по мотивам spec-файла

[Timur Batyrshin]

On Fri, 16 Oct 2009 10:20:18 +0300, Artem Zolochevskiy
<artem.zolochevskiy@gmail.com> wrote:
>>> * просто в спеке например сделать mv name.py name
>>
>> Ага.
> 
> Отлично. Так и сделаем. По этой правке остался распоследний вопрос.
> Достойно ли отсутствие .py в bindir упоминания в changelog? Смотрел
> рекомендации на wiki, не смог самостоятельно определиться.

Если сборка не одна из первых (initial build for sisyphus), и программа
запускается преимущественно из командной строки, не из меню -- я бы
упомянул.