X-Git-Url: http://git.chise.org/gitweb/?a=blobdiff_plain;f=doc%2FHACKING.ja;h=4a492e86b2dfede6c74bed423be40ea5af19eb6f;hb=156131f7ee2c6887049318652292f49d05cc7279;hp=fc62d4e52ff540b97c9cf425cad37002176a033b;hpb=b95e5b104ad537ca887786c7500a783f5a38777c;p=elisp%2Friece.git diff --git a/doc/HACKING.ja b/doc/HACKING.ja index fc62d4e..4a492e8 100644 --- a/doc/HACKING.ja +++ b/doc/HACKING.ja @@ -1,17 +1,35 @@ -*- mode: text; coding: iso-2022-jp -*- この文書では、Riece の開発プロセスや内部構造など、開発に必要な情報をま -とめています。開発に参加していただける方は参考にしてください。 +とめています。 * 開発プロセス +** バグ報告 + +バグ報告は、ツールバーの虫のアイコンをクリックするか、 +M-x riece-submit-bug-report で作成してください。また、バグ報告の作成の +前にデバッグ出力を有効にしておく必要があります。 + +** デバッグ出力 + +変数 riece-debug を t に設定すると、Riece の実行中にデバッグ情報が出力 +されるようになります。デバッグ情報は *Debug* バッファに蓄積されます。 + +また、IRC サーバとのやりとりが " *IRC*" バッファに蓄 +積されます。バッファの名前が空白 " " で始まることにご注意ください。 + +** 開発への参加 + +パッチかアドオンを書いて送ってください。適切なものであれば取り込みます。 + ** CVS Riece の開発には CVS を利用しています。公開 CVS サーバから最新版のソー スコードを取得するには以下のようにします。 CVS 版のソースコードは、あくまで開発途上のものであり、利用は個人の責任 -でお願いします。CVS 版に関するバグ報告は一切受け付けません。 +でお願いします。CVS 版に関するバグ報告は受け付けません。 (1) CVS サーバへのログイン @@ -28,20 +46,6 @@ CVS 版のソースコードは、あくまで開発途上のものであり、利用は個人の責任 この作業には最新の GNU Automake が必要かもしれません。 -** バグ報告 - -バグ報告は、ツールバーの虫のアイコンをクリックするか、M-x -riece-submit-bug-reportで作成してください。また、バグ報告の作成の前に -riece-debug を t に設定する必要があります。 - -** デバッグ出力 - -変数 riece-debug を t に設定すると、Riece の実行中にデバッグ情報が出力 -されるようになります。デバッグ情報は *Debug* バッファに蓄積されます。 - -また、IRC サーバとのやりとりが " *IRC*" バッファに蓄 -積されます。バッファの名前が空白 " " で始まることにご注意ください。 - * 内部構造 ** モジュールの構成 @@ -165,6 +169,7 @@ riece-identity オブジェクトは以下の 2 つの要素をもつベクターです。 - prefix チャンネル名やニックネームなど、IRC サーバに固有の名前 + - server IRC サーバの名前 @@ -211,7 +216,7 @@ riece-channel はチャンネルを表すオブジェクトで、以下の要素を持ちます。 発言権をもつユーザのニックネームのリスト - modes -チャンネルのモード + チャンネルのモード - banned MODE +b で指定されたパターンの一覧 @@ -271,7 +276,8 @@ riece-naming が提供する主な関数は以下の 3 つです。 シグナルを送信するには、riece-emit-signal を使います。 - riece-emit-signal signal-name &rest args -引数 signal-name で指示されるシグナルを、引数 args とともに送出します + 引数 signal-name で指示されるシグナルを、引数 args とともに送出しま + す シグナルに応答する処理は、riece-connect-signal を使って定義します。 @@ -352,25 +358,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 は起動時に以下の処理を行います。