diff options
| author | Ken'ichi Fukamachi <fukachan@fml.org> | 2018-08-01 18:29:32 +0900 |
|---|---|---|
| committer | Ken'ichi Fukamachi <fukachan@fml.org> | 2018-08-01 18:29:32 +0900 |
| commit | 291a1477ac0da05c989992d755076788b965c8b0 (patch) | |
| tree | 35ea1baa07860ee5edc7a65110f9e2394abffbb0 /fml | |
| parent | 4abd8713c906d97de63a9d88ed7aa0d84eda0f28 (diff) | |
| download | fml8-291a1477ac0da05c989992d755076788b965c8b0.tar.gz fml8-291a1477ac0da05c989992d755076788b965c8b0.tar.bz2 fml8-291a1477ac0da05c989992d755076788b965c8b0.zip | |
repository descriptions, newly created due to scm changes (cvs to git(github).
Diffstat (limited to 'fml')
| -rw-r--r-- | fml/doc/en/tutorial/devel/repository.sgml | 0 | ||||
| -rw-r--r-- | fml/doc/ja/tutorial/devel/repository.sgml | 212 |
2 files changed, 212 insertions, 0 deletions
diff --git a/fml/doc/en/tutorial/devel/repository.sgml b/fml/doc/en/tutorial/devel/repository.sgml new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/fml/doc/en/tutorial/devel/repository.sgml diff --git a/fml/doc/ja/tutorial/devel/repository.sgml b/fml/doc/ja/tutorial/devel/repository.sgml new file mode 100644 index 00000000..782f926f --- /dev/null +++ b/fml/doc/ja/tutorial/devel/repository.sgml @@ -0,0 +1,212 @@ +<!-- + $FML: cvstree.sgml,v 1.11 2005/06/25 15:11:30 fukachan Exp $ +--> + + +<appendix id="repository.dirhier"> + <title> + repository リポジトリの構造 + </title> + + +<!-- ===================================================== --> +<sect1 id="repository.dirhier.summary"> + <title> + ソースツリー構造の概要 + </title> + +<para> +&fml4; と異なり、 +「使えるもの(たとえば CPAN )は何でも使え」が &fml8; の基本方針です。 +そうしないと、自分で保守するべき項目が増えるだけだからです。 +</para> + +<para> +ただし、保守する人もしくはライセンスをはっきりさせておくために、ベンダー +ごとにディレクトリを分けています。たとえば CPAN で保守されているものは +cpan/ ディレクトリ以下に入れています。ライセンスなどによっては、将来さ +らに区分を分ける必要が出てくるかもしれません。 +</para> + +<para> +cpan/ や 3rdparty/ 以下のモジュールを変更したい場合は fml/ 以下で、な +んらかのラップ(wrap)をするか、パッチをオリジナルに反映してもらって +cpan/ 以下をアップデートをすることが望ましいやり方です。cpan/lib/ に直 +接変更を加えることもありますが、cpan/dist/ はオリジナルを保存する場所 +なので、変更してはいけません。 +</para> + +<para> +なお site_local/ はそのサイト独自の module を置くディレクトリと定義さ +れています。つまり fml プロジェクトとは無関係です。 +</para> + +</sect1> + + +<!-- ===================================================== --> +<sect1> + <title> + リポジトリ内のディレクトリ構造 + </title> + + <sect2> + <title> / 以下のディレクトリ構造 </title> + + <table> + <title> / 以下のディレクトリ構造 </title> + <tgroup cols=2> + + <thead> + <row> + <entry> ベンダー名 + </entry> + <entry> そのディレクトリにおくモジュールの説明 + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + Documentation/ + </entry> + <entry> + ドキュメントとして公開する場所。 + + ベンダー境界を越えて混ざりうるので + このディレクトリが創設されました。 + </entry> + </row> + + <row> + <entry> fml/ + </entry> + <entry> &fml8; プロジェクト直轄 + </entry> + </row> + + <row> + <entry> cpan/ + </entry> + <entry> CPAN で保守されているもの + + この下のモジュールについては CPAN の説明の通り。 + 単に標準モジュールでないため、ないしは + &fml8; のバージョン管理や保守のために、ここに収容。 + + なお + cpan/dist/ + に輸入したモジュールの元パッケージ全体をおき、 + cpan/lib/ + にライブラリを正しいクラス階層にあうように置きます。 + </entry> + </row> + + <row> + <entry> img/ + </entry> + <entry> + Internet Message Group + (IM は解散したが、保守を引き継いだ偉い人がいるので OK。 + IMG じゃないけど IMG という名前のまま使うことにする) + </entry> + </row> + + <row> + <entry> 3rdparty/ + </entry> + <entry> サードパーティ用(予約) + + 予約されているだけで、 + &fml8; プロジェクトとしては使いません。 + </entry> + </row> + + + <row> + <entry> site_local/ + </entry> + <entry> + デフォルトではリポジトリ・ツリー内にはありません。 + そのサイト独自に保守したいモジュールをおくための + ディレクトリ。 + 名前を予約されているだけで、 + &fml8; プロジェクトとしては使いません。 + </entry> + </row> + + </tbody> + </tgroup> + </table> + </sect2> + + <sect2> + <title> fml/ 以下 </title> + + <table> + <title> fml/ 以下のディレクトリの説明 </title> + + <tgroup cols=2> + + <thead> + <row> + <entry> ディレクトリ </entry> + <entry> 説明 </entry> + </row> + </thead> + + <tbody> + <row> + <entry> fml/bin/ </entry> + <entry> /usr/local/bin/ にインストールするプログラム </entry> + </row> + + <row> + <entry> fml/doc/ </entry> + <entry> Documentation/ のソース </entry> + </row> + + <row> + <entry> fml/etc/ </entry> + <entry> 設定ファイルやテンプレート群 </entry> + </row> + + + <row> + <entry> fml/lib/ </entry> + <entry> perl モジュール群 </entry> + </row> + + + <row> + <entry> fml/libexec/ </entry> + <entry> + 実行されるプログラムの実体。 + すぐにモジュールを呼び出すので、 + 正確には wrapper です。 + 重要なのは loader だけです。 + </entry> + </row> + + <row> + <entry> fml/share/ </entry> + <entry> メッセージのテンプレートなど </entry> + </row> + + <row> + <entry> fml/utils/ </entry> + <entry> ユーティリティですが、 + これは開発者が fml のソース内で使うだけのものです。 + インストール対象ではありません。 + </entry> + </row> + </tbody> + + </tgroup> + </table> + </sect2> + +</sect1> + +</appendix> |
