Increment `Original revision' value according to

the previous commit for porting.sgml of English version.
This commit is contained in:
Hiroyuki Hanai 1998-07-20 15:17:15 +00:00
parent 3b39d806a8
commit 6616238447
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=3130

View file

@ -1,6 +1,6 @@
<!-- $Id: porting.sgml,v 1.39 1998-07-20 12:12:14 asami Exp $ -->
<!-- $Id: porting.sgml,v 1.40 1998-07-20 15:17:15 hanai Exp $ -->
<!-- The FreeBSD Japanese Documentation Project -->
<!-- Original revision: 1.93 -->
<!-- Original revision: 1.101 -->
<sect1><heading>フリーソフトウェアの移植<label id="porting"></heading>
@ -55,7 +55,7 @@ Makefile
に加えてください.
<tscreen><verb>
#ifdef (defined(__unix__) || defined(unix)) && !defined(USG)
#if (defined(__unix__) || defined(unix)) && !defined(USG)
#include <sys/param.h>
#endif
</verb></tscreen>
@ -247,13 +247,16 @@ A cat chasing a mouse all over the screen
<sect4>
<heading>DESCR</heading>
<p>これは, そのソフトウェアについての, すこし長い説明を記述しま
す. そのportが何をするのかについての数段落程度の簡潔な解説があれば
十分です. 注: このファイルはマニュアルでもなければ, 使用方
法やコンパイル方法についての細かい説明書でもありません. 特
に, <em><tt>README</tt>ファイルを何も考えずにここにコピー
するようなことはしないでください</em>. (もちろん, READMEが
そのソフトウェアの簡潔な説明になっている場合は別ですが.)
<p>これは, そのソフトウェアについての, すこし長い説明を記述
します. その port が何をするのかについての数段落程度の簡潔
な解説があれば十分です. このファイルはマニュアルでもなけれ
ば, 使用方法やコンパイル方法についての細かい説明書でもあり
ません. 特に, <em><tt>README</tt> ファイルや manpage をコ
ピーしようとしてしている場合には注意してください</em>. こ
れらは多くの場合, そのポートの簡潔な説明になっていなかった
り, 扱いにくい形式(manpage の場合, 行を揃えるために空白が
調整されます)になっていたりします. もしこのソフトウエアに
公式の WWW のホームページがあれば, ここに書いて下さい.
<p>このファイルの最後にあなたの名前を書くことが推奨されています.
たとえば, こんな具合です.
@ -264,6 +267,8 @@ the screen.
:
(うんぬん.)
http://www.oneko.org/
- Satoshi
asami@cs.berkeley.edu
</verb></tscreen>
@ -317,20 +322,31 @@ lib/X11/oneko/mouse.xpm
<sect3>
<heading>Portの送付<label id="porting:submitting"></heading>
<p>まず, <ref id="porting:dads" name="やってよいことといけないこと">
についての節を読んでください.
<p>さあ, あなたのportに満足したら, あとはそれをFreeBSDのメイ
ンのportsツリーに置いて, 皆に使ってもらうだけです. そのた
めには, 必要なファイル (この節で述べたすべてのファイル -- た
だし, オリジナルのソースファイル, `<tt>work</tt>' サブディレ
クトリ, およびpackageは含みません) をまとめて
<tt>.tar.gz</tt> ファイルにし,
<tscreen><verb>
ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming/
</verb></tscreen>
へ置き, <tt>send-pr(1)</tt> を使って私たちのところにメールを送っ
てください (categoryは `ports', classは `change-request' を
使ってください).
Packageはこちらで作りますので送っていただく必要はありません.
私たちは, 何か不明な点があったらあなたに確認したのち,
ンの ports ツリーに置いて, 皆に使ってもらうだけです.
いまある <tt>work/</tt> ディレクトリや <tt>pkgname.tgz</tt>
パッケージは必要ありませんから, まず消去してください.
あとは, バグレポートの中に `<tt>shar `find port_dir`</tt>'
の出力を, <tt>send-pr(1)</tt> プログラムを使用して送ってくだ
さい. もし, 圧縮していない状態で, 20KB以上あるようなポートで
あれば, 圧縮して tar ファイルにして, バグレポートに入れる前に
<tt>uuencode(1)</tt> を使用してください. (20KB以下のものでも,
tar ファイルにして送ってもよいですが, あまり歓迎されません).
バクレポートの category は `ports', class は `change-request'
を必ず使用してください.
<p>もう一度, <em>オリジナルのソースファイル, <tt>work/</tt>
ディレクトリ, `<tt>make package</tt>'で作成したパッケージが
含まれていないこと</em>を確認してください.
<p>バグレポートについての詳しい説明は
<ref id="contrib:general" name="バグ報告と一般的な論評">
を見てください.
<p>私たちは, 何か不明な点があったらあなたに確認したのち,
それをツリーへ置きます. あなたの名前は, FreeBSD
ハンドブックやその他のファイルの `Additional FreeBSD
contributors' のリストにも載るでしょう. う~ん, 素晴らし
@ -455,17 +471,20 @@ ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming/
<tt>&dollar;{DISTDIR}</tt> にコピーします. 可能なかぎり, 広
く使われている<em>主流の</em>ソースを使用するようにしてください.
<p>もし, ネットワークへの接続のよいFTP/HTTPサイトを見つけるこ
<p>もし, ネットワークへの接続のよい FTP/HTTP サイトを見つけるこ
とができなかったり, 頭にくるような非標準的な形式しか持ってい
ないサイトしか見つけられないときには, 最後の手段として, 私たち
自身で,
ないサイトしか見つけられないときには, 自分で管理する確実な
HTTP か FTP サイトに置くことができます.
あるいは, あなたが FreeBSD の committer であれば,
自分の <tt>public_html</tt> ディレクトリ置くのが理想的です.
もしも, そのような確実な場所が見つけられなけば, 私たちが
<tscreen><verb>
ftp://ftp.FreeBSD.ORG/pub/FreeBSD/distfiles/LOCAL_PORTS/
</verb></tscreen>
に置くことができます. この場所は, 変数
<tt>&dollar;{MASTER_SITE_LOCAL}</tt> を使って参照してください.
これについての問い合わせのメールは
&a.ports へお願いします.
に置き場所を提供できます. この場所は, 変数
<tt>&dollar;{MASTER_SITE_LOCAL}</tt> を使って参照してくださ
い. これについての問い合わせのメールは &a.ports へお願いしま
す.
<p>もし, あなたのportに必要ないくつかの追加パッチがインター
ネット上で手に入るのならば, それらも取ってきて,
@ -1229,10 +1248,18 @@ diff -u -r1.15 PLIST
そうでなければそのまま PR に入れるだけでいいです.
<sect2>
<heading>やっていいことといけないこと</heading>
<heading>やってよいことといけないこと
<abel id="porting:dads"></heading>
<p>この節では, ソフトウェアをportする上でよくある落し穴などにつ
いて説明します.
いて説明します. このリストを使って, あなた自身が作成した port
のチェックはもとより, PR データベースにある, 他の人が作成した
port のチェックもできます. あなたがチェックした port について
のコメントを
<ref id="contrib:general" name="バグ報告と一般的な論評">
にしたがって, 送ってください. PR データベースにある port を
チェックすることによって, 私達がそれらを commit するのを早くし,
あなたが何をしているか理解していることも示します.
<sect3>
<heading>WRKDIR</heading>
@ -1247,14 +1274,12 @@ diff -u -r1.15 PLIST
リにコピーするようにしてください.
<sect3>
<heading>Package情報</heading>
<heading>Portlint でチェック</heading>
<p>Package情報, すなわち<tt>pkg</tt>ディレクトリ内の
<tt>COMMENT</tt>, <tt>DESCR</tt>, <tt>PLIST</tt>
は必ず用意してください. これらはpackageを作る以
外にもいろいろ使われていますので,
<tt>&dollar;{NO_PACKAGE}</tt>が指定してあってpackageを作
るのが禁止してあるportの場合でも<em>常に必要</em>です.
<p>必ず<tt>portlint</tt>を使いましょう!
<tt><htmlurl url="http://www.freebsd.org/cgi/ports.cgi?portlint"
name="portlint"></tt> プログラムは ports コレクション
に含まれています.
<sect3>
<heading>マニュアルの圧縮, バイナリのstrip</heading>
@ -1555,11 +1580,51 @@ wnn:*:69:7:Wnn:/nonexistent:/nonexistent
ifmail:*:70:66:Ifmail user:/nonexistent:/nonexistent
pgsql:*:71:246:PostgreSQL pseudo-user:/usr/local/pgsql:/bin/sh
msql:*:80:249:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh
alias:*:81:81:QMail user:/var/qmail/alias:/nonexistent
qmaill:*:83:81:QMail user:/var/qmail:/nonexistent
qmaild:*:82:81:QMail user:/var/qmail:/nonexistent
qmailq:*:85:80:QMail user:/var/qmail:/nonexistent
qmails:*:87:80:QMail user:/var/qmail:/nonexistent
qmailp:*:84:81:QMail user:/var/qmail:/nonexistent
qmailr:*:86:80:QMail user:/var/qmail:/nonexistent
</verb></tscreen>
<p>このリストを最新の状態に保つためにもこの範囲の UIDを利用する
portを作った場合には, &a.ports; までご連絡ください.
<sect3>
<heading>合理的な port</heading>
<p>Makefile は単純かつ適切であるべきです. もし, Makefile を
数行短かくできたり, もっと読みやすくできるのであれば, そうし
てください. 例えば, shell の `<tt>if</tt>' 構文を使う代りに,
make の `<tt>.if</tt>' 構文を使う,
<tt>&dollar;{EXTRACT*}</tt>の再定義で代用できるのであれば,
<tt>do-extract</tt>を再定義しない, `<tt>CONFIGURE_ARGS +=
--prefix=&dollar;{PREFIX}</tt>' とするかわりに,
<tt>&dollar;GNU_CONFIGURE</tt> とする, などです.
<sect3>
<heading>CFLAGS の尊重</heading>
<p><tt>&dollar;{CFLAGS}</tt> 変数は尊重すべきです. その port
がこれを無視するのであれば, `<tt>NO_PACKAGE=ignores
cflags</tt>' を Makefile に加えてください.
<sect3>
<heading>その他諸々</heading>
<p><tt>pkg/DESCR</tt>, <tt>pkg/COMMENT</tt>,
<tt>pkg/PLIST</tt> などのファイルは, それぞれ2重にチェックし
てください. 再検討してもっと良い記述があれば, それに置きかえ
てください.
<p>GNU General Public License(GNU一般公有使用許諾)のコピーは
(すでにあるので)コピーしないでください, おねがいします.
<p>法律に関することには, 十分注意をはらってください.
私達に法律に反するような形でソフトフェアの配布をさせない
でください!
<sect3>
<heading>困ったら....</heading>
@ -1690,7 +1755,13 @@ msql:*:80:249:mSQL-2 pseudo-user:/var/db/msqldb:/bin/sh
を使います. 例外はたくさんのプログラムが入っている巨大なport
の場合で, XFree86 (ほんとにあるんですよ) やImageMagickな
どがこれにあたります. そうでない場合には, 名前の大文字を小文
字に (少なくとも最初の一字だけは) 変えてください. また, その
字に (少なくとも最初の一字だけは) 変えてください.
もし, 大文字であることが重要な場合(例えば, 1文字の名前,
R とか V)には, あなたの裁量で大文字を使うのも良いでしょう.
Perl 5 のモジュールでは, 頭に `p5-' を付け, 2重コロン(::)
のセパレータをハイフン(-)に置きかえるしきたりになっています.
例えば, `<tt>Data::Dumper</tt>' は `p5-Data-Dumper'
になります. また, その
ソフトウェアの名前として通常使われるものに番号, ハイフン, あ
るいは下線が入っている場合には, それらを使うことも構いません
(`kinput2' など).