polityczno-techniczny problem z %doc

[Arkadiusz Miskiewicz]

Mamy z Tomkiem taki drobny, nie bardzo wiadomo czy polityczny,
czy bardziej techniczny, aczkolwiek często powracający problem,
a mianowicie podział dokumentacji (trafiającej tylko i wyłącznie
do %doc). Sprawa dotyczy głównie pakietów w których następuje
podział na podpakiety główny oraz -devel.

Nie wiemy które pliki dokumentacji umieszczać w którym podpakiecie
i chodzi tu o takie pliki jak: README, NEWS, AUTHORS, CREDITS, TODO
BUGS, ChangeLog, HISTORY (te się najczęściej pojawiają) oraz jakieś
inne pliki zawierające jakieś opisy itp.

Problem nie dotyczy dokumentacji typowo programistycznej czyli np.
opis API jakiejś biblioteki bo jest oczywiste, że taka dokumentacja
ląduje w -devel.

Są oczywiście różne za i przeciw umieszczaniu konkretnych plików
w konkretnych podpakietach (base czy devel) i tak:

README
inne pliki
	wszystko zależy od zawartości
NEWS
ChangeLog
	z jednej strony jest to informacja dla programisty, który
	w takim wypadku będzie instalował podpakiet -devel, a z kolei
	z drugiej strony zwykły użytkownik też może interesować
	się informacjami o zmianach w konkretnych programie/bibliotece
AUTHORS
CREDITS
	?
HISTORY
	?
TODO
BUGS
	I znów z jednej strony informacja dla potencjalnych developerów,
	którzy mogą chcieć zająć się dodawaniem rzeczy z TODO, poprawianiem
	z BUGS oraz z drugiej strony informacja dla użytkownika o tym
	jakie błędy są w pakiecie i jakich features może się spodziewać
	w przyszłych wersjach programu.

Czy wogóle warto debatować nad tym problemem. W końcu te pliki zajmują niewiele
miejsca, a selekcjonowanie plików wg ich zawartości przyspoży tylko dodatkowej
pracy w czasie tworzenia pakietu. Z kolei z drugiego końca - ważną sprawą
jest mała objętość pakietów bazowych, a tak kb do kb i uzbiera się XYZ MB
dokumentacji co już nie jest tak od razu do ,,przełknięcia''. Można wrzucić
całą dokumentację do devel ale to znów wymusza na użytkowniu instalowanie
-devel po to by dowiedzieć się np. co się zmieniło (ChangeLog) ale z kolei
oszczędza dużo miejsca na czysto produkcyjnym systemie (brak jakichkolwiek -devel).

Zastanówcie się nad tym z pozoru błachym problemem, wymyślcie jakieś własne
za i przeciw i co istotne uszeregujcie je wag bo w końcu co jest np. ważniejsze:
zajętość miejsca w pewnych sytuacjach czy posiadanie dokumentacji w base?

Trzeba to w końcu ustalić bo teraz każdy sobie rzepkę skrobie.

ps. jeszcze raz zwracam uwagę, że sprawa nie dotyczy dokumentacji typowo
developerskiej i takiej, którą bez żadnych wątpliwości można uszeregować
w jednej z grup: developerskiej (-devel) czy nie (base).

Z cyklu rozważań nocnych,
-- 
Arkadiusz Miśkiewicz, AM2-6BONE    [ PLD GNU/Linux IPv6 ]
http://www.t17.ds.pwr.wroc.pl/~misiek/ipv6/   [ enabled ]