「Eosの開発」の版間の差分

提供: Eospedia
移動: 案内、検索
(ページの作成:「ここではEosのオリジナルソースコードをダウンロードし、その後、修正、新規開発して、登録するまでの一連の流れを示しま...」)
 
(→‎git commit)
 
(2人の利用者による、間の11版が非表示)
行1: 行1:
−
ここではEosのオリジナルソースコードをダウンロードし、その後、修正、新規開発して、登録するまでの一連の流れを示します。現在、Eosはgitを用いたソースコード管理がされていますので、gitの使い方を示したものに対応します。
+
ここではEosのオリジナルソースコードをダウンロードし、その後、修正、新規開発して、登録するまでの一連の流れを示します。現在、Eosはgitを用いたソースコード管理がされていますので、[[GITの使い方]]を示したものに対応します。
 +
 
 +
== Eosのバージョン管理　==
 +
=== verion 番号 ===
 +
Eosのバージョン番号は次のように進めることにしました。
 +
 
 +
vXX.YY.ZZpSSSS
 +
 
 +
XX: メジャー番号
 +
　ディレクトリ構成の変更を伴うような根本的な変更を行う場合
 +
 
 +
YY: マイナー番号
 +
　大幅な仕様変更・機能追加を行う場合　
 +
 
 +
ZZ: 番号
 +
　オプションの追加、コマンドの追加などの軽微な変更
 +
 
 +
SSSS: Patch番号（４桁）
 +
　チケット等にあがったバグに対してデバッグを行った場合には、この番号を増加させます。
 +
　この番号に関しては、XX/YY/ZZに関係なく、常に番号をあげていくことにします。（2014/07/07より）
  
 
== Eosのオリジナルソースコードのダウンロード ==
 
== Eosのオリジナルソースコードのダウンロード ==
 +
現在、Eosのソースコードはsourceforge上で管理されています。ダウンロード方法については[[ダウンロード#共同開発を考えている場合（SourceForge上にアカウントが必要）|こちら]]をご覧下さい。
  
 
== 修正方法 ==
 
== 修正方法 ==
  
 
== 登録方法 ==
 
== 登録方法 ==
 +
ソースコードの修正が完了したら、オリジナルソースコードにアップロードして修正内容を公開しましょう。gitコマンドを直接使用する場合とMakefileを利用する場合があります。Makefileを利用する場合は$EOS_HOMEから実行します。下記にGITを使用した修正内容の登録方法を示します。<br>
 +
<br>
 +
 +
=== コミット ===
 +
'''git add'''と'''git commit'''を使用してリポジトリへのコミットを行います。<br>
 +
<br>
 +
 +
==== git add ====
 +
git addはオプション-vを使用することで追加ファイルが標準出力されます。<br>
 +
<br>
 +
全てコミットする場合<br>
 +
<pre>
 +
git add -v .
 +
</pre>
 +
 +
指定ファイルだけコミットする場合<br>
 +
<pre>
 +
git add -v (追加ファイル名)
 +
</pre>
 +
 +
Makefileを使う場合<br>
 +
<pre>
 +
make git-add
 +
</pre>
 +
<br>
 +
 +
==== git commit ====
 +
git commit入力後はコミットメッセージの入力が求められます。aキーを入力することでメッセージの編集を開始します。メッセージ入力後にEsc :wで保存、Esc :qで終了すると更新内容がコミットされます。<br>
 +
<br>
 +
 +
gitコマンドの場合<br>
 +
<pre>
 +
git commit
 +
</pre>
 +
 +
Makefileを使う場合<br>
 +
<pre>
 +
make git-commit
 +
</pre>
 +
<br>
 +
 +
=== マージ ===
 +
'''git fetch'''と'''git merge'''を使用してコミットした内容と最新の内容をマージします。<br>
 +
 +
==== git fetch ====
 +
sourceforgeから最新のデータを取得します。この処理はコミット前でも構いません。<br>
 +
<br>
 +
 +
gitコマンドの場合<br>
 +
<pre>
 +
git fetch origin master
 +
</pre>
 +
 +
Makefileを使う場合<br>
 +
<pre>
 +
make git-fetch
 +
</pre>
 +
<br>
 +
 +
==== git merge ====
 +
マージを行います。最新でないデータから修正を行った場合はデータの衝突(conflict)が発生する場合もあります。その場合は変更内容を確認し、どの内容を採用するかを各ファイル毎に判断する必要があります。<br>
 +
<br>
 +
 +
gitコマンドの場合<br>
 +
<pre>
 +
git merge FETCH_HEAD
 +
</pre>
 +
 +
Makefileを使う場合<br>
 +
<pre>
 +
make git-merge
 +
</pre>
 +
<br>
 +
 +
===== 衝突(conflict)が起きたとき =====
 +
 +
=== アップロード ===
 +
'''git tag'''と'''git push'''を使用してsourceforgeへアップロードを行います。<br>
 +
 +
==== git tag ====
 +
git tagはコミットしたデータにタグを付けるコマンドです。アップロードのためにこの処理は必須ではありませんが、現在の[[Eos]]のソースコードはタグによってバージョン管理していますので、アップロード前にタグの更新をお願いします。現在、Makefileにはgit tagの処理はありませんので下記のコマンドを直接入力して更新して下さい。<br>
 +
<br>
 +
 +
下記のコマンドにて最新タグを取得することができます。但し、このコマンドは'''git fetch'''が成功して最新の内容が出力できていることが前提です。<br>
 +
<pre>
 +
git tag
 +
</pre>
 +
 +
出力結果
 +
<pre>
 +
v2.1.0p0017
 +
v2.1.0p0018
 +
v2.1.0p0020
 +
v2.1.0p0021
 +
</pre>
 +
<br>
 +
 +
あるいは[https://sourceforge.jp/projects/eos/scm/git/base/ sourceforge]から最新タグを確認することが出来ます。<br>
 +
 +
最新タグを確認したら、[[Eosの開発#Eosのバージョン管理|Eosのバージョン管理]]のルールに従って、簡易タグの付加を行います。<br>
 +
<br>
 +
 +
入力例(v2.1.0p0021からをバグ修正した場合)<br>
 +
<pre>
 +
git tag v2.1.0p0021
 +
</pre>
 +
 +
==== git push ====
 +
タグの付加まで完了したら、最後にgit pushでアップロードを行います。オプション --tagsを付加することによりタグの更新まで行うことができます。<br>
 +
<br>
 +
 +
gitコマンドの場合<br>
 +
<pre>
 +
git push origin master  --tags
 +
</pre>
 +
<br>
 +
 +
Makefileを使う場合<br>
 +
<pre>
 +
make git-push
 +
</pre>
 +
Makefileを使った場合はpushの確認メッセージが表示されます。'''Y'''を入力するとpushを続行し、それ以外の入力ではスキップされます。<br>
 +
<br>
 +
 +
== 補足 ==
 +
[[GITの使い方|こちら]]にはGITの使用方法や注意事項を記載しております。

2014年9月24日 (水) 05:32時点における最新版

ここではEosのオリジナルソースコードをダウンロードし、その後、修正、新規開発して、登録するまでの一連の流れを示します。現在、Eosはgitを用いたソースコード管理がされていますので、GITの使い方を示したものに対応します。

Eosのバージョン管理　

verion 番号

Eosのバージョン番号は次のように進めることにしました。

vXX.YY.ZZpSSSS

XX: メジャー番号 　ディレクトリ構成の変更を伴うような根本的な変更を行う場合

YY: マイナー番号 　大幅な仕様変更・機能追加を行う場合　

ZZ: 番号 　オプションの追加、コマンドの追加などの軽微な変更

SSSS: Patch番号（４桁） 　チケット等にあがったバグに対してデバッグを行った場合には、この番号を増加させます。 　この番号に関しては、XX/YY/ZZに関係なく、常に番号をあげていくことにします。（2014/07/07より）

Eosのオリジナルソースコードのダウンロード

現在、Eosのソースコードはsourceforge上で管理されています。ダウンロード方法についてはこちらをご覧下さい。

修正方法

登録方法

ソースコードの修正が完了したら、オリジナルソースコードにアップロードして修正内容を公開しましょう。gitコマンドを直接使用する場合とMakefileを利用する場合があります。Makefileを利用する場合は$EOS_HOMEから実行します。下記にGITを使用した修正内容の登録方法を示します。

コミット

git addとgit commitを使用してリポジトリへのコミットを行います。

git add

git addはオプション-vを使用することで追加ファイルが標準出力されます。

全てコミットする場合

git add -v .

指定ファイルだけコミットする場合

git add -v (追加ファイル名)

Makefileを使う場合

make git-add


git commit

git commit入力後はコミットメッセージの入力が求められます。aキーを入力することでメッセージの編集を開始します。メッセージ入力後にEsc :wで保存、Esc :qで終了すると更新内容がコミットされます。

gitコマンドの場合

git commit

Makefileを使う場合

make git-commit


マージ

git fetchとgit mergeを使用してコミットした内容と最新の内容をマージします。

git fetch

sourceforgeから最新のデータを取得します。この処理はコミット前でも構いません。

gitコマンドの場合

git fetch origin master

Makefileを使う場合

make git-fetch


git merge

マージを行います。最新でないデータから修正を行った場合はデータの衝突(conflict)が発生する場合もあります。その場合は変更内容を確認し、どの内容を採用するかを各ファイル毎に判断する必要があります。

gitコマンドの場合

git merge FETCH_HEAD

Makefileを使う場合

make git-merge


衝突(conflict)が起きたとき

アップロード

git tagとgit pushを使用してsourceforgeへアップロードを行います。

git tag

git tagはコミットしたデータにタグを付けるコマンドです。アップロードのためにこの処理は必須ではありませんが、現在のEosのソースコードはタグによってバージョン管理していますので、アップロード前にタグの更新をお願いします。現在、Makefileにはgit tagの処理はありませんので下記のコマンドを直接入力して更新して下さい。

下記のコマンドにて最新タグを取得することができます。但し、このコマンドはgit fetchが成功して最新の内容が出力できていることが前提です。

git tag

出力結果 

v2.1.0p0017
v2.1.0p0018
v2.1.0p0020
v2.1.0p0021


あるいはsourceforgeから最新タグを確認することが出来ます。

最新タグを確認したら、Eosのバージョン管理のルールに従って、簡易タグの付加を行います。

入力例(v2.1.0p0021からをバグ修正した場合)

git tag v2.1.0p0021

git push

タグの付加まで完了したら、最後にgit pushでアップロードを行います。オプション --tagsを付加することによりタグの更新まで行うことができます。

gitコマンドの場合

git push origin master  --tags


Makefileを使う場合

make git-push

Makefileを使った場合はpushの確認メッセージが表示されます。Yを入力するとpushを続行し、それ以外の入力ではスキップされます。

補足

こちらにはGITの使用方法や注意事項を記載しております。


「https://www.yasunaga-lab.bio.kyutech.ac.jp/EosJ/index.php?title=Eosの開発&oldid=11414」から取得