はじめに
新入社員にバージョン管理ツールのSubversionを教える事になった！
どうせならQiitaで情報シェアした方が、同じような（教える側の）境遇の人たちへの教育教材の助けとなるかもって思ってまとめています。
私の都合でWindowsをベースとしTortoiseSVN機能を中心に、とっかかりの部分の使い方を中心に説明していきます。
同じ境遇の人は、「svnのForceを感じるのだ！」って言う前に、こちらを案内してもらえればいいかもです。
バージョン管理の目的
さっそくですが、手抜き分かりやすくまとめているページがありましたので、こちらを参照してください。
TortoiseSVNとは/インストール方法
さぁ、バージョン管理の必要性は、マスターしたと思います。便利ですよね～バージョン管理。
もう入れるしかないでしょう！って事でSubversion(svn)のクライアントであるTortoiseSVNをいれてみましょう。
gitやMercurialを使っている人は、残念。教えてもらう上司にQiitaに書いてもらいましょう。きっと皆が幸せになれると思います。
TortoiseSVNの説明や、インストールについては、ここでも手抜きゴホゴホ分かりやすくまとめているページがありますので、こちらを参照してください。
つかってみようTortoiseSVN
さっそく使ってみましょう。
きっとこれを見せている上司は、すでにリポジトリを作成してくれていて使える状態にしているはずです。
私は信じています。作ってあげてよね！
（閉口休話）
まずは、リポジトリからチェックアウトしてみましょう。
リポジトリからのチェックアウト(svn checkout)
リポジトリから、Suvbersionに登録されている内容を、自分のローカルへ作業コピーとして情報を持ってくることをチェックアウトといいます。
チェックアウトするリポジトリの情報は、作業コピーを持ってくるディレクトリのところで右クリックし、
「TortoiseSVN」-「リポジトリブラウザー(R)」
を選択します。
指定されたリポジトリのtrunk1を選択して、「チェックアウト(K)...」を選択してみましょう。
チェックアウトの画面が出てきたと思います。
| 項目 | 内容 |
|---|---|
| リポジトリのURL | 先ほど選択したリポジトリURLです。 |
| チェックアウト先のディレクトリ(D) | ローカルの作業コピー先を指定します。 組込機器等の開発をおこなっていると統合開発環境が絶対パスでMakefileを作成します。複数の開発者で同じMakefileを使う場合を考慮し、subst等で決めうちでドライブ名を作成。その下にリポジトリURLと同じディレクトリ構成で作成します。この運用により同じpathのディレクトリ構成で開発することができます。 また、ここではリポジトリで指定しているtrunkは不要です。 |
そのまま「OK」を押してみましょう。
おめでとうございます！完了のメッセージが出ていれば、チェックアウト完了です！
作業コピーの変更点をリポジトリへ送信(svn commit)
あなたの上司は既に課題を与えており、それコミットしといてねって気楽な感じでお願いしてくると思います。
めげちゃいけません。私がちゃんと説明します。
自分のローカルである作業コピーの内容をリポジトリへ送信することをコミットといいます。
先ほどチェックアウトしたディレクトリに作成したコードを入れ、右クリックし「SVNコミット(C)...」を選択します。
- リポジトリに追加する対象のファイルにチェックを入れます。
- コミットのコメントを書きます。
注意点としてリポジトリに登録ファイルは、、
- コミット対象にbuild時に生成されたオブジェクトファイルなどの中間ファイルなど。
- 特定の用途で使用しているユーザー毎に異なるログ、キャッシュファイルなど。
等は、登録するとコミット毎に差分がでてしまうので登録はしないのが一般的です。
また、コミット時のメッセージのフォーマットは一般的に以下のようにします。
1行目 変更内容の要約（タイトル、概要）
2行目 (空行)
3行目以降 変更した理由（内容、詳細）
コミット終了画面にて、「完了 リビジョン＊＊＊となりました」
と出てれば、Subversionサーバーへコミット終了です。
リポジトリへの追加準備(svn add)
さぁ、ドヤ顔で上司に報告してみましょう。
すると上司は、あっゴメン。README.md入れてもらうの忘れてた（テヘペロ
っと真顔で悪気もなく言ってくるかもしれません。
なるべく首から下を狙って、確実にグーで仕留めるここは大人の対応をして、すぐにREADME.mdを作成してコミットしましょう。
作業コピーに新たに追加したファイルやディレクトリを管理対象としてマークすることを、add(追加)といいます。
新しくファイルを管理対象として追加するなら、追加したいファイルを選択後に右クリック
「TortoiseSVN」-「追加（A)」
で追加が可能です。
先ほど、チェックアウトしたディレクトリを右クリックし、「SVNコミット(C)...」を選択します。
ログの表示(svn log)
さぁ、ここまで出来たら自分のやった事に対して自画自賛をしていきましょう。
バージョン管理ツールは、変更を全て記憶しています。
いままで行ってきた作業は、全て記憶されているはずなので、変更内容をみていきましょう。
作業コピーのTOPディレクトリ（.svnディレクトリがある場所）で右クリック
「TortoiseSVN」-「ログを表示(L)」
おおおお、ちゃんと記憶されてる！！
5分ぐらい悦に至るぐらいなら、あなたの優しい上司なら許してくれるでしょう。
しっかりドヤ顔しながら、悦に入ってください。
tagの作成(svn copy)
悦に入っている中、またまた上司が、あっゴメン。タグ付けしといてっと言ってきました。
やるしかありません、もうあなたはTortoiseSVNのマスターです。
タグ付けとは、リポジトリのとある状態を人間が管理しやすいようにリポジトリに目印としてマーキングしていくことです。
つまりタグ(tag)やブランチ(branch)とは、リポジトリのとある状態をコピーすることを指します。
唯一違いがあるは、
| 項目 | 内容 |
|---|---|
| ブランチ(branch) | ブランチとしてコピーしたリポジトリに対して変更を運用上許容する。 |
| タグ(tag) | ブランチとしてコピーしたリポジトリに対して変更を運用上許容しない。 |
となっています。
具体的にはソフトウェアのリリース後、その状態を保持する事を目的として"タグ"付けをおこない、
ブランチは、本流とは異なるトピック的な作業を進めたいときに使用します。
ここでは、タグ付けを行うので、作業コピーのディレクトリTOPで、右クリック
「TortoiseSVN」-「ブランチ/タグの作成(T)」
コミットの設定を行います。
- 宛先パスの設定
宛先は、リポジトリのtagディレクトリです。tag/**** とし、"****"には何をタグ付けしたかが分かるようにソフトウェアのバージョンなどを設定します。何を指定するかは、会社やプロジェクトのポリシーによって異なるので、一度確認した方がいいでしょう。 - ログメッセージ
何をコミットしたかを分かるようにコメントを付与します。 - コピー元のリビジョンの指定
ブランチ/タグ共に、どのリビジョンからコピー（派生）しかたを明確にする必要がある為、特定のリビジョンとして指定を行います。 - タグ/ブランチを作成したら、そのリポジトリの宛先へ作業コピーの参照先を変更します。
タグ付けの時には、チェックをはずします。ブランチの場合は、チェックを入れると一手間減るのでお勧めです。
ここまでできれば、当面の開発は乗り切れるかもしれません。ここからは知っておいて欲しい内容をちょっとだけ記載しています。
作業コピーにあるファイルやディレクトリ変更状態の確認(svn status)
いろいろ作業していくと、何をどんな風に変更をかけたのか分からなくなる事が、きっと出てくると思います。
そんなときは、作業コピーのTOPディレクトリで、右クリック
「TortoiseSVN」-「変更をチェック(F)」
にて作業コピー内の変更内容を確認することができます。
作業コピーが参照しているリポジトリURLリビジョンの確認(svn info)
作業コピーディレクトリを右クリック、プロパティ表示にて、「Subversion」タグが追加されています。
そこを参照することにより、
- 現在の参照しているリポジトリURL
- 作業コピーのリビジョン
- リポジトリの最終変更リビジョン
の確認ができます。
リポジトリの変更点を作業コピーに適用(svn update)
ソフトウェアを複数人で開発する場合、自分以外の人がリポジトリにコミットをする事が多々あります。
その変更内容を作業コピーに反映させる場合に使用します。
「作業コピーの変更点をリポジトリへ送信」では、言及しませんでしたがコミットの前には必ず実施してください。
さいごに
最低限これだけ知っておけば、開発死しないだろうレベルで説明をしていきました。
個人的には、
- 右クリック「TortoiseSVN」-「切り替え(W)...」 (svn switch)
- 右クリック「TortoiseSVN」-「マージ(M)...」 (svn merge)
あたりは開発時の必要に迫られた時にでも、上司や仲間に聞いてもらえると開発が捗ると思います。
おいおい、この使い方（コマンド）忘れてないかいって事があれば、コメント歓迎してます（追記するとは言ってないｗ）。
-
TortoiseSVNの使い方 - 基本用語で説明があった、トランクの事です。 ↩