A.6. CVSup を使う

A.6.1. 紹介

CVSup は、 リモートのサーバホストにあるマスタ CVS リポジトリから ソースツリーを配布し更新するための ソフトウェアパッケージです。FreeBSD のソースは、 カリフォルニアにある中心的な開発マシンの CVS リポジトリの 中でメンテナンスしています。CVSup を使用することで、FreeBSD ユーザは 簡単に自分のソースツリーを最新の状態に しておくことができます。

CVSup は pull モデルとよばれる更新のモデルを採用しています。pull モデルでは、 各クライアントが更新したい場合に更新したい時点で、 サーバに更新の問い合わせをおこないます。 サーバはクライアントからの 更新の要求を受け身の状態で待ちます。したがって、 すべての更新はクライアント主導でおこなわれます。 サーバは頼まれもしない更新情報を送るようなことはしません。 ユーザは CVSup クライアントを手動で実行して更新をおこなうか、 cron ジョブを設定して定期的に自動実行する必要があります。

用語 CVSup のように大文字で表記しているものは、ソフトウェアパッケージ 全体を指します。主な構成物は、 各ユーザマシンで実行するクライアントである cvsup、FreeBSD の各ミラーサイトで実行するサーバ cvsupd です。

FreeBSD の文書やメーリングリストを読んだ際に、 sup についての言及を 見かけたかもしれません。sup は CVSup の前に存在していたもので、 同様の目的で使われていました。 CVSup は sup と同じように使用されており、実際、sup と互換性のあるコンフィグレーションファイルを使用します。 CVSup の方がより高速で柔軟性もあるので、もはや sup は FreeBSD プロジェクトでは使用されていません。

A.6.2. インストール

CVSup をインストールする最も簡単な方法は、FreeBSD Ports コレクションのパッケージ からコンパイル済みの net/cvsup パッケージをインストールすることです。 もしくは、 net/cvsup でも構いません。 ただし、 net/cvsup は Modula-3 システムに依存していて、構築にかかる時間、 ディスクスペースは比較的大きくなります。

もし、あなたに CVSup に関してまったく知識がなく、 自動で設定ファイルをセットアップして、 クリックするだけで転送を行なえるインターフェイスを提供してくれるような、 単一のパッケージをインストールしたいと考えているなら、 net/cvsupit パッケージを利用して下さい。 これは pkg_add(1) するだけで良く、 設定は、その際にメニュー形式で行なうことができるようになっています。

A.6.3. CVSup のコンフィグレーション

CVSup の動作は、supfile と呼ばれるコンフィグレーションファイルで制御します。 supfile のサンプルは、ディレクトリ /usr/share/examples/cvsup/ の下にあります。

supfile には以下の cvsup に関する質問への答えを記述します:

• どのファイルを受け取りたいのか?

• どのバージョンのものが欲しいのか?

• どこから入手したいのか?

• 自分のマシンのどこに置きたいのか?

• どこに status ファイルを置きたいのか?

次のセクションで、これらの質問に順番に答えながら典型的な supfile を組み立てていきます。最初に supfile の全体構造を説明します。

supfile はテキストファイルです。 コメントは # から行末までです。 空行とコメントだけの行は無視します。

残りの各行には、 ユーザが受け取りたいファイル群について記述します。 行の始めは、 サーバ側で定義した論理的なファイルのグループである "コレクション" の名称です。 コレクションの名称を指定して、欲しいファイル群を サーバに伝えます。コレクション名の後には、 ホワイトスペースで区切られた 0 個以上のフィールドが続きます。 これらのフィールドが上記の質問に対する答えになります。 フィールドには 2 種類あります: flag フィールドと value フィールドです。flag フィールドは delete や compress のような 単独のキーワードから成ります。また、value フィールドもキーワードで始まりますが、 キーワードの後にはホワイトスペースは入らず、 = と二つめの単語が続きます。例えば、 release=cvs は value フィールドです。

通常、supfile には受け取りたいコレクションを一つ以上指定します。 supfile を組み立てる一つの方法として、 コレクション毎にすべての関係の あるフィールドを明示的に指定する方法があります。しかし、 これでは supfile のすべてのコレクションに対して ほとんどのフィールドが同じになるため、 行が非常に長くなってしまい不便になります。 これらの問題を避けるため、CVSup ではデフォルトを指定することのできる メカニズムが提供されています。特殊な擬似コレクション名 *default で始まる行は、 supfile 中の後続の コレクションに対して使用する flag フィールドと value フィールドのデフォルトを設定するために利用できます。 個々のコレクションで固有の値を指定すると、 デフォルト値を無効にできます。また *default 行を追加すると、supfile の途中からデフォルト値の変更や追加が可能になります。

これまでの予備知識を基に、 FreeBSD-current のメインのソースツリーを受け取って更新するための supfile を組み立ててみましょう。

• どのファイルを受け取りたいのか?

  CVSup を通して入手できるファイルは "コレクション" と呼ばれる名前の付けられたグループにまとめられています。 利用可能なコレクションについては 後の節の中で説明しています。 ここでは、FreeBSD システムのメインのソースツリー全体 を受け取るための設定例を紹介します。 すべてを含む src-all という単一の大きなコレクションがあります。 supfile を組み立てる最初のステップとして、 これらのコレクションを一行に一つずつ記述します (この場合は一行だけです)。

      src-all
  

• どのバージョンのものが欲しいのか?

  CVSup を使用すると、 かつて存在していたことのある、事実上どのバージョンの ソースでも受け取ることができます。これは cvsupd サーバがすべてのバージョンを含む CVS リポジトリに基づいて動作することにより、 実現されています。 tag= および date= の value フィールドを使用して、 欲しいバージョンの 一つを指定します。

  Warningtag= のフィールドの指定は正確に行うように十分注意 してください。いくつかのタグは特定のコレクションに 対してのみ有効です。 タグの綴りが違っていたり不適切なタグを指定すると、 CVSup はユーザが消し たくないファイルまで削除してしまいます。特に ports-* のコレクション に対しては tag=. だけ を指定するようにしてください。

  tag= フィールドはリポジトリ中のシンボリックタグを指定します。 tag には revision tag と branch tag の二種類があります。 revision tag は特定のリビジョンを指します。これは、 毎日同じ状態に保つことになります。一方 branch tag は、 ある時点での開発分流の最新のリビジョンを指します。 branch tag は特定のリビジョンを指定している訳ではないので、 今日と明日では 異なるリビジョンを参照することになるかもしれません。

  Section A.7 にはユーザが興味を持つであろうリビジョンタグの一覧が載せられています。 CVSup の設定ファイル中でタグを指定する時は、 tag= に続けて書きます (RELENG_4 は tag=RELENG_4 になります)。 tag=. だけが ports コレクションには 適切であることに注意してください。

  Warningtag 名を示した通りにタイプされているか十分注意してく ださい。CVSup は tag 名が正しいかどうかを見分けることはできません。tag が間違っていた場合、 たまたまファイルがまったく存在しない正しい tag が 指定されたものとしてCVSup は動作します。その場合は、現在あるソースが削 除されるでしょう。

  branch tag を指定した際には、 通常はその開発分流の最新バージョンの ファイルを受け取ります。 いくらか前のバージョンを受け取りたい場合は、 date= の value フィールドを使って日付を指定することで、 これを実現することが できます。cvsup(1) のマニュアルページで、 その方法を説明しています。

  例として、FreeBSD-current を受け取りたいとします。 次の行を supfile の始めに追加します:

      *default tag=.
  

  tag= フィールドも date= フィールドも指定しなかった場合に 動き出す重要な特殊なケースがあります。そのケースでは、 特定のバージョンの ファイルを受け取るのではなく、 サーバの CVS リポジトリから実際の RCS ファイルを直接受け取ります。 一般的に開発者はこの処理のモードが好きなようです。 彼らのシステム上にリポジトリそのものの コピーを維持することで、 リビジョン履歴を閲覧し過去のバージョンの ファイルを検査できるようになります。しかし、 これには大きなディスクスペースが必要になります。

• どこから入手したいのか?

  更新情報をどこから入手するかを cvsup に伝えるために host= フィールドを使用します。 CVSup ミラーサイト のどこからでも入手できますが、 ネット上での最寄りのサイトを選ぶべきでしょう。 この例では、仮想上の FreeBSD 配布サイト cvsup666.FreeBSD.org を使用します:

      *default host=cvsup666.FreeBSD.org
  

  CVSup を実行する前にホスト名を 実在のものに変更する必要があります。どのように cvsup を実行しても、この設定は -h hostname を 使用してコマンドラインで変更することができます。

• 自分のマシンのどこに置きたいのか?

  prefix= フィールドは、 cvsup に受け取ったファイルをどこに置くかを伝えます。 この例では、ソースファイルを直接メインのソースツリー /usr/src に置きます。 src ディレクトリはすでにファイルを受け取るために 選択したコレクションで暗黙に指定しているので、 これは正しい仕様となります:

      *default prefix=/usr
  

• どこに status ファイルを置きたいのか?

  CVSup クライアントは "base" ディレクトリと呼ばれる場所に、ある status ファイルを維持しています。 すでに受け取った更新情報を追従し続けることで、 これらのファイルは CVSup がより効果的に動作することを支援します。標準の base ディレクトリ /usr/local/etc/cvsup を使用します:

      *default base=/usr/local/etc/cvsup
  

  supfile に指定がない場合は、 この設定をデフォルトで使用しますので、 実際には上の行は必要ありません。

  base ディレクトリが存在しない場合は作成しておきましょう。base ディレクトリが存在しない場合、cvsup クライアントは実行を拒否します。

• その他もろもろの supfile の設定:

  通常 supfile に入れておくべき行がもう一つあります:

      *default release=cvs delete use-rel-suffix compress
  

  release=cvs は、サーバがメインの FreeBSD CVS リポジトリから その情報を取得するように指示します。 ほとんどの場合はこのようにしておきますが、 ここでの説明の範疇をこえるような 状況では他の指定をすることも可能です。

  delete は CVSup にファイルを削除することを許可します。 CVSup が ソースツリーを完全に最新の状態に 保てるようにするためには、これは常に 指定しておくべきでしょう。 CVSup は、 これらの責任範囲のファイルだけを慎重に削除します。 たまたま存在する他の余分なファイルについては、 まったく手をつけずに残しておきます。

  use-rel-suffix は、…神秘的なものです。これについて本当に知りたい人は、 cvsup(1) のマニュアルページをご覧ください。 でなければ、何も考えずに指定してみてください。

  compress は通信チャネルで gzip 形式の圧縮の使用を有効にします。 ご使用のネットワーク接続が T1 speed 以上である場合、 この圧縮を使用しない方がよいかもしれません。 そうでない場合は十分に役に立ちます。

• supfile の例のまとめ:

  以下は supfile の例の全体です:

      *default tag=.
      *default host=cvsup666.FreeBSD.org
      *default prefix=/usr
      *default base=/usr/local/etc/cvsup
      *default release=cvs delete use-rel-suffix compress
      
      src-all
  

    ports/chinese
    ports/french
    ports/german
    ports/hebrew
    ports/japanese
    ports/korean
    ports/russian
    ports/ukrainian
    ports/vietnamese
    doc/de_DE.ISO8859-1
    doc/el_GR.ISO8859-7
    doc/es_ES.ISO8859-1
    doc/fr_FR.ISO8859-1
    doc/it_IT.ISO8859-15
    doc/ja_JP.eucJP
    doc/nl_NL.ISO8859-1
    doc/pt_BR.ISO8859-1
    doc/ru_RU.KOI8-R
    doc/sr_YU.ISO8859-2
    doc/zh_TW.Big5

A.6.4. CVSup の実行

さて、更新の準備ができました。 これを実行するコマンドラインは実に簡単です:

    # cvsup supfile

もちろん、ここでの supfile は作成したばかりの supfile のファイル名です。X11 環境で実行するものと仮定して、cvsup は 通常の操作に必要なボタンを持つ GUI ウィンドウを表示します。 "go" ボタンを押して、 実行を監視してください。

この例では実際の /usr/src ツリーを更新しているので、cvsup にファイルを更新するのに必要なパーミッションを与えるために、 ユーザ root で実行する必要があります。 コンフィグレーションファイルを作ったばかりで、 しかも以前にこのプログラムを実行したことがないので、 神経質になるのは無理もない話だと思います。 大切なファイルに触らずに試しに実行する簡単な方法があります。 どこか適当な場所に空のディレクトリを作成して、 コマンドラインの引数で指定するだけです:

    # mkdir /var/tmp/dest
    # cvsup supfile /var/tmp/dest

指定したディレクトリは、すべての更新されるファイルの 更新先ディレクトリとして使用します。 CVSup は /usr/src の下のファイルを検査しますが、 変更や削除はまったくおこないません。かわりに /var/tmp/dest/usr/src に更新されたすべてのファイルが置かれるようになります。 この方法で実行した場合は、CVSup は base ディレクトリの status ファイルを更新せずにそのままにします。 これらのファイルの新しいバージョンは指定されたディレクトリ に書き込まれます。/usr/src の読み取り許可がある限り、このような試し実行のためにユーザ root になる必要はありません。

X11 を利用していないとか単に GUI が気に入らない場合は、 cvsup 起動時にコマンドラインに 二つほどオプションを追加する必要があります:

    # cvsup -g -L 2 supfile

-g オプションは CVSup に GUI を使用しないように伝えます。X11 を利用していない場合には自動的に指定されますが、 そうでない場合は明示的に指定します。

-L 2 オプションは cvsup にファイル更新中の詳細情報をプリントアウト するように伝えます。冗長性には -L 0 から -L 2 までの三つのレベルがあります。 デフォルトは 0 であり、エラーメッセージ以外はまったく出力 しません。

たくさんの他のオプション変数があります。 それらの簡単な一覧は cvsup -H で表示されます。 より詳しい説明はマニュアルページをご覧ください。

動作している更新の方法に満足したら、cron(8) を使って CVSup を定期的に 実行させる準備をすることができます。cron から起動する際には、 明示的に CVSup が GUI を使わないようにする必要があります。

A.6.5. CVSup ファイルコレクション

CVSup 経由で入手できるファイルコレクションは 階層的に組織化されています。 いくつか大きなコレクションがあり、 それらは小さなサブコレクションに 分割されています。 大きなコレクションは、そのサブコレクション毎に 受信することと同じことになります。 下の一覧ではコレクション間の階層関係を 字下げして表現します。

最も一般的に使用するコレクションは src-all、 ports-all です。 他のコレクションは特別な目的を持つ人達だけが使用しており、 ミラーサイトはそれらのすべてを 持っていないかもしれません。

A.6.6. 詳細について

CVSup の FAQ や CVSup に関するその他の情報については The CVSup Home Page をご覧ください。

CVSup のほとんどの FreeBSD 関連の議論は FreeBSD の技術的議論に関するメーリングリスト <freebsd-hackers@FreeBSD.org> でおこなわれています。 ソフトウェアの新しいバージョンは FreeBSD announce メーリングリスト <freebsd-announce@FreeBSD.org> で アナウンスされます。

質問とバグ報告はプログラムの作者、 <cvsup-bugs@polstra.com> へ 送ってください。

A.6.7. CVSup サイト

FreeBSD の CVSup サーバは以下のサイトで稼働しています: