X-Git-Url: http://git.chise.org/gitweb/?a=blobdiff_plain;f=doc%2FHACKING.ja;h=e3e7d63bd3eb3cc3e987bc58504047cdebd4c326;hb=HEAD;hp=3deebfce371de7dff2738aa988fdeb1fe6b4ea93;hpb=54f2d2db6a0d34c52a68472f692fef54dca469b1;p=elisp%2Friece.git diff --git a/doc/HACKING.ja b/doc/HACKING.ja index 3deebfc..e3e7d63 100644 --- a/doc/HACKING.ja +++ b/doc/HACKING.ja @@ -1,17 +1,21 @@ -*- mode: text; coding: iso-2022-jp -*- -この文書では、Riece の開発プロセスや内部構造など、開発に必要な情報をま -とめています。 +この文書は、Riece の開発者や開発者になりたい人向けです。Riece の開発プ +ロセスや内部構造など、開発に必要な情報をまとめています。 -* 開発プロセス +CVS から取得したソースのビルド方法も説明しますが、その手順を Web ページ +に載せていない意図を察してください--つまり開発版に関する的外れの苦情は +歓迎されません。 + +もしあなたが初心者で、新しいバージョンを試したいだけなら、馬鹿な考えは +捨ててリリース版を使い続けてください。 -** バグ報告 +* 開発プロセス -バグ報告は、ツールバーの虫のアイコンをクリックするか、 -M-x riece-submit-bug-report で作成してください。また、バグ報告の作成の -前にデバッグ出力を有効にしておく必要があります。 +** バグの報告 -** デバッグ出力 +バグ報告は、M-x riece-submit-bug-report で作成してください。また、バグ +報告の作成の前にデバッグ出力を有効にしておく必要があります。 変数 riece-debug を t に設定すると、Riece の実行中にデバッグ情報が出力 されるようになります。デバッグ情報は *Debug* バッファに蓄積されます。 @@ -19,32 +23,29 @@ M-x riece-submit-bug-report で作成してください。また、バグ報告の作成の また、IRC サーバとのやりとりが " *IRC*" バッファに蓄 積されます。バッファの名前が空白 " " で始まることにご注意ください。 -** 開発への参加 +** コードの貢献 + +パッチかアドオンを書いたら送ってください。有用なものであれば取り込みます。 -パッチかアドオンを書いて送ってください。適切なものであれば取り込みます。 +** 開発版ソースコードの取得 -** CVS +繰り返しますが、もしあなたが初心者で、開発者になるつもりもないのなら、 +リリース版を使ってください。 Riece の開発には CVS を利用しています。公開 CVS サーバから最新版のソー スコードを取得するには以下のようにします。 -CVS 版のソースコードは、あくまで開発途上のものであり、利用は個人の責任 -でお願いします。CVS 版に関するバグ報告は受け付けません。 - -(1) CVS サーバへのログイン - - cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root login - CVS password: [CR] # NULL string - -(2) モジュールのチェックアウト +(1) モジュールのチェックアウト cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root checkout riece -(3) configure スクリプトの生成 +モジュール名の前にタグを指定できます。 + +(2) configure スクリプトの生成 autoreconf -f -i -v -この作業には最新の GNU Automake が必要かもしれません。 +"autoreconf" は "autoconf" ではないことに注意してください。 * 内部構造 @@ -358,25 +359,27 @@ riece-naming が提供する主な関数は以下の 3 つです。 アドオンの条件を満たすモジュールは以下の関数を提供します。 -- <モジュール名>-requires - 依存する他のアドオン(シンボルのリスト)を返します(オプション) +- <モジュール名>-requires (オプション) + 依存する他のアドオン(シンボルのリスト)を返します - <モジュール名>-insinuate 初期化処理を行います +- <モジュール名>-uninstall (オプション) + アドオンをアンインストールすると呼ばれます + +- <モジュール名>-enable (オプション) + アドオンの有効にすると呼ばれます + +- <モジュール名>-disable (オプション) + アドオンの無効にすると呼ばれます + また、アドオンの簡単な説明を、変数 <モジュール名>-description に設定す ると良いでしょう。この文字列は C-c ^ (M-x riece-command-list-addons) によるアドオンの一覧で表示されます。 -有効化・無効化に対応したアドオンは、変数 <モジュール名>-enabled に現在 -の状態を保持します。この変数の値が nil であれば無効、t であれば有効で -す。加えて、以下の関数を提供します。 - -- <モジュール名>-enable -アドオンを有効にします - -- <モジュール名>-disable -アドオンを無効にします +アドオンの有効・無効の状態は、<モジュール名> のシンボルに +付与される riece-addon-enabled プロパティで調べることができます。 Riece は起動時に以下の処理を行います。 @@ -416,4 +419,4 @@ riece-after-privmsg-hook の二つのフックが呼ばれます。 ば、その後の処理をおこないません。また、その場合には riece-after--hook も呼び出されません。 -フックの引数には RFC2812 の prefix と parameters が渡ります。 \ No newline at end of file +フックの引数には RFC2812 の prefix と parameters が渡ります。