eeeafee1f8
- Fix typos (tested with hungarian/hunspell) - Fix links (W3C Link Checker) Submitted by: gabor
197 lines
8.4 KiB
Text
197 lines
8.4 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.1 2007/01/07 22:44:47 keramida Exp $">
|
|
<!ENTITY title "FreeBSD 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>
|
|
Original Revision: r1.18 -->
|
|
|
|
<html>
|
|
&header;
|
|
|
|
<h2>Írtam néhány dokumentációt. Hogyan
|
|
nyújthatom be közlésre?</h2>
|
|
|
|
<p>Elõször is, köszönjük hogy erre fordította
|
|
idejét!</p>
|
|
|
|
<p>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.</p>
|
|
|
|
<p>Ezt követõen írjon levelet a <tt>FreeBSD-doc</tt>
|
|
levelezõlistára, a dokumentáció rövid
|
|
ismertetõjével és pontos helyére való
|
|
hivatkozással, majd várjon a visszajelzésre.</p>
|
|
|
|
<p>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 <tt>FreeBSD-doc</tt>
|
|
levelezõlistára. Ebben az esetben kérjük csak
|
|
egyszerû szöveges dokumentumokat küldjön.</p>
|
|
|
|
<p>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
|
|
<tt>FreeBSD-current</tt> és a <tt>FreeBSD-stable</tt>
|
|
listákon is.</p>
|
|
|
|
<p>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.</p>
|
|
|
|
<p>Ehhez nem kell mást tennie, csak csomagolja egy tar
|
|
fájlba! Amennyiben tehát a dokumentáció
|
|
három fájlból áll, <tt>elso</tt>,
|
|
<tt>masodik</tt> illetve <tt>harmadik</tt>, és szeretne egyetlen
|
|
doc.tar állományt készíteni
|
|
belõlük, adja ki a következõ parancsot:</p>
|
|
|
|
<pre>
|
|
% <b>tar cf doc.tar elso masodik harmadik</b>
|
|
</pre>
|
|
|
|
<p>ami éppen erre való. Ezután
|
|
tömörítse a tar fájlt az alábbi
|
|
paranccsal:</p>
|
|
|
|
<pre>
|
|
% <b>gzip -9 doc.tar</b>
|
|
</pre>
|
|
|
|
<p>ami elõállítja a <tt>doc.tar.gz</tt>
|
|
tömörített állományt.</p>
|
|
|
|
<p>Végül pedig kódolja az állományt,
|
|
nehogy egy levelezõprogram jóvoltából
|
|
darabokra essen.</p>
|
|
|
|
<pre>
|
|
% <b>uuencode doc.tar.gz doc.tar.gz > doc.uue</b>
|
|
</pre>
|
|
|
|
<p>Ezt követõen tudatnia 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, ami
|
|
valószínûleg telepítve van a
|
|
számítógépére. A
|
|
<a href="&base;/send-pr.html">WWW hibabejelentõ ûrlap</a>
|
|
is hasznos lehet.</p>
|
|
|
|
<p>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
|
|
<a href="&url.articles;/problem-reports/">FreeBSD
|
|
Probléma-jelentések írása</a>
|
|
cikket.</p>
|
|
|
|
<p>A <b>send-pr</b> program meglehetõsen egyszerû. Feladata,
|
|
hogy megfelelõ formátumú e-mailt küldjön a
|
|
megfelelõ címre. Mikor elindítja a <b>send-pr</b>
|
|
programot, az alapértelmezett szövegszerkesztõ
|
|
(talán a <b>vi</b> vagy az <b>emacs</b>) kerül
|
|
betöltésre egy kitöltendõ
|
|
formanyomtatvánnyal és némi
|
|
segítséggel a kitöltéssel kapcsolatban.</p>
|
|
|
|
<p>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 <tt>.uue</tt>
|
|
állomány tartalmát is beillessze 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 követheti
|
|
a probléma-jelenté állapotát.</p>
|
|
|
|
<h2>Néhány már létezõ
|
|
dokumentáción végeztem
|
|
változtatásokat, ezeket hova küldhetem?</h2>
|
|
|
|
<p>Elõször is, újra megköszönnénk, hogy
|
|
erre fordította idejét.</p>
|
|
|
|
<p>Ebben az esetben készíteni kell egy speciális
|
|
<i>diff</i> á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).</p>
|
|
|
|
<p>'Diff' állomány készítéséhez
|
|
a következõket kell tennie: </p>
|
|
|
|
<ol>
|
|
<li>
|
|
<p>Készítsen másolatot az eredeti
|
|
állományról! Mielõ a <tt>foo.sgml</tt>
|
|
fájlt módosítja, így
|
|
készíthet másolatot:</p>
|
|
|
|
<pre>
|
|
% <b>cp foo.sgml foo.sgml.old</b>
|
|
</pre>
|
|
</li>
|
|
|
|
<li>
|
|
<p>Ezt követõen elvégezheti
|
|
módosításait a foo.sgml
|
|
állományon.</p>
|
|
|
|
<pre>
|
|
% <b>vi foo.sgml</b>
|
|
... tap tap tap ...
|
|
... tesztelje a módosításokat, olvassa át
|
|
elírások után kutatva, stb. ...
|
|
</pre>
|
|
</li>
|
|
|
|
<li>
|
|
<p>Készítse el a 'diff'-et! Ehhez adja ki a
|
|
következõ parancsot:</p>
|
|
|
|
<pre>
|
|
% <b>diff -u foo.sgml.old foo.sgml > foo.diff</b>
|
|
</pre>
|
|
|
|
<p>Ez a parancs megvizsgálja a két
|
|
állomány közötti
|
|
különbséget, és a <tt>foo.diff</tt>
|
|
fájlba írja azokat.</p>
|
|
</li>
|
|
</ol>
|
|
|
|
<p>Ezt követõen elküldheti a <tt>foo.diff</tt>
|
|
állományt a projekthez. Küldjön
|
|
probléma-jelentést, ahogy azt elõzõleg
|
|
már tárgyaltuk, de illessze a <tt>foo.diff</tt>
|
|
tartalmát a levél törzsébe!</p>
|
|
|
|
<a href="docproj.html">FreeBSD Dokumentációs Projekt kezdõlap</a>
|
|
|
|
&footer;
|
|
|
|
</html>
|