gate-toroku-system開発チーム
$Id: dvlop.html,v 1.4 2009/12/21 05:13:33 michi Exp $
ここでは,gateシステム開発者向けに 開発の手順といくつか留意する事について記す.
[eplocal]北大理・EPサーバに固有の事情は インデントした段落に緑の文字で記した。 たとえばこの段落がそうである。
以下,大雑把ではあるが,開発の手順及び留意点について記す. なお,gateシステムはCVSを利用して開発されたため, ここでもCVSによって開発される事を前提に話を進める.
[eplocal]少なくとも現在(2007年度)のEPサーバでは CVSを利用して開発を続けている.
[2.1]CVSによる開発
CVSを利用してgateシステムを開発する. CVSの使い方については gateシステム開発でのCVS利用の手引き を参照してほしい.
[2.2]開発に伴うドキュメントの更新
開発の際に,いくつかのものはここにあるようなドキュメント (インストールの手引きなど) を更新する必要がある.
以下では更新を必要とする場合について記す.
[2.2.1]gate.confに新たな変数を加える(または除く)場合
gate-toroku-system/include/gate.conf に新たな変数を加える場合は インストールの手引き(登録サーバ) (gate-toroku-system/doc/install-toroku.html)の 「3.パッケージの設定」にその変数に関しての記述を加える事. また,変数を除く場合にはその変数についての記述を削除する事.
[2.2.2]新たなコマンドを作成した場合
新たにシステムコマンドを作成した場合, そのコマンドに対応したマニュアル(man)を作成する必要がある.
マニュアルはgate-toroku-system/doc以下に作成する. manの書き方に関しては既成のものを参考にして書いていただきたい. (manの書式マニュアルもあれば良いのだけれど)
上記の場所にman用のファイルを作成すると,インストールの際に hroff(roffソース[man書式]から ハイパーテキストを生成するperlスクリプト, 地球流体電脳倶楽部に置いてある) によって,gate-toroku-system/doc以下にコマンドに関しての HTMLファイルが作成される.
そのHTMLファイルに対して gate登録システムコマンド集 (gate-toroku-system/doc/commands.html) からリンクを張っておくこと.
[2.3]最新版パッケージの作成・設置
gateシステム開発後にはその最新のgateシステムを パッケージ化し,開発者や管理者の手に入る場所に設置してもらいたい. 以下でその具体的な手順を記す.
[2.3.1]開発後の最新版パッケージの作成
gateシステムに新たな更新を加えた後には その最新版のパッケージを作成してもらいたい.
このパッケージは,gateシステムをアップデートする際や, システム再構築後のgateシステム再インストールの際に使用する. (もちろん初めてgateシステムをインストールする際にも使用してよい.)
まず,ゴミが入らないよう,一度新しい作業コピーをチェックアウト しなおす.
$exportCVSROOT=:ext:www.ep.sci.hokudai.ac.jp:/home/gate/cvsroot
$exportCVS_RSH=ssh
$cvscheckoutgate-toroku-systemパッケージを作成するにはgate-toroku-sysytemディレクトリ において以下のコマンドを使用すると良い.これにより gate-toroku-system.tar.gzが作成される.
$cdgate-toroku-system
$maketar$cd..
$ls-lgate-toroku-system.tar.gzちなみに,上記のコマンドは下記のコマンドと同じ効果である.
$cd..
$tarcvfzgate-toroku-system.tar.gzgate-toroku-system[2.3.2]最新版パッケージの設置
最新版のパッケージを作成したら,それを設置する. 開発者及び管理者がどこに最新版があるのか混乱しないよう, ある一定の場所に設置する事をお勧めする.
[eplocal]EPサーバではwww.ep.sci.hokudai.ac.jpの /home/gate/gate-toroku-system.tar.gzに最新版を設置 することにしている. 開発後は必ずこの作業を行ってもらいたい.