From owner-svn-doc-head@FreeBSD.ORG Thu Oct 18 13:29:09 2012 Return-Path: Delivered-To: svn-doc-head@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [69.147.83.52]) by hub.freebsd.org (Postfix) with ESMTP id 2C6F813B; Thu, 18 Oct 2012 13:29:09 +0000 (UTC) (envelope-from ryusuke@FreeBSD.org) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:4f8:fff6::2c]) by mx1.freebsd.org (Postfix) with ESMTP id 12ABB8FC08; Thu, 18 Oct 2012 13:29:09 +0000 (UTC) Received: from svn.freebsd.org (localhost [127.0.0.1]) by svn.freebsd.org (8.14.4/8.14.4) with ESMTP id q9IDT9MX046658; Thu, 18 Oct 2012 13:29:09 GMT (envelope-from ryusuke@svn.freebsd.org) Received: (from ryusuke@localhost) by svn.freebsd.org (8.14.4/8.14.4/Submit) id q9IDT8uf046656; Thu, 18 Oct 2012 13:29:08 GMT (envelope-from ryusuke@svn.freebsd.org) Message-Id: <201210181329.q9IDT8uf046656@svn.freebsd.org> From: Ryusuke SUZUKI Date: Thu, 18 Oct 2012 13:29:08 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r39766 - head/ja_JP.eucJP/books/porters-handbook X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 18 Oct 2012 13:29:09 -0000 Author: ryusuke Date: Thu Oct 18 13:29:08 2012 New Revision: 39766 URL: http://svn.freebsd.org/changeset/doc/39766 Log: - Merge the following from the English version: r19736 -> r20257 head/ja_JP.eucJP/books/porters-handbook/book.sgml Submitted by: Hiroo Ono References: [doc-jp-work 1810, 1828, 1830, 1842, 1846] Modified: head/ja_JP.eucJP/books/porters-handbook/book.xml Modified: head/ja_JP.eucJP/books/porters-handbook/book.xml ============================================================================== --- head/ja_JP.eucJP/books/porters-handbook/book.xml Thu Oct 18 13:10:08 2012 (r39765) +++ head/ja_JP.eucJP/books/porters-handbook/book.xml Thu Oct 18 13:29:08 2012 (r39766) @@ -9,7 +9,7 @@ The FreeBSD Documentation Project The FreeBSD Japanese Documentation Project - Original revision: r19736 + Original revision: r20257 $FreeBSD$ --> @@ -379,9 +379,22 @@ lib/X11/oneko/mouse.xpm また、port 化したプログラムの短い説明文を バグレポートの Description フィールドに追加して、 Fix フィールドには shar したファイル、 - もしくは uuencode した tar ファイルを追加するようにしてください。 - 後者は、ports 管理の作業をスクリプトで行なっている - コミッターの助けとなります。 + もしくは uuencode した + tar ファイルを追加するようにしてください。 + + + 障害報告の概要 (synopsis) 欄がよく書けていると、 + わたしたちが作業しやすくなります。 + 新しい port を提出するなら + New port: <カテゴリ>/<port 名> + <短い port の概要>、 + port の更新なら、 + Update port: <カテゴリ>/<port 名> + <短い更新の概要> + のような形が歓迎されます。 + この考え方に沿っていれば、 + 誰かがあなたの障害報告を時間をおかずに見てくれる可能性が高くなります。 + もう一度、オリジナルのソースファイルや work ディレクトリ、 @@ -410,18 +423,6 @@ lib/X11/oneko/mouse.xpm FreeBSD への貢献者の一覧やその他のファイルにも載るでしょう。 う〜ん、素晴らしい。:-) - - - わたしたちが作業しやすいように、 - 障害報告の概要 (synopsis) は適切に記述してください。 - たとえば新しい port の提出なら - New port: <port の簡単な説明>、 - port の更新なら - Update port: <カテゴリ>/<port 名> <更新内容の簡単な説明> - といった形式が歓迎されます。 - こういう方法で報告するように心がけていれば、あなたの報告 (PR) が - すぐに誰かの目にとまる確率が ぐっと高くなるのです。 - @@ -847,7 +848,11 @@ lib/X11/oneko/mouse.xpm 新しいオフィシャルベンダーリリースが行なわれた時) には いつでも 0 にリセットされます。 また、その値が 0 でない場合には package 名に追加されます。 - その port から作られる package の内容や構造に + PORTREVISION の変更は、(例えば + &man.pkg.version.1; 等の) 自動化ツールが、 + 新たな package が入手できることを示すのに使われます。 + + その port から作られる package の内容や構造に 大きな影響を与える変更を行なった時には、 PORTREVISION を増やしてください。 @@ -857,7 +862,7 @@ lib/X11/oneko/mouse.xpm セキュリティ上の脆弱性やバグを修正するため、または - その port に新しい機能性を追加するためのパッチの追加。 + その port に新しい機能を追加するためのパッチの追加。 @@ -919,9 +924,10 @@ lib/X11/oneko/mouse.xpm ビルド可能にするための修正 (その port が以前にビルド可能だった プラットフォームにおいて、その変更により何らかの機能的な 違いが発生しない場合に限ります)。 - PORTREVISION は package の内容を - 反映したものなので、その package が以前にビルド可能でなければ - 内容の変更も無いため、PORTREVISION を + PORTREVISION は package + の内容を反映したものなので、その package + が以前にビルド可能でなかったのなら、変更を示すために、 + PORTREVISION を 増やす必要はありません。 @@ -931,9 +937,7 @@ lib/X11/oneko/mouse.xpm 実質的な効能であれ)、アップデートすることにより、 誰もが利益を受けるような何かかどうか、また定期的に ports ツリーを更新している人に更新を強制するということに値するか自問してみることです。 - もし答がイエスであれば、新しい package - が利用可能になった事実を (例えば &man.pkg.version.1; 等の) - 自動化ツールが強調することができるように、 + もし答がイエスであれば、 PORTREVISION を上げるべきでしょう。 @@ -1426,7 +1430,7 @@ PORTEPOCH= 1 - accessibility* + accessibility 障害を持ったユーザの役に立つ ports @@ -1696,9 +1700,9 @@ PORTEPOCH= 1 CATEGORIES 行に書かれている場合、 misc を削除して他のサブディレクトリにおいて良いという意味になります。 - このカテゴリにある ports は見落とされる傾向があるので、 - 可能であれば、misc - ports より適切なカテゴリを選んでください。 + このカテゴリに置かれた ports は見落とされやすいので、 + 可能な限り misc + よりふさわしいカテゴリを探してください。 @@ -1940,11 +1944,10 @@ PORTEPOCH= 1 ほとんどは他の x11-* カテゴリ (下記参照) に分類されるべきです。 あなたの port が X アプリケーションで、 - USE_XLIB が定義 - (USE_IMAKE を定義すると自動的に定義されます) - されている場合は、適切なカテゴリに分類してください。 - また、それらのほとんどは他の x11-* - カテゴリ (下記参照) に分類されます。 + USE_XLIB を定義し + (USE_IMAKE + を定義すると自動的に定義されます)、 + 適切なカテゴリに分類してください。 @@ -2075,8 +2078,8 @@ PORTEPOCH= 1 DISTNAME は製作者が決めたソフトウェアの名前です。 デフォルトでは DISTNAME は - ${PORTNAME}-${PORTVERSION} になりますが、 - 必要に応じて書き換えることができます。 + ${PORTNAME}-${PORTVERSION} になりますので、 + 必要にな場合だけ書き換えるようにしてください。 DISTNAME は二つの場所でしか使われません。 一つ目は配布ファイルリスト (DISTFILES) のデフォルト ${DISTNAME}${EXTRACT_SUFX} @@ -2093,7 +2096,7 @@ PORTEPOCH= 1 ${PORTNAME}-${PORTVERSION}${EXTRACT_SUFX} という 名前ではないのに、WRKSRCwork/${PORTNAME}-${PORTVERSION} - と設定している場合、おそらく DISTNAME + と設定しているなら、おそらく DISTNAME はそのままにしておく必要があることに注意してください — DISTNAMEWRKSRC の両方を (そして おそらく EXTRACT_SUFX も) @@ -2137,7 +2140,7 @@ MASTER_SITE_SUBDIR= applicationsこれらの変数は /usr/ports/Mk/bsd.sites.mk で定義されています。 - いつでも新しいアーカイブサイトが追加されますので、 + いつでも新しい項目が追加されて行きますので、 port を提出する前に このファイルの最新版を チェックするように心掛けてください。 @@ -2974,7 +2977,9 @@ PATCHFILES= patch1:test:-) - user@hostname.domain + MAINTAINER + の値は、コメント部のない単一のアドレスしか受け付けられません。 + user@hostname.domain という形式を利用してください。この項目には、 あなたの本名などの説明用のテキストは一切いれないでください。 (そうしても、ただ bsd.port.mk @@ -2986,9 +2991,6 @@ PATCHFILES= patch1:test の セクションを参照してください。 - MAINTAINER の値としては、 - コメント部のないアドレスだけが受け付けられます。 - Port のメンテナがユーザからの更新要求に (主な公休日を除いて) 2 週間返答しなかったら、 保守担当者の持ち時間が切れたとみなして、 @@ -3019,6 +3021,10 @@ PATCHFILES= patch1:testMakefile 中で、 COMMENT 変数は MAINTAINER 変数の直後においてください。 + + COMMENT 行は、port + の 1 行の要約としてユーザに示されるので、 + 70 文字未満に抑えるようにしてください。 @@ -3026,7 +3032,7 @@ PATCHFILES= patch1:test多くの port は他の port に依存しています。 必要なものすべてがユーザのマシン上に存在することを - 保証するために使用可能な、5 つの変数が用意されています。 + 保証するために使用可能な、7 つの変数が用意されています。 よくあるケースのためにあらかじめ設定された依存変数に加え、 いくつかの依存関係の制御のための変数があります。 @@ -3185,9 +3191,58 @@ PATCHFILES= patch1:test + <makevar>EXTRACT_DEPENDS</makevar> + + この変数には、この port + の展開に必要な実行ファイルや、他のファイルを指定します。 + 前の変数と同じく、これは + path:dir:target + のタプルの一覧です。たとえば、EXTRACT_DEPENDS= + unzip:${PORTSDIR}/archivers/unzip + は、unzip + という実行形式のファイルがあるかどうか確認し、 + 見つからなければ、ports ツリーの + archivers/unzip + サブディレクトリに降りてビルドおよびインストールを行います。 + + 依存関係は extract + ターゲットにおいて確認されます。 + target 部分が + DEPENDS_TARGET + と同じなら、省いて構いません。 + + + この変数は、展開が働いておらず + (デフォルトでは gzip を仮定しています)、 + で説明されている + USE_ZIPUSE_BZIP2 + を使っても動かない場合にだけ使ってください。 + + + + + <makevar>PATCH_DEPENDS</makevar> + + この変数は、この port + がパッチを当てる際に必要とする実行ファイルや他のファイルを指定します。 + 前の変数と同じく、これは + path:dir:target + のタプルの一覧です。たとえば、 PATCH_DEPENDS= + ${NONEXISTENT}:${PORTSDIR}/java/jfc:extract + は、ports ツリーの + java/jfc サブディレクトリに移動して、 + ビルドおよびインストールを行います。 + + 依存関係は、patch + ターゲットにおいて確認されます。target + 部分が DEPENDS_TARGET + と同じなら省略して構いません。 + + + <makevar>DEPENDS</makevar> - 上記の四つのいずれにもあてはまらないような依存関係がある場合、 + 上記のいずれにもあてはまらないような依存関係がある場合、 または他の port がインストールされているだけではなく ソースが展開されている必要がある場合には、この変数を使います。 これは上記の四つと違い、特に確認するものが @@ -3199,7 +3254,7 @@ PATCHFILES= patch1:test - + <makevar>USE_<replaceable>*</replaceable></makevar> 多くの ports に共通の依存関係をカプセル化するために、 @@ -3301,6 +3356,15 @@ PATCHFILES= patch1:test + USE_SDL + + その port のビルドや実行に + SDL が使われます。 + USE_SDL の使い方について、詳しくは + をご覧ください。 + + + NO_INSTALL_MANPAGES install.man @@ -3621,14 +3685,22 @@ LDCONFIG_DIRS= %%PREFIX%%/lib/foo %%PRE port 作成者として、あなたには、使用許諾条件をよく読み、 - FTP または CD-ROM + FTP/HTTP または CD-ROM で再配布してはいけないソースコードやコンパイルされたバイナリを配布してしまい、 その責任が FreeBSD プロジェクトにかかってくることのないよう注意する義務があります。 疑わしい場合には &a.ports; で聞いてみてください。 - そのような場合、次の変数を設定してください。 - また、ports/LEGAL も更新すべきです。 + そのような場合、次の節で説明されている変数が設定できます。 + + + RESTRICTED + は、それだけを設定すれば済むように、暗黙のうちに + NO_CDROMNO_PACKAGE + を設定します。それに対して、 + NO_PACKAGENO_CDROM + は独立で、同時に設定可能です。 + <makevar>NO_PACKAGE</makevar> @@ -3641,7 +3713,8 @@ LDCONFIG_DIRS= %%PREFIX%%/lib/foo %%PRE また、NO_PACKAGE は、バイナリパッケージが汎用的ではなく、 いつもアプリケーションをソースコードからコンパイルすべき場合にも利用すべきです。 - たとえば、アプリケーションにサイト特有の設定情報がコンパイル時にハードコードされるような場合です。 + たとえば、アプリケーションにサイト特有の設定情報がコンパイル時にハードコードされるような場合には、 + NO_PACKAGE を設定してください。 NO_PACKAGE には、 パッケージを作成すべきではない理由を述べた文字列を設定すべきです。 @@ -3650,43 +3723,51 @@ LDCONFIG_DIRS= %%PREFIX%%/lib/foo %%PRE <makevar>NO_CDROM</makevar> - この変数は、 - バイナリパッケージの作成は許可されていますが、 - そのパッケージや port の DISTFILES - を販売用の CDROM (や DVD-ROM) - に載せるのは許されていないことを表します。 - DISTFILES は、FTP (設定次第では HTTP) - で入手可能です。 - - NO_PACKAGENO_CDROM - は、同時に設定できます。 + この変数は、バイナリパッケージの作成は許可されていますが、 + その package や port の DISTFILES + を販売用の CD-ROM (や DVD-ROM) + に載せるのは許されていないことを表します。なんにせよ、 + バイナリパッケージと port の DISTFILES + は、FTP/HTTP で入手できます。 + + NO_CDROM には、その port が何故 CD-ROM + で再配布できないか説明する文字列を設定するべきです。 + これはたとえば、その port のライセンスが非商用 + 利用に限っている場合に使うべきです。 <makevar>RESTRICTED</makevar> - アプリケーションのライセンスが、FTP (設定次第では HTTP) - でそのアプリケーションの - DISTFILES をミラーすることも禁じていたら、 + アプリケーションのライセンスが、FTP/HTTP + で、そのアプリケーションの DISTFILES + をミラーすることや、 + バイナリパッケージを配布することを禁じていたら、 この変数を設定してください。 - また、 - アプリケーションのライセンスが利用者について一般的な制限をかけている場合も、 - この変数を設定してください。 - たとえば、非商用利用限定のアプリケーションなどがあります。 - - Ports のソースコード管理者 (committer) は、 - その制限が何を要求しているかを正確に述べた項目を - /usr/ports/LEGAL に追加すべきです。 + RESTRICTED には、その port + が何故再配布できないか説明する文字列を設定するべきです。 + 典型的な場合としては、その port + がプロプライエタリなソフトウェアを含んでいて、 + DISTFILES + を、おそらくソフトウェアに関する登録を行ったり、 + EULA を承諾した後で、 + 手動でダウンロードしなければならないことを表します。 <makevar>RESTRICTED_FILES</makevar> - 一部の配布ファイルだけに制限がかかっていたら、 - この変数にそのファイルのリストを設定してください。デフォルトでは、 + RESTRICTEDNO_CDROM + が設定されている時は、この変数はデフォルトで ${DISTFILES} ${PATCHFILES} - になります。 + になります。それ以外は空です。 + 一部の配布ファイルだけに制限がかかっていたら、 + この変数にそのファイルのリストを設定してください。 + + port committer は、設定した配布ファイル毎に + /usr/ports/LEGAL + に制限の内容を説明する項目を追加すべきことに注意してください。 @@ -3714,6 +3795,31 @@ LDCONFIG_DIRS= %%PREFIX%%/lib/foo %%PRE + USE_PERL5_BUILD + + その port をビルドするのに perl 5 + を使用することを示します。 + + + + USE_PERL5_RUN + + その port を実行するのに perl 5 + を使用することを示します。 + + + + PERL + + システムまたは port からインストールされた + perl 5 + の完全なパスからバージョン番号を省いたもの。 + スクリプトの + #! + 行を置き換える必要があれば使ってください。 + + + PERL_CONFIGURE Perl の MakeMaker @@ -3762,6 +3868,21 @@ LDCONFIG_DIRS= %%PREFIX%%/lib/foo %%PRE がアーキテクチャ依存のライブラリをインストールする場所。 デフォルトは ${ARCH}-freebsd + + + PERL_PORT + + インストールされている perl + の port の名称 (例えば perl5)。 + + + + SITE_PERL + + サイト独自の perl + パッケージの入るディレクトリ名。 + この値は PLIST_SUB に追加されます。 + @@ -4019,7 +4140,7 @@ LDCONFIG_DIRS= %%PREFIX%%/lib/foo %%PRE FreeBSD/GNOME プロジェクトは、ある特定の port が使っている GNOME コンポーネントを特定するために - GNOMENG というシステムを利用しています。 + 独自の変数群を使っています。 FreeBSD/GNOME プロジェクトのページに その変数のわかりやすい一覧 があります。 @@ -4119,6 +4240,107 @@ LDCONFIG_DIRS= %%PREFIX%%/lib/foo %%PRE この節はまだ書かれていません。 + + + SDL の利用 + + USE_SDL 変数は、 + devel/sdl12 や + x11-toolkits/sdl_gui + など、SDL ベースの ports + への依存を自動設定するのに使われます。 + + 今のところ、次の SDL ライブラリが認識されます。 + + + + sdl: devel/sdl12 + + + + gfx: graphics/sdl_gfx + + + + gui: x11-toolkits/sdl_gui + + + + image: graphics/sdl_image + + + + ldbad: devel/sdl_ldbad + + + + mixer: audio/sdl_mixer + + + + mm: devel/sdlmm + + + + net: net/sdl_net + + + + sound: audio/sdl_sound + + + + ttf: graphics/sdl_ttf + + + + したがって、ある port が + net/sdl_net と + audio/sdl_mixer + に依存していたら、構文は次のようになります。 + + USE_SDL= net mixer + + net/sdl_net と + audio/sdl_mixer + が必要とする devel/sdl12 + の依存も自動的に追加されます。 + + USE_SDL + を使うと、以下のことが自動的に行われます。 + + + + BUILD_DEPENDS に + sdl11-config + への依存を追加します。 + + + + CONFIGURE_ENV に + SDL_CONFIG 変数を追加します。 + + + + LIB_DEPENDS + に選択したライブラリへの依存を追加します。 + + + + SDL ライブラリが利用できるかどうか調べるためには、 + WANT_SDL 変数を使ってください。 + + WANT_SDL=yes + +.include <bsd.port.pre.mk> + +.if ${HAVE_SDL:Mmixer}!="" +USE_SDL+= mixer +.endif + +.include <bsd.port.post.mk> + +