FreeBSD ドキュメンテーションプロジェクト: ドキュメントの寄稿
ドキュメンテーションを書きました。どうやって寄稿すれば良いの?
はじめに、 ドキュメンテーションを書く作業に時間を割いてくださったことを感謝します。
レビューのために、ドキュメンテーションを公開する必要があります。 もし可能なら、ドキュメンテーションを FTP やウェブサイトに置いてください。
それから、FreeBSD-doc メーリングリストへドキュメンテーションの概要と公開場所、 コメントの送り先を記したメッセージを投稿してください。
理由があってドキュメントを FTP やウェブサイトにおけないときは、 FreeBSD-doc メーリングリストに直接送って頂いても構いません。 その時はプレインテキストでだけお願いします。
そのメッセージを他の適切なメーリングリストに cc: した方がよい場合も多いでしょう。 例えば、そのドキュメンテーションが、 ソースツリーを最新の状態に保つための CVSup の使用法について言及しているなら、 その内容は FreeBSD-current や FreeBSD-stable メーリングリストの講読者にとっても興味あるものでしょう。
ドキュメンテーションに目が通され、 読者からの提案を組み入れる機会を得たなら、 ドキュメンテーションを寄稿する準備ができたと言えます。
ドキュメンテーションを寄稿する場合、 ファイルを tar 形式にまとめてください。 ドキュメンテーションが one、two、three という三つのファイルから構成されており、 すべてを doc.tar にまとめる場合は、
% tar cf doc.tar one two three
と入力してください。それから tar 形式のファイルを圧縮します。
% gzip -9 doc.tar
doc.tar.gz というファイルが生成されます。
最後にこのファイルがメールプログラムに壊されないようにエンコードします。
% uuencode doc.tar.gz doc.tar.gz > doc.uue
それから、 そのことをドキュメンテーションプロジェクトに知らせる必要があります。 御使用のマシンにもインストールされているはずの send-pr というコマンドを使うのが正しい方法です。 WWW 問題報告フォームを使用してもかまいません。
このコマンドを使うのは、 あなたが寄稿したことを後から確認することができるからです。 PR (Problem Report) を送ると、それぞれに固有な番号が割り当てられます。 その後、Commiter の誰かがその PR を担当し、 新しいドキュメンテーションの commit に関してあなたに連絡することになります。 詳しくは、 FreeBSD 問題報告の書き方を参照してください。
send-pr 自体は非常に単純です。ちょっと特殊な形式の e-mail を特定のアドレスに送るだけだからです。 send-pr を走らせると、エディタ (多分 vi か emacs でしょう) が立ち上がり、 記入用のテンプレートと記入方の説明が表示されるはずです。
"Category" を "docs" に、"Class" を "change-request" に設定してください。先に作っておいた .uue ファイルを PR の本文に含めましょう。
エディタを終了させると、PR は e-mail として正しい場所へ送られます。 いくらもしないうちに、あなたが送った PR の番号を伝える確認のメッセージが送られてくるはずです。 この番号は進展状況を確認するのに使用することができます。
既存のドキュメンテーションに変更を加えました。 どうやって寄稿すれば良いの?
繰り返しになりますが、お時間を割いてくださったことを感謝します。
まず最初に、diff と呼ばれる特殊なファイルを生成する必要があります。 この diff は、あなたが施した変更点を正確にあらわしています。 Diff を使えば、commit を行う人は変更点を容易に知ることができ、 したがって、どこを変更したのか説明するのに時間を浪費しなくてすみます (もちろん、 なぜその変更をした方がよいと考えるのかについては説明する必要があるのですが)。
'diff' をつくるには、
変更するファイルのコピーを作ってください。 もし foo.xml を変更する場合はこうです。
% cp foo.xml foo.xml.oldそれから、foo.xml を変更します。
% vi foo.xml ... えーと、ここをこうして、こう変えて ... ... 変更点を点検して、誤字がないか確認して、むにゃむにゃむにゃ ...diff をつくります。それ用のコマンドは以下のようになります。
% diff -u foo.xml.old foo.xml > foo.diff二つのファイルの相違点を調べ、それらを foo.diff へ書き出します。
プロジェクトへ foo.diff を送ります。 上述したように PR を foo.diff ファイルを PR の本文に含めて送ります。
FreeBSD ドキュメンテーションプロジェクトのページ