Recent changes to doc-DevGuide

doc-DevGuide modified by Shun Sakuraba

Shun Sakuraba — Fri, 12 Apr 2024 02:36:52 -0000

--- v12
+++ v13
@@ -1,6 +1,6 @@
 Repository access
 ====
-ERMOD uses Mercurial ( http://mercurial.selenic.com/ ) as the version controlling system.
+ERMOD uses Git (https://git-scm.com) as the version controlling system.
 With Mercurial installed, user can check out the source code repository via http://sourceforge.net/p/ermod/code/ page through

 ~~~~sh

doc-DevGuide modified by Shun Sakuraba

Shun Sakuraba — Fri, 12 Apr 2024 02:36:14 -0000

--- v11
+++ v12
@@ -3,21 +3,21 @@
 ERMOD uses Mercurial ( http://mercurial.selenic.com/ ) as the version controlling system.
 With Mercurial installed, user can check out the source code repository via http://sourceforge.net/p/ermod/code/ page through

-~~~~
-::::sh
-hg clone http://hg.code.sf.net/p/ermod/code ermod
+~~~~sh
+git clone git://git.code.sf.net/p/ermod/git ermod
 cd ermod
-hg up ver03   # (or ver02)
+git checkout ver10
 ~~~~

-For further instructions, please refer to the how-to manuals of Mercurial (recommended: [Hg init](http://hginit.com/)).
-Currently, two branches are active, namely "`ver02`" and "`ver03`", which correspond to version 0.2.x (deprecated version) and version 0.3.x (stable version). 
+If you want to commit, use 
+
+For further instructions, please refer to the how-to manuals of Git.
+Currently, one branches is actively used, namely "`ver10`", which correspond to version 1.0.x. 

 If you are in "developers" group, you can instead access with

-~~~~~
-::::sh
-hg clone ssh://(your user name)@hg.code.sf.net/p/ermod/code ermod
+~~~~~sh
+git clone ssh://(yoursourceforgeusername)@git.code.sf.net/p/ermod/git ermod
 ~~~~~

 In this way, you can commit the changes to the repository.
@@ -26,64 +26,54 @@

 When you modify a program and submit the modified program into the repository,

-~~~~~
-::::sh
-hg diff
-hg commit
-hg push
+~~~~~sh
+git diff
+git add foo.F90 bar.F90 
+git commit
+git push origin ver10
 ~~~~~

-In the hg commit command, you will be asked to type comments about the modification.
-Further, it may be necessary to set up the user name in ~/.hgrc by typing
+In the git commit command, you will be asked to type comments about the modification.
+Further, it may be necessary to set up the user name in `~/.gitconfig` by typing

-~~~~~
-::::text
-[ui]
-username = Taro NIHON
+~~~~~text
+[user]
+        email = shun.sakuraba@gmail.com
+        name = Shun Sakuraba
 ~~~~~

-within the ~/.hgrc file
+within the `~/.gitconfig` file

-To reflect the program modifications in ver02 into ver03, for example, the following scheme needs be conducted.
+In the future, if we actively develop, say ver20, we need to copy some of the changes we found in ver10 (e.g. found a bug existing both branches). In such , the following scheme needs be conducted.

-~~~~~
-::::sh
-hg clone ssh://(your user name)@hg.code.sf.net/p/ermod/code ermod
-cd ermod
-hg up ver03
-hg branches
-hg merge ver02     # merge the program modifications in ver02 into ver03
-hg status
+~~~~~sh
+git checkout ver20
+git branch         # should show active branch, "ver20"
+git log ver10      # show changes to ver10 and decide whether you should incorporate
+git merge ver10    # merge the program modifications in ver10 into ver20.
+git status
 ~~~~~

-# An example output starts in case that there is a conflict in engproc.F90
-~~~~~
-::::sh
-M engproc.F90
-M setconf.F90
-? engproc.F90.orig
-~~~~~
+If merge fails (there are conflicting changes in ver10 and ver20), you have to manually resolve the merge, `git add` conflicting files, and perform `git commit`.
+(If you don't have time you can just do `git merge --abort` to get back to the state before merging

-# An example output ends
-~~~~~
-::::sh
+
+~~~~~sh
 vi engproc.F90  # Open the program and resolve the conflict
-hg resolve -m engproc.F90
-hg commit -m "merged the changes from version 02”
-hg push
+git add  engproc.F90
+git commit -m "merged the changes from version 10”
+git push origin ver10
 ~~~~~

 A program with conflict needs be modified through direct editing.
-See http://mercurial.selenic.com/wiki/TutorialConflict for the scheme, which is actually simple.
+See [[https://www.atlassian.com/git/tutorials/using-branches/merge-conflicts]]  for more information.

 Setting up autotools
 ====
 Checked out repository does not have necessary shell scripts to build the program, 
-such as `configure`, `install` and such. If your system has autotools >= 2.65,
+such as `configure`, `install` and such. If your system has autotools >= 2.69,
 the following command will install the necessary files.

-~~~~~
-::::sh
+~~~~~sh
 autoreconf -I m4 -i -s
 ~~~~~
-

doc-DevGuide modified by Nobuyuki MATUBAYASI

Nobuyuki MATUBAYASI — Fri, 06 Apr 2018 06:15:13 -0000

--- v10
+++ v11
@@ -18,7 +18,7 @@
 ~~~~~
 ::::sh
 hg clone ssh://(your user name)@hg.code.sf.net/p/ermod/code ermod
-~~~~
+~~~~~

 In this way, you can commit the changes to the repository.
 It is also possible to register your ssh public key to sourceforge; go to account service and read the instructions there. 
@@ -31,7 +31,7 @@
 hg diff
 hg commit
 hg push
-~~~~
+~~~~~

 In the hg commit command, you will be asked to type comments about the modification.
 Further, it may be necessary to set up the user name in ~/.hgrc by typing
@@ -40,7 +40,7 @@
 ::::text
 [ui]
 username = Taro NIHON
-~~~~
+~~~~~

 within the ~/.hgrc file

@@ -57,17 +57,21 @@
 ~~~~~

 # An example output starts in case that there is a conflict in engproc.F90
-... 
+~~~~~
+::::sh
 M engproc.F90
 M setconf.F90
 ? engproc.F90.orig
-...
+~~~~~
+
 # An example output ends
+~~~~~
+::::sh
 vi engproc.F90  # Open the program and resolve the conflict
 hg resolve -m engproc.F90
 hg commit -m "merged the changes from version 02”
 hg push
-~~~~
+~~~~~

 A program with conflict needs be modified through direct editing.
 See http://mercurial.selenic.com/wiki/TutorialConflict for the scheme, which is actually simple.

doc-DevGuide modified by Nobuyuki MATUBAYASI

Nobuyuki MATUBAYASI — Fri, 06 Apr 2018 06:14:02 -0000

--- v9
+++ v10
@@ -54,6 +54,8 @@
 hg branches
 hg merge ver02     # merge the program modifications in ver02 into ver03
 hg status
+~~~~~
+
 # An example output starts in case that there is a conflict in engproc.F90
 ... 
 M engproc.F90
@@ -72,7 +74,9 @@

 Setting up autotools
 ====
-Checked out repository does not have necessary shell scripts to build the program, such as `configure`, `install` and such. If your system has autotools >= 2.65, the following command will install the necessary files.
+Checked out repository does not have necessary shell scripts to build the program, 
+such as `configure`, `install` and such. If your system has autotools >= 2.65,
+the following command will install the necessary files.

 ~~~~~
 ::::sh

doc-DevGuide modified by Shun Sakuraba

Shun Sakuraba — Thu, 23 Jul 2015 08:17:01 -0000

--- v8
+++ v9
@@ -69,3 +69,13 @@

 A program with conflict needs be modified through direct editing.
 See http://mercurial.selenic.com/wiki/TutorialConflict for the scheme, which is actually simple.
+
+Setting up autotools
+====
+Checked out repository does not have necessary shell scripts to build the program, such as `configure`, `install` and such. If your system has autotools >= 2.65, the following command will install the necessary files.
+
+~~~~~
+::::sh
+autoreconf -I m4 -i -s
+~~~~~
+

doc-DevGuide modified by Nobuyuki MATUBAYASI

Nobuyuki MATUBAYASI — Sat, 06 Jun 2015 02:25:47 -0000

--- v7
+++ v8
@@ -11,7 +11,7 @@
 ~~~~

 For further instructions, please refer to the how-to manuals of Mercurial (recommended: [Hg init](http://hginit.com/)).
-Currently, two branches are active, namely "`ver02`" and "`ver03`", which correspond to version 0.2.x (stable version) and version 0.3.x (experimental version). 
+Currently, two branches are active, namely "`ver02`" and "`ver03`", which correspond to version 0.2.x (deprecated version) and version 0.3.x (stable version). 

 If you are in "developers" group, you can instead access with

doc-DevGuide modified by Nobuyuki MATUBAYASI

Nobuyuki MATUBAYASI — Tue, 13 Aug 2013 08:53:47 -0000

--- v6
+++ v7
@@ -7,7 +7,7 @@
 ::::sh
 hg clone http://hg.code.sf.net/p/ermod/code ermod
 cd ermod
-hg up ver02   # (or ver03)
+hg up ver03   # (or ver02)
 ~~~~

 For further instructions, please refer to the how-to manuals of Mercurial (recommended: [Hg init](http://hginit.com/)).

WikiPage doc-DevGuide modified by Nobuyuki MATUBAYASI

Nobuyuki MATUBAYASI — Wed, 06 Jun 2012 07:22:34 -0000

--- v5
+++ v6
@@ -43,3 +43,29 @@
 ~~~~
 
 within the ~/.hgrc file
+
+To reflect the program modifications in ver02 into ver03, for example, the following scheme needs be conducted.
+
+~~~~~
+::::sh
+hg clone ssh://(your user name)@hg.code.sf.net/p/ermod/code ermod
+cd ermod
+hg up ver03
+hg branches
+hg merge ver02     # merge the program modifications in ver02 into ver03
+hg status
+# An example output starts in case that there is a conflict in engproc.F90
+... 
+M engproc.F90
+M setconf.F90
+? engproc.F90.orig
+...
+# An example output ends
+vi engproc.F90  # Open the program and resolve the conflict
+hg resolve -m engproc.F90
+hg commit -m "merged the changes from version 02”
+hg push
+~~~~
+
+A program with conflict needs be modified through direct editing.
+See http://mercurial.selenic.com/wiki/TutorialConflict for the scheme, which is actually simple.

WikiPage doc-DevGuide modified by Nobuyuki MATUBAYASI

Nobuyuki MATUBAYASI — Wed, 02 May 2012 14:58:50 -0000

--- v4 
+++ v5 
@@ -22,4 +22,24 @@
 
 In this way, you can commit the changes to the repository.
 It is also possible to register your ssh public key to sourceforge; go to account service and read the instructions there. 
-Before submitting the code, especially when committing changes to stable branch, please make sure your code be reviewed by another developer.  
+Before submitting the code, especially when committing changes to the stable branch, please make sure your code be reviewed by another developer.
+
+When you modify a program and submit the modified program into the repository,
+
+~~~~~
+::::sh
+hg diff
+hg commit
+hg push
+~~~~
+
+In the hg commit command, you will be asked to type comments about the modification.
+Further, it may be necessary to set up the user name in ~/.hgrc by typing
+
+~~~~~
+::::text
+[ui]
+username = Taro NIHON
+~~~~
+
+within the ~/.hgrc file

WikiPage doc-DevGuide modified by Nobuyuki MATUBAYASI

Nobuyuki MATUBAYASI — Wed, 02 May 2012 09:14:05 -0000

--- v3 
+++ v4 
@@ -1,23 +1,25 @@
 Repository access
 ====
-ERMOD uses Mercurial ( http://mercurial.selenic.com/ ) as the version controlling system. With Mercurial installed, users can checkout the source code repository via http://sourceforge.net/p/ermod/code/ page, as:
-
-~~~~
-::::sh
+ERMOD uses Mercurial ( http://mercurial.selenic.com/ ) as the version controlling system.
+With Mercurial installed, user can check out the source code repository via http://sourceforge.net/p/ermod/code/ page through
+
+~~~~
+::::sh
 hg clone http://hg.code.sf.net/p/ermod/code ermod
 cd ermod
 hg up ver02   # (or ver03)
 ~~~~
 
-For further instructions please refer to the how-to manuals of Mercurial. (Recommended: [Hg init](http://hginit.com/))
+For further instructions, please refer to the how-to manuals of Mercurial (recommended: [Hg init](http://hginit.com/)).
 Currently, two branches are active, namely "`ver02`" and "`ver03`", which correspond to version 0.2.x (stable version) and version 0.3.x (experimental version). 
 
 If you are in "developers" group, you can instead access with
 
 ~~~~~
 ::::sh
 hg clone ssh://(your user name)@hg.code.sf.net/p/ermod/code ermod
 ~~~~
 
-. In this way you can commit the changes to the repository. It is also possible to register your ssh public key to sourceforge; go to account service and read the instructions there. 
+In this way, you can commit the changes to the repository.
+It is also possible to register your ssh public key to sourceforge; go to account service and read the instructions there. 
 Before submitting the code, especially when committing changes to stable branch, please make sure your code be reviewed by another developer.