Elõször is, köszönjük hogy erre fordította idejét!
A dokumentációt elérhetõvé kell tennie. Amennyiben lehetõsége van rá, kérjük helyezze el egy FTP vagy webcímen.
Ezt követõen írjon levelet a FreeBSD-doc levelezõlistára, a dokumentáció rövid ismertetõjével és pontos helyére való hivatkozással, majd várjon a visszajelzésre.
Amennyiben valamilyen okból kifolyólag nem áll módjában elhelyezni a dokumentációt FTP vagy webhelyen, elküldheti közvetlenül a FreeBSD-doc levelezõlistára. Ebben az esetben kérjük csak egyszerû szöveges dokumentumokat küldjön.
Elõfordulhat, hogy más levelezõ listákon is megvitatnák a dokumentációt, tehát kérjük továbbítsa azt azokra is. Például egy cikk a CVSup használatáról, arról, hogyan tarthatjuk a forrásainkat frissen, további érdeklõdésre tarthat számot a FreeBSD-current és a FreeBSD-stable listákon is.
Miután a dokumentációját átnézték és lehetõséget kapott, hogy megvitassák, készen áll a közzétételre.
Ehhez nem kell mást tennie, csak csomagolja egy tar fájlba! Amennyiben tehát a dokumentáció három fájlból áll, elso, masodik illetve harmadik, és szeretne egyetlen doc.tar állományt készíteni belõlük, adja ki a következõ parancsot:
% tar cf doc.tar elso masodik harmadik
ami éppen erre való. Ezután tömörítse a tar fájlt az alábbi paranccsal:
% gzip -9 doc.tar
ami elõállítja a doc.tar.gz tömörített állományt.
Végül pedig kódolja az állományt, nehogy egy levelezõprogram jóvoltából darabokra essen.
% uuencode doc.tar.gz doc.tar.gz > doc.uue
Ezt követõen tudatnia kell a Dokumentációs Projekttel az új dokumentáció létezését. Ennek megfelelõ módja a send-pr parancs használata, ami valószínûleg telepítve van a számítógépére. A WWW hibabejelentõ ûrlap is hasznos lehet.
Erre azért van szükség, hogy a felvetés követhetõ legyen. Mikor Ön jelent egy problémát, az egy egyedi azonosítót kap. A bizottság egy tagja ezt követõen magához rendelheti a probléma-jelentést és kapcsolatba léphet Önnel további tárgyalások érdekében. További információkért olvassa el a FreeBSD Probléma-jelentések írása cikket.
A send-pr program meglehetõsen egyszerû. Feladata, hogy megfelelõ formátumú e-mailt küldjön a megfelelõ címre. Mikor elindítja a send-pr programot, az alapértelmezett szövegszerkesztõ (talán a vi vagy az emacs) kerül betöltésre egy kitöltendõ formanyomtatvánnyal és némi segítséggel a kitöltéssel kapcsolatban.
Gyõzõdjön meg róla, hogy a "Category" mezõben a "docs", a "Class" mezõben pedig a "change-request" szerepel, továbbá szükséges, hogy az elõzõleg elkészített .uue állomány tartalmát is beillessze a hibajelentésbe.
A szövegszerkesztõbõl kilépve a hibajelentést a program e-mailként elküldi a megfelelõ helyre. Rövid idõvel ezután értesítést fog kapni a hibajelentés egyedi azonosítójáról, amivel nyomon követheti a probléma-jelenté állapotát.
Elõször is, újra megköszönnénk, hogy erre fordította idejét.
Ebben az esetben készíteni kell egy speciális diff állományt, mely csak az Ön által javasolt változtatásokat tartalmazza. Ez leegyszerûsíti a committer dolgát, hogy átlássa, mit változtatott, és Önnek sem kell hosszan magyaráznia, hogy milyen részleteket változtatott meg (amellett természetesen, hogy megmagyarázza, miért van szükség a javasolt változtatások elvégzésére).
'Diff' állomány készítéséhez a következõket kell tennie:
Készítsen másolatot az eredeti állományról! Mielõ a foo.sgml fájlt módosítja, így készíthet másolatot:
% cp foo.sgml foo.sgml.old
Ezt követõen elvégezheti módosításait a foo.sgml állományon.
% vi foo.sgml ... tap tap tap ... ... tesztelje a módosításokat, olvassa át elírások után kutatva, stb. ...
Készítse el a 'diff'-et! Ehhez adja ki a következõ parancsot:
% diff -u foo.sgml.old foo.sgml > foo.diff
Ez a parancs megvizsgálja a két állomány közötti különbséget, és a foo.diff fájlba írja azokat.
Ezt követõen elküldheti a foo.diff állományt a projekthez. Küldjön probléma-jelentést, ahogy azt elõzõleg már tárgyaltuk, de illessze a foo.diff tartalmát a levél törzsébe!
FreeBSD Dokumentációs Projekt kezdõlap &footer;