X-Git-Url: http://cgit.sxemacs.org/?a=blobdiff_plain;f=doc%2FHACKING.ja;h=1e433bd9bdb7c7443b6070006c118c4e2d5f932b;hb=7a05558868018a20692857f1134a7e0ff028c1e7;hp=fc62d4e52ff540b97c9cf425cad37002176a033b;hpb=59a43030d216ee8dbfef8125108d061465fff857;p=riece diff --git a/doc/HACKING.ja b/doc/HACKING.ja index fc62d4e..1e433bd 100644 --- a/doc/HACKING.ja +++ b/doc/HACKING.ja @@ -1,46 +1,37 @@ -*- mode: text; coding: iso-2022-jp -*- -この文書では、Riece の開発プロセスや内部構造など、開発に必要な情報をま -とめています。開発に参加していただける方は参考にしてください。 +この文書は、Riece の開発者や開発者になりたい人向けです。Riece の開発プ +ロセスや内部構造など、開発に必要な情報をまとめています。 * 開発プロセス -** CVS +** バグの報告 -Riece の開発には CVS を利用しています。公開 CVS サーバから最新版のソー -スコードを取得するには以下のようにします。 +バグを見付けたら以下に登録してください。 +https://savannah.nongnu.org/bugs/?group=riece -CVS 版のソースコードは、あくまで開発途上のものであり、利用は個人の責任 -でお願いします。CVS 版に関するバグ報告は一切受け付けません。 +** コードの貢献 -(1) CVS サーバへのログイン +パッチかアドオンを書いたら送ってください。有用なものであれば取り込みます。 - cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root login - CVS password: [CR] # NULL string +** 開発版ソースコードの取得 -(2) モジュールのチェックアウト +Riece の開発には Git を利用しています。最新の開発版ソースコードは +git.sv.gnu.org から入手できます。 - cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root checkout riece +注意：もしあなたが初心者で、新しいバージョンを試したいだけなら、馬鹿な +考えは捨ててリリース版を使い続けてください。開発版に関する的外れの苦情 +は歓迎されません。 -(3) configure スクリプトの生成 +(1) モジュールのチェックアウト - autoreconf -f -i -v - -この作業には最新の GNU Automake が必要かもしれません。 - -** バグ報告 + git clone git://git.sv.gnu.org/riece.git -バグ報告は、ツールバーの虫のアイコンをクリックするか、M-x -riece-submit-bug-reportで作成してください。また、バグ報告の作成の前に -riece-debug を t に設定する必要があります。 +(2) configure スクリプトの生成 -** デバッグ出力 - -変数 riece-debug を t に設定すると、Riece の実行中にデバッグ情報が出力 -されるようになります。デバッグ情報は *Debug* バッファに蓄積されます。 + autoreconf -f -i -v -また、IRC サーバとのやりとりが " *IRC*" バッファに蓄 -積されます。バッファの名前が空白 " " で始まることにご注意ください。 +"autoreconf" は "autoconf" ではないことに注意してください。 * 内部構造 @@ -165,6 +156,7 @@ riece-identity オブジェクトは以下の 2 つの要素をもつベクターです。 - prefix チャンネル名やニックネームなど、IRC サーバに固有の名前 + - server IRC サーバの名前 @@ -211,7 +203,7 @@ riece-channel はチャンネルを表すオブジェクトで、以下の要素を持ちます。 発言権をもつユーザのニックネームのリスト - modes -チャンネルのモード + チャンネルのモード - banned MODE +b で指定されたパターンの一覧 @@ -271,7 +263,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 +345,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 は起動時に以下の処理を行います。 @@ -410,4 +405,4 @@ riece-after-privmsg-hook の二つのフックが呼ばれます。 ば、その後の処理をおこないません。また、その場合には riece-after--hook も呼び出されません。 -フックの引数には RFC2812 の prefix と parameters が渡ります。 \ No newline at end of file +フックの引数には RFC2812 の prefix と parameters が渡ります。