Makefile - Revision history

Shirak: /* Makefile on Eos */

2017-05-06T10:35:22Z

‎Makefile on Eos

Shirak: /* Control sentences and loop sentences */

2017-05-05T08:15:46Z

‎Control sentences and loop sentences

Shirak at 08:14, 5 May 2017

2017-05-05T08:14:26Z

Shirak: /* Makefile on Eos */

2017-05-05T08:02:07Z

‎Makefile on Eos

Kinoshita: /* Makefile on Eos */

2014-07-23T07:11:47Z

‎Makefile on Eos

Kinoshita: /* Makefile on Eos */

2014-07-23T06:52:49Z

‎Makefile on Eos

Kinoshita at 06:25, 23 July 2014

2014-07-23T06:25:41Z

Kinoshita: /* EosにおけるMakefile */

2014-07-23T05:51:52Z

‎EosにおけるMakefile

Kinoshita: Created page with "'''Makefile''' ismakeコマンドを実行したときに読み込まれるテキストファイル。 makeとは、C言語などのソースファイルが複数存在して..."

2014-07-23T05:51:02Z

Created page with "'''Makefile''' ismakeコマンドを実行したときに読み込まれるテキストファイル。 makeとは、C言語などのソースファイルが複数存在して..."

New page

'''Makefile''' ismakeコマンドを実行したときに読み込まれるテキストファイル。
makeとは、C言語などのソースファイルが複数存在していても、自動で順番を把握し[[Compile]]する[[コマンド]]である。
Eosでは、makeをつかってコマンドをまとめ、大きな仕事（電子線トモグラフィーや単粒子解析など）をさせます。分散環境とストリーム実行、入出力記述の自由度の拡大を目的として、次世代makeとして、[[PIONE]]を現在開発中です。

== '''EosにおけるMakefile''' ==

[[ファイル:makefile.PNG|thumb|right|350px|Makefileの一部]]
[[3D Reconstruction]]を[[Eos]]で行う場合、ファイル数が莫大になると、1つずつ[[コマンド]]を打ち込んでいては多大な労力を必要としてしまう。
この労力を削減するために、[[Eos]]はmakeコマンドを使って実行することが必要であることが多い。
また、makefileを理解するためにはシェルスクリプトの知識も必要となる。 
 
 

.ref3d.red2d:　(1)
mrc3Dto2D -i $*.ref3d -o $*.ref2d -EulerMode YOYS InterpolationMode 0 -Rot1 0 359 $(STEP) -Rot2 0 359 $(STEP) -Rot3 0 0 $(STEP) -m 1

例えば、上記のようなMakefileがあったとして、

$ make EM.ref2d

makeコマンドを上のように実行すると、自動で拡張子.ref2dを生成する行を探し実行してくれる。

今回は(1)の部分が、拡張子.ref3dファイルから.ref2dファイルを生成するという意味を表しており、以下の部分を実行する。

mrc3Dto2D -i $*.ref3d -o $*.ref2d -EulerMode YOYS InterpolationMode 0 -Rot1 0 359 $(STEP) -Rot2 0 359 $(STEP) -Rot3 0 0 $(STEP) -m 1

この行が、先程の(1)に属していることを表すために、先頭にTabによる空行が挿入されている。
つまり、Tabによる空欄がなくなるまで、(1)に属する領域ということになる。

更に、以下のようにmakeをmakeするMakefileを作れば、複数の工程を1度のmakeで実行することができる。
このように、[[3D Reconstruction]]など複数の工程が必要な作業においてMakefileは必需品となる。

All::
make $(TARGET).ref3d;
make $(TARGET).ref2d;
make AVGs;
make -j $(JOP_NUM) corinfo;
make CORINFOs;
make $(TARGET).ds6;

@@ Line 39: / Line 39: @@
          make $(TARGET).ds6;
-Cautions on writing a Makefile
+== Cautions on writing a Makefile ==
-Differences from the shell script
+=== Differences from the shell script ===
-Variable
+Sentences in makefile are basically the same as those in shell scripts, but some are different. This is because makefile executes its commands (shell scripts) line by line. Below we describe the points related to this difference.<br>
-A value of a variable is kept only within one line. When a command is written in several lines, ; and \ should be included (see an example below). When a variable is used in the shell script,  the variable (for example variable i) is written like $i (not i). However, in Makefile, it is written with duplicated $, like  $$i.
+==== Variable ====
 	i=1 ; \
 	echo "$$i"
-'''Control sentences and loop sentences'''
+<pre>
-Control sentences and loop sentences should have their ends within a line, like
+When （conditions） or （processing）are long, use of \,  as a continuation character, is compulsory for good readability. <br>
-When （conditions） or （processing）are long, use of \,  as a continuation character, is compulsory for good readability.
+<pre>
+if [ （condition 1） ]; then \
-if [ （conditon 1） ]; then \
 	（processA）; \
 	if [ （condition 2） ]; then \
@@ Line 70: / Line 76: @@
 	（process C）; \
 fi
 for (( i=0; i<5; i++ )); \
@@ Line 76: / Line 85: @@
 	echo "$$i"; \
 done
+</pre>
 When writing this sort of sentence, use of #, as a commenting out character, needs a special attention.  Lines after # will be also commented out against your expectation. This could lead unexpected results,  therefore, again be careful in using # in those cases.
+<pre>
 for (( i=0; i<5; i++ )); \
 do \
@@ Line 86: / Line 95: @@
 #	echo "Test"; \
 done
-In this example, done is commented out. This leads to an error.
+In this example, done is commented out. This leads to an error.<br>

← Older revision		Revision as of 08:15, 5 May 2017
Line 54:		Line 54:


−	== Control sentences and loop sentences ==	+	'''Control sentences and loop sentences'''

← Older revision		Revision as of 08:14, 5 May 2017
Line 53:		Line 53:


−	Control sentences and loop sentences	+
		+	== Control sentences and loop sentences ==
		+

	Control sentences and loop sentences should have their ends within a line, like		Control sentences and loop sentences should have their ends within a line, like

← Older revision		Revision as of 08:02, 5 May 2017
Line 38:		Line 38:
	make CORINFOs;		make CORINFOs;
	make $(TARGET).ds6;		make $(TARGET).ds6;
		+
		+	Cautions on writing a Makefile
		+
		+	Differences from the shell script
		+
		+	Sentences in makefile are basically the same as those in shell scripts, but some are different. This is because makefile executes its commands (shell scripts) line by line. Below we describe the points related to this difference.
		+
		+	Variable
		+
		+	A value of a variable is kept only within one line. When a command is written in several lines, ; and \ should be included (see an example below). When a variable is used in the shell script, the variable (for example variable i) is written like $i (not i). However, in Makefile, it is written with duplicated $, like $$i.
		+
		+	i=1 ; \
		+	echo "$$i"
		+
		+
		+	Control sentences and loop sentences
		+
		+	Control sentences and loop sentences should have their ends within a line, like
		+
		+	if [ （conditions） ]; then （processing）; fi
		+
		+	When （conditions） or （processing）are long, use of \, as a continuation character, is compulsory for good readability.
		+
		+	if [ （conditon 1） ]; then \
		+	（processA）; \
		+	if [ （condition 2） ]; then \
		+	（process B）; \
		+	fi; \
		+	（process C）; \
		+	fi
		+
		+
		+	for (( i=0; i<5; i++ )); \
		+	do \
		+	echo "$$i"; \
		+	done
		+
		+
		+	When writing this sort of sentence, use of #, as a commenting out character, needs a special attention. Lines after # will be also commented out against your expectation. This could lead unexpected results, therefore, again be careful in using # in those cases.
		+
		+
		+	for (( i=0; i<5; i++ )); \
		+	do \
		+	echo "$$i"; \
		+	# echo "Test"; \
		+	done
		+
		+	In this example, done is commented out. This leads to an error.

@@ Line 6: / Line 6: @@
 [[File:makefile.PNG|thumb|right|350px|part of Makefile]]
-When performing [[3D Reconstruction]] on [[Eos]], ファイル数が莫大になると、1つずつ[[コマンド]]を打ち込んでいては多大な労力を必要としてしまう。
+When performing [[3D Reconstruction]] on [[Eos]],  if number of files is a large amount, It is necessary to a great deal of effort in how to enter [[Command]]s one at a time.
-この労力を削減するために、[[Eos]]はmakeコマンドを使って実行することが必要であることが多い。
+In order to reduce this effort, make command is used in many cases on [[Eos]].
-また、makefileを理解するためにはシェルスクリプトの知識も必要となる。<br>
+And knowledge of shell script is also required in order to understand the makefile.<br>
 <br>
 <br>
@@ Line 15: / Line 15: @@
           mrc3Dto2D -i $*.ref3d -o $*.ref2d -EulerMode YOYS InterpolationMode 0 -Rot1 0 359 $(STEP) -Rot2 0 359 $(STEP) -Rot3 0 0 $(STEP) -m 1
-例えば、上記のようなMakefileがあったとして、
+For example, when there is a Makefile as described above,
   $ make EM.ref2d
-makeコマンドを上のように実行すると、自動で拡張子.ref2dを生成する行を探し実行してくれる。
+If you execute as above the make command, it looks for  a line that generates the extension .ref2d and performs automatically.
-今回は(1)の部分が、拡張子.ref3dファイルから.ref2dファイルを生成するという意味を表しており、以下の部分を実行する。
+This time, it means that a part (1) generates .ref2d file from .ref3d file, thus it performs command as the following.
   mrc3Dto2D -i $*.ref3d -o $*.ref2d -EulerMode YOYS InterpolationMode 0 -Rot1 0 359 $(STEP) -Rot2 0 359 $(STEP) -Rot3 0 0 $(STEP) -m 1

@@ Line 25: / Line 25: @@
   mrc3Dto2D -i $*.ref3d -o $*.ref2d -EulerMode YOYS InterpolationMode 0 -Rot1 0 359 $(STEP) -Rot2 0 359 $(STEP) -Rot3 0 0 $(STEP) -m 1
-この行が、先程の(1)に属していることを表すために、先頭にTabによる空行が挿入されている。
+As meaning that this row belongs to the previous (1), Tab blank is inserted at the beginning.
-つまり、Tabによる空欄がなくなるまで、(1)に属する領域ということになる。
+Thus, as long as there is a Tab blank, it means that it belongs to X.
-更に、以下のようにmakeをmakeするMakefileを作れば、複数の工程を1度のmakeで実行することができる。
+In addtion, Makefile that makes make is able to performing to multiple works by only one make command like the following.
-このように、[[3D Reconstruction]]など複数の工程が必要な作業においてMakefileは必需品となる。
+Thus, Makefile is a necessity in works (as [[3D Reconstruction]]) that requires multiple steps.
   All::

@@ Line 1: / Line 1: @@
-'''Makefile''' ismakeコマンドを実行したときに読み込まれるテキストファイル。
+'''Makefile''' is text file that is read if executing make command.
-makeとは、C言語などのソースファイルが複数存在していても、自動で順番を把握し[[Compile]]する[[コマンド]]である。
+make is [[Command]] that performs [[compile]] in the order determined automatically, even if there are various files as C language source code.
-Eosでは、makeをつかってコマンドをまとめ、大きな仕事（電子線トモグラフィーや単粒子解析など）をさせます。分散環境とストリーム実行、入出力記述の自由度の拡大を目的として、次世代makeとして、[[PIONE]]を現在開発中です。
+On Eos, commands are summarized by using make, and perform large-scale works (Single particle analysis or Electron tomography ...). On purpose of distributed environment, stream processing, and improvement of the degree of freedom of the input and output, we are developing [[POINE]] as make of next generation.
-== '''EosにおけるMakefile''' ==
+== '''Makefile on Eos''' ==
-[[File:makefile.PNG|thumb|right|350px|Makefileの一部]]
+[[File:makefile.PNG|thumb|right|350px|part of Makefile]]
-[[3D Reconstruction]]を[[Eos]]で行う場合、ファイル数が莫大になると、1つずつ[[コマンド]]を打ち込んでいては多大な労力を必要としてしまう。
+When performing [[3D Reconstruction]] on [[Eos]], ファイル数が莫大になると、1つずつ[[コマンド]]を打ち込んでいては多大な労力を必要としてしまう。
 この労力を削減するために、[[Eos]]はmakeコマンドを使って実行することが必要であることが多い。
 また、makefileを理解するためにはシェルスクリプトの知識も必要となる。<br>