Gruby perl

[Radoslaw Zielinski]

[[ Tomasz Kłoczko <kloczek w rudy.mif.pg.gda.pl> ]]:
>> $ man -w perl
>> /usr/share/man/man1/perl.1.gz
>> $ perldoc -l perl
>> /usr/lib/perl5/5.6.1/pod/perl.pod

>> Dają dokładnie to samo. Podobnie ze wszystkimi modułami. Z tym że w
>> przypadku modułów dokumentacja jest ich częścią, więc pliki man są
>> nadmiarowe.

Ale man jest o rząd wielkości szybszy (dla mnie to istotne, często te
many odpalam):

$ time perldoc perl > /dev/null
perldoc perl > /dev/null  1,16s user 0,10s system 99% cpu 1,260 total

$ time man perl > /dev/null    
man perl > /dev/null  0,16s user 0,06s system 98% cpu 0,223 total

> W zasadzie teraz pakiet z podami mógłby już zniknąć.

Nie mógłby, bo perldoc -f i -q przestanie działać.

> Tak wogóle to ktoś wie może jak prosto wycinać z plików z modułami
> dokumentację (która jest jzu w manach) ?
> Coś takiego możnaby robić w %__install_post.

Tego nie wolno robić!  Trochę zabrakło mi słów, jak to zobaczyłem, ale
na comp.lang.perl.misc na pewno jest paru bardziej wygadanych odemnie,
którzy Ci ten pomysł z głowy wybiją (uwaga, mogą używać określenia
,,insane'' i podobnych).

W czym _mnie_ to przeszkadza?  Po pierwsze, często sprawdzam, czy
dokumentacja zgadza się z kodem i szukam źródeł błędów, lub po prostu
patrzę na zastosowane rozwiązania.  Dokumentacja często wygląda tak:


- -- - - - - - - -- --- --- -  -- - -- -  - --  -- -  -- -- -
=head1 NAME

nazwa, krótki opis

=head1 SYNOPSIS

.....

=cut

[ początek kodu ]

=head1 METHODS/FUNCTIONS

=over

=item funkcja

opis funkcji

=cut
sub funkcja {
    [ treść funkcji ]
}

=item funkcja2
[ reszta funkcji ]

=cut

=back

[ funkcje bez opisów i reszta dokumentacji ]
- -- - - - - - - -- --- --- -  -- - -- -  - --  -- -  -- -- -


Dobrze osadzone POD-y zastępują komentarze.  Bez nich, mam przechlapane;
nawet nie chcę sobie wyobrażać, ile dłużej zajmowałoby znalezienie
odpowiedniego kawałka kodu.

Druga sprawa: zdarza mi się podsyłać autorom patche, a do tego
potrzebuję oryginalnych wersji modułów.

Po trzecie: napisz takie rozwiązanie, a ja podam Ci przykład, w którym
się nie sprawdzi.



Reasumując: zostawcie tę dokumentację w spokoju.  Możnaby co najwyżej
wyrzucić manuale do osobnego pakietu, ale nie wydaje mi się to dobrym
pomysłem -- jak ktoś nie chce, zrobi --excludedocs, a liczba tych,
którzy mieliby o jeden pakiet do ściągania mniej nie zrównoważy liczby
nieprzyjemnie zdziwionych.

-- 
Radosław Zieliński <radek w karnet.pl>
[ GPG key: http://radek.karnet.pl/ ]
-------------- następna część ---------
Załącznik, który nie był tekstem został usunięty...
Name: nie znany
Type: application/pgp-signature
Size: 189 bytes
Desc: nie znany
Url : /mailman/pipermail/pld-devel-pl/attachments/20040626/12c41bba/attachment.bin