CVSの使い方  - MacOSXで事始め -

1. 最初に

2. ユーザ／リポジトリ毎の設定

2.1 環境変数 ${CVSROOT} の設定

2.2 リポジトリ格納用ディレクトリの作成と初期化

2.3 cvsignore ファイルの作成と設定

2.4 cvswrappers ファイルの修正

3. モジュール（プロジェクト）の作成

3.1 プロジェクトの原型ディレクトリを作成する

3.2 必要に応じて .cvsignore や .cvswrappers ファイルを作成する

3.3 リポジトリにプロジェクトを登録する（モジュールを作成する）

3.4 原型ディレクトリを削除するか、アーカイブ形式にして保存する

4. 作業用ディレクトリの作成と廃棄

4.1 作業用のディレクトリを作成する

4.2 作業用のディレクトリを破棄する

5. 開発・更新作業 （Terminal編）

5.1 ファイルやディレクトリを追加した時

5.2 ファイルやディレクトリを削除した時

5.3 リポジトリの最新状態に合わせて、作業用ディレクトリ内を更新する

5.4 作業用ディレクトリ内の変更結果を、リポジトリに登録する

5.5 タグを付ける（その時点の状態に目印を付ける）

6. 開発・更新作業 （Project Builder編）

6.1 Project Builder の準備

6.2 Project Builder で可能な作業

7. モジュールのバックアップ／削除／復元（移動）

7.1 モジュールのバックアップ

7.2 モジュールの削除

7.3 モジュールの復元

1. 最初に

• シェルは、tcsh
• ユーザ用ディレクトリ（${HOME}）は、/Users/terra
• リポジトリ用ディレクトリは、/Users/terra/cvsroot

2. ユーザ／リポジトリ毎の設定

2.1   環境変数 ${CVSROOT} の設定

[G4Cube:~] terra% setenv CVSROOT ${HOME}/cvsroot ¶
[G4Cube:~] terra% env | grep "CVSROOT" ¶    # ←設定内容を確認する
CVSROOT=/Users/terra/cvsroot

setenv CVSROOT ${HOME}/cvsroot

2.2   リポジトリ格納用ディレクトリの作成と初期化

[G4Cube:~] terra% mkdir ~/cvsroot ¶
[G4Cube:~] terra% cvs init ¶

2.3   cvsignore ファイルの作成と設定

.DS_Store
._*         # UFS等におけるリソースフォーク格納用ファイル．
*.app       # MacOSXのアプリケーション．
*.build     # Project Builder が中間生成物を格納するディレクトリ(？)
*.pbxindex  # Project Builder が高速検索用のインデックス類を格納するディレクトリ(？)
*.pbxuser   # Project Builder がユーザの作業状態を保存するファイル(？)

2.4   cvswrappers ファイルの修正

[G4Cube:~] terra% cp -i /Developer/Tools/cvswrappers  ${CVSROOT}/CVSROOT/ ¶
overwrite /Users/terra/cvsroot/CVSROOT/cvswrappers? y ¶

3. モジュール（プロジェクト）の作成

3.1   プロジェクトの原型ディレクトリを作成する

3.2   必要に応じて .cvsignore や .cvswrappers ファイルを作成する

# .cvsignore ファイルの内容例 -- OPEN-R開発環境用 
*.elf
*.bin
*.BIN

3.3   リポジトリにプロジェクトを登録する（モジュールを作成する）

[G4Cube:~] terra% cd ~/projectX ¶
[G4Cube:~/projectX] terra% ls -aF ¶     # ←単にディレクトリを確認しているだけ．
.               .cvsignore      main.cpp
..              .cvswrappers    projectX.1
.DS_Store       build/          projectX.pbproj/

[G4Cube:~/projectX] terra% cvs import -m "Project since 2002"  projectA  terra  first ¶
    #                                     (1)                  (2)       (3)    (4)
    # (1): メッセージ．簡単な説明文．何か指定しないとviが起動して面倒．
    # (2): モジュール名．今後の作業で、何かと指定することになります．
    # (3): ベンダータグ．作成者名を意味する文字列でOK.
    # (4): リリースタグ．モジュール全体のバージョン識別名称．
I projectA/.DS_Store
N projectA/.cvsignore
N projectA/.cvswrappers
N projectA/main.cpp
・・・

3.4   原型ディレクトリを削除するか、アーカイブ形式にして保存する

4. 作業用ディレクトリの作成と廃棄

4.1   作業用のディレクトリを作成する

[G4Cube:~] terra% ls ${CVSROOT} ¶
CVSROOT     projectA    # ←取り出すモジュール（プロジェクト）名を確認する
[G4Cube:~] terra% cvs checkout -d projectX  projectA ¶
    #                              (1)       (2)
    # (1): 作業用ディレクトリを指定する．省略するとモジュール名と同じ名前になる．
    # (2): コピーを取り出すモジュール名．
cvs checkout: Updating projectA
U projectA/.cvsignore
U projectA/.cvswrappers
U projectA/main.cpp
・・・
[G4Cube:~] terra% cvs history ¶        # ←チェックアウト状態を確認する
O 01/05 10:17 +0000 terra projectA   =projectX=     ~/*

[G4Cube:~] terra% cvs checkout -d projectX-prg  projectA ¶
・・・
[G4Cube:~] terra% cvs checkout -d projectX-doc  projectA ¶
・・・
[G4Cube:~] terra% cvs history ¶        # ←チェックアウト状態を確認する
O 01/05 10:17 +0000 terra projectA   =projectX-prg= ~/*
O 01/05 10:18 +0000 terra projectA   =projectX-doc= ~/*

4.2   作業用のディレクトリを破棄する

[G4Cube:~/projectX] terra% cd .. ¶     # ←作業用ディレクトリから必ず抜け出す
[G4Cube:~] terra% cvs release -d  projectX ¶    # 最後に / を付けないこと！
You have [0] altered files in this repository.
Are you sure you want to release (and delete) directory `projectX': y ¶
[G4Cube:~] terra% cvs history ¶
・・・                                  # ←破棄した projectX が無いことを確認する

5. 開発・更新作業 （Terminal編）

5.1   ファイルやディレクトリを追加した時

[G4Cube:~/projectX] terra% cvs add  newfile.html ¶
    #                                  (1)
    # (1): ファイル名／ディレクトリ名．複数個の指定やワイルドカード指定も可能．
cvs add: scheduling file `newfile.html' for addition
cvs add: use 'cvs commit' to add this file permanently

5.2   ファイルやディレクトリを削除した時

[G4Cube:~/projectX] terra% cvs remove oldfile.html ¶
    #                                  (1)
    # (1): ファイル名／ディレクトリ名．複数個の指定やワイルドカード指定も可能．
cvs remove: scheduling `oldfile.html' for removal
cvs remove: use 'cvs commit' to remove this file permanently

5.3   リポジトリの最新状態に合わせて、作業用ディレクトリ内を更新する

• 現在の作業ディレクトリ内で更新／追加／削除した commit前のファイルやディレクトリを表示します。
• 複数の作業用ディレクトリで開発・更新作業をしている時に、他の作業ディレクトリから commit した結果に合わせて、 現在の作業用ディレクトリ内のファイルを更新してくれます。
• 更新を破棄して元の状態に戻したいファイルがある時は、対象となるファイルを削除してから実行することで、 最後に commitしたファイルをリポジトリから取り出すことができます。

[G4Cube:~/projectX] terra% cvs update -P -d ¶
M main.cpp       # ←M:この作業用ディレクトリ内で更新をしたファイル
? temp.log       # ←?:この作業用ディレクトリ内で追加（新規作成）したファイル
A newfile.html   # ←A:この作業用ディレクトリ内で追加、かつ cvs add したファイル
R oldfile.html   # ←R:この作業用ディレクトリ内で削除、かつ cvs remove したファイル
U projectX.1     # ←U:リポジトリの最新状態を反映して、書き込まれたファイル
cvs update: Updating build
・・・

5.4   作業用ディレクトリ内の変更結果を、リポジトリに登録する

[G4Cube:~/projectX] terra% cvs commit -m "just OK" ¶
    #                                     (1)
    # (1): メッセージ．簡単な説明文．何か指定しないとviが起動して面倒．
cvs commit: Examining .
cvs commit: Examining build
・・・
Checking in main.cpp;
/Users/terra/cvsroot/projectA/main.cpp,v  <--  main.cpp
new revision: 1.2; previous revision: 1.1
done
・・・

5.5   タグを付ける（その時点の状態に目印を付ける）

[G4Cube:~/projectX] terra% cvs tag "v1_0r1" ¶    # 空白や .,:;$@ 文字は不可．
cvs tag: Tagging .
T .cvsignore
T .cvswrapper
T main.cpp
・・・

[G4Cube:~] terra% cvs diff -r "v1_0r1"  main.cpp ¶
Index: main.cpp
===================================================================
RCS file: /Users/terra/cvsroot/projectX/main.cpp,v
retrieving revision 1.2
diff -r1.2 main.cpp
7c7
<   int accume[16];
---
>   int accume[DEFAULT_ARRAY_SIZE];

6. 開発・更新作業 （Project Builder編）

6.1   Project Builder の準備

6.2   Project Builder で可能な作業

7. モジュールのバックアップ／削除／復元（移動）

7.1   モジュールのバックアップ

[G4Cube:~] terra% cvs -d /Users/terra/cvsroot1  history ¶
# 対象モジュールがチェックアウト中で無いことを確認してから、次の作業をする．
[G4Cube:~] terra% cd /Users/terra/cvsroot1 ¶
[G4Cube:~/cvsroot1] terra% tar cvzf ~/projectA.tgz  projectA ¶

7.2   モジュールの削除

[G4Cube:~] terra% cvs -d /Users/terra/cvsroot2  history ¶
# 対象モジュールがチェックアウト中で無いことを確認してから、次の作業をする．
[G4Cube:~] terra% cd /Users/terra/cvsroot2 ¶
[G4Cube:~/cvsroot2] terra% rm -r projectA ¶

7.3   モジュールの復元

[G4Cube:~] terra% cd /Users/terra/cvsroot3 ¶
[G4Cube:~/cvsroot3] terra% ls ¶
CVSROOT     projectB    projectC        # ←復元するモジュールが存在しないことを確認
[G4Cube:~/cvsroot3] terra% tar xvzf ~/projectA.tgz ¶    # モジュールを解凍

Appendix

◇  CVSがデフォルトで管理対象外とするファイル名のパターン

.
..
.#*
#*
,*
_$*
*~
*$

*.a
*.bak
*.BAK
*.elc
*.exe
*.ln
*.o
*.obj

*.olb
*.old
*.orig
*.rej
*.so
*.Z
.del-*
.make.state

.nse_depinfo
core

CVS
CVS.adm
cvslog.*
RCS
RCSLOG
SCCS
tags
TAGS

◇  Project Builder使用時に管理すべきファイルについて

[G4Cube:~] terra% cvs release -d  projectX ¶
? build/projectX.build/projectX.pbxindex/strings.pbxstrings
M projectX.pbproj/terra.pbxuser
You have [2] altered files in this repository.
Are you sure you want to release (and delete) directory `projectX':