210 lines
8.8 KiB
Text
210 lines
8.8 KiB
Text
<!DOCTYPE HTML PUBLIC "-//FreeBSD//DTD HTML 4.01 Transitional-Based Extension//EN" [
|
|
<!ENTITY base CDATA "..">
|
|
<!ENTITY url.articles "../../doc/en_US.ISO8859-1/articles">
|
|
<!ENTITY date "$FreeBSD: www/hu/docproj/submitting.sgml,v 1.4 2008/08/04 20:24:50 pgj Exp $">
|
|
<!ENTITY title "A &os; Dokumentációs Projekt:
|
|
Dokumentáció beküldése">
|
|
<!ENTITY % navinclude.docs "INCLUDE">
|
|
]>
|
|
|
|
<!-- The FreeBSD Hungarian Documentation Project
|
|
Translated by: Peter Terbe <sncdev@gmail.com>
|
|
%SOURCE% en/docproj/submitting.sgml
|
|
%SRCID% 1.18
|
|
-->
|
|
|
|
<html>
|
|
&header;
|
|
|
|
<h2>Hogyan lehet beküldeni dokumentációt?</h2>
|
|
|
|
<p>Elõször is szeretnénk megköszönni,
|
|
hogy erre fordítottuk az idõnket!</p>
|
|
|
|
<p>Az elkészített dokumentációt
|
|
valamilyen módon elérhetõvé kell tenni.
|
|
Amennyiben lehetséges, helyezzünk el egy FTP oldalon
|
|
vagy webcímen.</p>
|
|
|
|
<p>Ezt követõen írjunk levelet a
|
|
<tt>freebsd-doc</tt> levelezési listára, amelyben
|
|
röviden ismertetjük a dokumentációt
|
|
és hivatkozunk a pontos helyére, majd várjunk
|
|
a visszajelzésre.</p>
|
|
|
|
<p>Amennyiben valamilyen okból kifolyólag nem
|
|
áll módunkban elhelyezni a dokumentációt
|
|
FTP vagy webhelyen, közvetlenül is
|
|
elküldhetjük a <tt>freebsd-doc</tt> levelezési
|
|
lista címére is. Ebben az esetben viszont
|
|
lehetõleg csak egyszerû szöveges dokumentumokat
|
|
küldjünk.</p>
|
|
|
|
<p>Elõfordulhat, hogy más levelezési
|
|
listákon is megvitatnák a dokumentációt,
|
|
tehát érdemes azokra is elküldeni egy
|
|
másolatot belõle. Például egy olyan
|
|
cikk, amely arról szól, hogy a CVSup hogyan
|
|
tarthatjuk a forrásainkat frissen, további
|
|
érdeklõdésre tarthat számot a
|
|
<tt>freebsd-current</tt> és a <tt>freebsd-stable</tt>
|
|
listákon is.</p>
|
|
|
|
<p>Miután a dokumentációt
|
|
átnézték, tegyünk eleget a vele
|
|
kapcsolatban beérkezett javaslatoknak, és már
|
|
készen is áll a közzétételre.</p>
|
|
|
|
<p>Ehhez nem kell mást tennünk, csak csomagoljuk be egy
|
|
tar állományba. Ha például
|
|
tehát a dokumentáció három
|
|
állományból áll, mint az
|
|
<tt>elso</tt>, <tt>masodik</tt>, illetve <tt>harmadik</tt>,
|
|
és ezekbõl szeretnénk egyetlen <tt>doc.tar</tt>
|
|
állományt készíteni, akkor adjuk ki az
|
|
ehhez szükséges parancsot:</p>
|
|
|
|
<pre>
|
|
% <b>tar cf doc.tar elso masodik harmadik</b>
|
|
</pre>
|
|
|
|
<p>Ezután tömörítsük az így
|
|
kapott tar állományt az alábbi paranccsal:</p>
|
|
|
|
<pre>
|
|
% <b>gzip -9 doc.tar</b>
|
|
</pre>
|
|
|
|
<p>Így elõáll a <tt>doc.tar.gz</tt>
|
|
tömörített állomány.</p>
|
|
|
|
<p>Végül pedig kódoljuk az
|
|
állományt, nehogy véletlenül egy
|
|
levelezõprogram szétcincálja.</p>
|
|
|
|
<pre>
|
|
% <b>uuencode doc.tar.gz doc.tar.gz > doc.uue</b>
|
|
</pre>
|
|
|
|
<p>Ezt követõen tudatnunk kell a
|
|
Dokumentációs Projekttel az új
|
|
dokumentáció létezését. Ennek
|
|
megfelelõ módja a <b>send-pr</b> parancs
|
|
használata, amely valószínûleg
|
|
már el is érhetõ a
|
|
számítógépünkön. Erre
|
|
viszont a <a href="&base;/send-pr.html">hibajelentõ
|
|
ûrlapot</a> is használhatjuk.</p>
|
|
|
|
<p>Erre azért van szükség, hogy a munka
|
|
követhetõ legyen. Mikor jelentünk egy
|
|
problémát, az egy egyedi azonosítót
|
|
kap. Valamelyik committer ezt követõen magához
|
|
rendeli a hibajelentést és a részletek
|
|
tisztázása érdekében felveszi
|
|
velünk a kapcsolatot. Erre vonatkozóan olvassuk el a
|
|
<a
|
|
href="&url.articles;/problem-reports/">&os; hibajelentések írása</a>
|
|
címû cikket.</p>
|
|
|
|
<p>A <b>send-pr</b> program meglehetõsen egyszerû.
|
|
Feladata, hogy egy megfelelõ formátumú e-mailt
|
|
küldjön a megfelelõ címre. Mikor
|
|
elindítjuk a <b>send-pr</b> programot, az
|
|
alapértelmezett szövegszerkesztõ (a <b>vi</b>
|
|
vagy az <b>emacs</b>) kerül betöltésre egy
|
|
kitöltendõ formanyomtatvánnyal és a
|
|
kitöltést elõsegítõ kevés
|
|
leírással.</p>
|
|
|
|
<p>Gyõzõdjünk 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 <tt>.uue</tt> állomány
|
|
tartalmát is beillesszünk a hibajelentésbe.</p>
|
|
|
|
<p>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
|
|
tudjuk követni a beküldés hibajelentés
|
|
állapotát.</p>
|
|
|
|
<h2>Hova lehet küldeni a már létezõ
|
|
dokumentációkon végzett
|
|
módosításokat?</h2>
|
|
|
|
<p>Elõször is ismét megköszönnénk,
|
|
hogy erre fordítottuk az idõt.</p>
|
|
|
|
<p>Ebben az esetben készíteni kell egy
|
|
speciális <i>diff</i> állományt, amely csak az
|
|
általunk javasolt változtatásokat
|
|
tartalmazza. Ez leegyszerûsíti a committer
|
|
dolgát, mivel így könnyebben
|
|
átlátja, hogy mit szeretnénk
|
|
változtatni, és nekünk sem kell hosszasan
|
|
magyaráznunk, hogy milyen részleteket írtunk
|
|
át (amellett természetesen, hogy megindokoljuk,
|
|
miért van szükség a javasolt
|
|
változtatások elvégzésére).</p>
|
|
|
|
<p>A 'diff' állomány
|
|
készítéséhez a következõket
|
|
kell tennünk:</p>
|
|
|
|
<ol>
|
|
<li>
|
|
<p>Készítsünk másolatot az eredeti
|
|
állományról. Mielõtt az
|
|
<tt>ize.sgml</tt> állományt
|
|
módosítanánk, végezzük el a
|
|
következõ mûveletet:</p>
|
|
|
|
<pre>
|
|
% <b>cp ize.sgml ize.sgml.eredeti</b>
|
|
</pre>
|
|
</li>
|
|
|
|
<li>
|
|
<p>Ezt követõen végezzük el a
|
|
kívánt módosításokat az
|
|
ize.sgml állományon.</p>
|
|
|
|
<pre>
|
|
% <b>vi foo.sgml</b>
|
|
... tap tap tap ...
|
|
... teszteljük a módosításokat, nézzük át, nehogy
|
|
elírás maradjon benne stb. ...
|
|
</pre>
|
|
</li>
|
|
|
|
<li>
|
|
<p>Készítsük el a diffet. Ehhez a
|
|
következõ parancsot kell kiadnunk:</p>
|
|
|
|
<pre>
|
|
% <b>diff -u ize.sgml.eredeti ize.sgml > ize.diff</b>
|
|
</pre>
|
|
|
|
<p>A program megvizsgálja a két
|
|
állomány közti eltéréseket,
|
|
és az <tt>ize.diff</tt> állományba
|
|
írja azokat.</p>
|
|
</li>
|
|
</ol>
|
|
|
|
<p>Ezután már küldhetjük is az
|
|
<tt>ize.diff</tt> állományt a projektnek. Az
|
|
elõzõleg tárgyaltaknak megfelelõen
|
|
írjunk egy hibajelentést, de a levél
|
|
törzsébe az <tt>ize.diff</tt> tartalmát
|
|
illesszük.</p>
|
|
|
|
<a
|
|
href="docproj.html">A &os; Dokumentációs Projekt kezdõlap</a>
|
|
|
|
&footer;
|
|
</html>
|