166 lines
6.1 KiB
Text
166 lines
6.1 KiB
Text
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN" [
|
|
<!ENTITY base CDATA "..">
|
|
<!ENTITY date "$FreeBSD: www/ja/docproj/submitting.sgml,v 1.6 1999/12/18 05:13:28 kuriyama Exp $">
|
|
<!ENTITY title "FreeBSD Documentation Project: Submitting documentation">
|
|
<!ENTITY % rev.incl SYSTEM "submitting.revinc"> %rev.incl;
|
|
<!ENTITY % includes SYSTEM "../includes.sgml"> %includes;
|
|
]>
|
|
<!-- $FreeBSD: www/ja/docproj/submitting.sgml,v 1.6 1999/12/18 05:13:28 kuriyama Exp $ -->
|
|
<!-- The FreeBSD Japanese Documentation Project -->
|
|
<!-- Original revision: 1.5 -->
|
|
|
|
<html>
|
|
&header;
|
|
|
|
<h2>ドキュメンテーションを書きました. どうやって寄稿すれば良いの?</h2>
|
|
|
|
<p>はじめに,
|
|
ドキュメンテーションを書く作業に時間を割いてくださったことを感謝します.
|
|
</p>
|
|
|
|
<p>レビューのために, ドキュメンテーションを公開する必要があります.
|
|
もし可能なら, ドキュメンテーションを FTP や Web のサイトに置いてください.
|
|
もしご自分の FTP あるいは Web サイトをお持ちでない場合は,
|
|
ドキュメンテーションを
|
|
<a href="ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming/">
|
|
ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming/</a>
|
|
へアップロードし, <b>send-pr</b> (あとで説明します)
|
|
を使って, ドキュメンテーションを公開してくれるように
|
|
commiter の誰かにお願いしてください.
|
|
</p>
|
|
|
|
<p>それから, -doc メーリングリストへドキュメンテーションの概要と公開場所,
|
|
コメントの送り先を記したメッセージを投稿してください.</p>
|
|
|
|
<p>そのメッセージを他の適切なメーリングリストに cc:
|
|
した方がよい場合も多いでしょう.
|
|
例えば, そのドキュメンテーションが,
|
|
ソースツリーを最新の状態に保つための CVSup
|
|
の使用法について言及しているなら,
|
|
その内容は <tt>FreeBSD-current</tt> や <tt>FreeBSD-stable</tt>
|
|
メーリングリストの講読者にとっても興味あるものでしょう.</p>
|
|
|
|
<p>ドキュメンテーションに目が通され,
|
|
読者からの提案を組み入れる機会を得たなら,
|
|
ドキュメンテーションを寄稿する準備ができたと言えます.</p>
|
|
|
|
<p>ドキュメンテーションを寄稿する場合,
|
|
ファイルを tar 形式にまとめてください.
|
|
ドキュメンテーションが <tt/one/, <tt/two/, <tt/three/
|
|
という三つのファイルから構成されており,
|
|
すべてを <tt/doc.tar/ にまとめる場合は,</p>
|
|
|
|
<pre>
|
|
% <b>tar cf doc.tar one two three</b>
|
|
</pre>
|
|
|
|
<p>と入力してください. それから tar 形式のファイルを圧縮します.</p>
|
|
|
|
<pre>
|
|
% <b>gzip -9 doc.tar</b>
|
|
</pre>
|
|
|
|
<p><tt>doc.tar.gz</tt> というファイルが生成されます.</p>
|
|
|
|
<p>次に, <tt/doc.tar.gz/ (もちろん,
|
|
もっとわかりやすい名前をつけてください. しかし, <tt/.tar.gz/
|
|
の部分は変更してはいけません) を
|
|
<tt/ftp.FreeBSD.org/ の <tt>/pub/FreeBSD/incoming/</tt>
|
|
ディレクトリにアップロードする必要があります.</p>
|
|
|
|
<p>それから,
|
|
そのことをドキュメンテーションプロジェクトに知らせる必要があります.
|
|
御使用のマシンにもインストールされているはずの
|
|
<b>send-pr</b> というコマンドを使うのが正しい方法です.</p>
|
|
|
|
<p>このコマンドを使うのは,
|
|
あなたが寄稿したことを後から確認することができるからです.
|
|
PR (Problem Report) を送ると, それぞれに固有な番号が割り当てられます.
|
|
その後, Commiter の誰かがその PR を担当し,
|
|
新しいドキュメンテーションの commit
|
|
に関してあなたに連絡することになります.</p>
|
|
|
|
<p><b>send-pr</b> 自体は非常に単純です. ちょっと特殊な形式の e-mail
|
|
を特定のアドレスに送るだけだからです.
|
|
<b>send-pr</b> を走らせると, エディタ (多分 <b>vi</b> か
|
|
<b>emacs</b> でしょう) が立ち上がり,
|
|
記入用のテンプレートと記入方の説明が表示されるはずです.</p>
|
|
|
|
<p>"Category" を "docs" に, "Class" を "change-request"
|
|
に設定してください. Commiter がファイルを見つけられるように,
|
|
アップロードしたファイルの名前を書いておくのをお忘れなく!</p>
|
|
|
|
<p>エディタを終了させると, PR は e-mail として正しい場所へ送られます.
|
|
いくらもしないうちに, あなたが送った PR
|
|
の番号を伝える確認のメッセージが送られてくるはずです.
|
|
この番号は進展状況を確認するのに使用することができます.</p>
|
|
|
|
<p>また,
|
|
<a href="http://www.FreeBSD.org/send-pr.html">
|
|
http://www.FreeBSD.org/send-pr.html</a>
|
|
の web インタフェースを使用することもできます.</p>
|
|
|
|
<h2>既存のドキュメンテーションに変更を加えました.
|
|
どうやって寄稿すれば良いの?</h2>
|
|
|
|
<p>繰り返しになりますが, お時間を割いてくださったことを感謝します.</p>
|
|
|
|
<p>まず最初に, <i>diff</i>
|
|
と呼ばれる特殊なファイルを生成する必要があります.
|
|
この diff は, あなたが施した変更点を正確にあらわしています.
|
|
Diff を使えば, commit を行う人は変更点を容易に知ることができ,
|
|
したがって, どこを変更したのか説明するのに時間を浪費しなくてすみます
|
|
(もちろん,
|
|
なぜその変更をした方がよいと考えるのかについては説明する必要があるのですが).
|
|
</p>
|
|
|
|
<p>'diff' をつくるには,</p>
|
|
|
|
<ol>
|
|
<li><p>変更するファイルのコピーを作ってください.
|
|
もし <tt/foo.sgml/ を変更する場合はこうです.</p>
|
|
|
|
<pre>
|
|
% <b>cp foo.sgml foo.sgml.old</b>
|
|
</pre></li>
|
|
|
|
<li><p>それから, foo.sgml を変更します.</p>
|
|
|
|
<pre>
|
|
% <b>vi foo.sgml</b>
|
|
... えーと, ここをこうして, こう変えて ...
|
|
|
|
... 変更点を点検して, 誤字がないか確認して, むにゃむにゃむにゃ ...
|
|
</pre></li>
|
|
|
|
<li><p>diff をつくります. それ用のコマンドは以下のようになります.</p>
|
|
|
|
<pre>
|
|
% <b>diff -c foo.sgml.old foo.sgml > foo.diff</b>
|
|
</pre>
|
|
|
|
<p>二つのファイルの相違点を調べ, それらを <tt/foo.diff/
|
|
へ書き出します.</p></li>
|
|
</ol>
|
|
|
|
<p>プロジェクトへ <tt/foo.diff/ を送ります.</p>
|
|
|
|
<p><tt/foo.diff/ ファイルは FTP で
|
|
<a href="ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming/">
|
|
ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming/</a>
|
|
へ送ることもできますし,
|
|
もし diff が (誤字の訂正のように) 非常に小さいものである場合は,
|
|
直接 PR の "Fix:" セクションに記入されても結構です.</p>
|
|
|
|
<p>どちらの場合でも, やはり <b>send-pr</b> を使用して,
|
|
commiter に変更点を知らせる必要があります.
|
|
その場合, "Category" を "docs" に, "Class" を
|
|
"doc-bug" (誤字のような問題を変更した場合) か
|
|
"change-request" (新しい情報を既存のセクションに加えた場合) に
|
|
設定してください.</p>
|
|
|
|
<p></p><a href="docproj.html">FreeBSD
|
|
ドキュメンテーションプロジェクトのページ</a>
|
|
&footer
|
|
</body>
|
|
</html>
|