Writing Makefiles - Revision history

Unhammer at 13:09, 18 February 2015

2015-02-18T13:09:47Z

Unhammer: /* Where does this $AP_SRC1 stuff come from? */

2014-12-02T09:48:25Z

Where does this $AP_SRC1 stuff come from?

Unhammer: /* Where does this $AP_SRC1 stuff come from? */

2014-12-02T09:47:37Z

Where does this $AP_SRC1 stuff come from?

Unhammer: /* Where does this $AP_SRC1 stuff come from? */

2014-12-02T09:46:10Z

Where does this $AP_SRC1 stuff come from?

Unhammer at 09:44, 2 December 2014

2014-12-02T09:44:56Z

Unhammer: /* Use .deps/.d to say that the .deps directory must be created */

2014-12-02T09:39:21Z

Use .deps/.d to say that the .deps directory must be created

Unhammer: /* Modes */

2014-03-24T18:28:03Z

Modes

Unhammer: /* Modes */

2014-03-24T18:23:51Z

Modes

Francis Tyers: /* Removing directories on make clean */

2014-03-24T16:14:34Z

Removing directories on make clean

Unhammer: /* Modes */

2014-03-24T16:01:49Z

Modes

@@ Line 1: / Line 1: @@
 Some tips for writing clean Makefile.am's in Apertium:
 {{TOCD}}
+==Use apertium-init==
+If you're creating a new monolingual module or pair, use [[apertium-init]]. It creates modules that Just Work. If you've got a problem with an old makefile, throw it all away and create a new one using [[apertium-init]].
+If you really want to debug your old makefile, read on for some tips.
 ==Modes==
 If you have <code>apertium</code> version 3.3 or higher, you can do this to simplify dealing with [[Modes]] files / modes.xml:

← Older revision		Revision as of 09:48, 2 December 2014
Line 68:		Line 68:


	;The details: The autogen.sh script passes its arguments on to the configure script. If configure.ac says e.g. <code>AP_CHECK_LING([1], [apertium-lol])</code>, then the configure script will have a --with-lang1 option to set to the location of the package apertium-lol ~~(and if~~ you don't pass --with-lang1 to autogen.sh, configure will attempt to find the location of an installed apertium-lol package using pkg-config).		;The details: The autogen.sh script passes its arguments on to the configure script. If configure.ac says e.g. <code>AP_CHECK_LING([1], [apertium-lol])</code>, then the configure script will have a --with-lang1 option to set to the location of the package apertium-lol. If you don't pass --with-lang1 to autogen.sh, configure will attempt to find the location of an ''installed'' apertium-lol package using pkg-config.

	:;The gory details: The actual configure code for all this checking is in apertium.m4, typically in /usr/share/aclocal/apertium.m4 or /usr/local/share/aclocal/apertium.m4 if you're very interested in reading m4sh code.		:;The gory details: The actual configure code for all this checking is in apertium.m4, typically in /usr/share/aclocal/apertium.m4 or /usr/local/share/aclocal/apertium.m4 if you're very interested in reading m4sh code.

@@ Line 65: / Line 65: @@
 ==Where does this $AP_SRC1 stuff come from?==
-When you do <code>./autogen.sh --with-lang1=foo</code>, the variable AP_SRC1 will be set to "foo" in the makefile.
+When you do <code>./autogen.sh --with-lang1=foo</code>, the variable AP_SRC1 will be set to "foo" in the Makefile. Your configure.ac should say something like <code>AP_CHECK_LING([1], [apertium-lol])</code> for that option to work.
-;The details: The autogen.sh script passes its arguments on to the configure script. If configure.ac says e.g. <code>AP_CHECK_LING([1], [aperitum-lol])</code>, then the configure script will have a --with-lang1 option to set to the location of the package apertium-lol (and if you don't pass --with-lang1 to autogen.sh, configure will attempt to find the location of an installed apertium-lol package using pkg-config).
+;The details: The autogen.sh script passes its arguments on to the configure script. If configure.ac says e.g. <code>AP_CHECK_LING([1], [apertium-lol])</code>, then the configure script will have a --with-lang1 option to set to the location of the package apertium-lol (and if you don't pass --with-lang1 to autogen.sh, configure will attempt to find the location of an installed apertium-lol package using pkg-config).
 :;The gory details: The actual configure code for all this checking is in apertium.m4, typically in /usr/share/aclocal/apertium.m4 or /usr/local/share/aclocal/apertium.m4 if you're very interested in reading m4sh code.

@@ Line 67: / Line 67: @@
 When you do <code>./autogen.sh --with-lang1=foo</code>, the variable AP_SRC1 will be set to "foo" in the makefile.
+;The details: The autogen.sh script passes its arguments on to the configure script. If configure.ac says e.g. <code>AP_CHECK_LING([1], [aperitum-lol])</code>, then the configure script will have a --with-lang1 option to set to the location of the package apertium-lol (and if you don't pass --with-lang1 to autogen.sh, configure will attempt to find the location of an installed apertium-lol package using pkg-config).
-The details:
-The autogen.sh script passes its arguments on to the configure script. If configure.ac says e.g. <code>AP_CHECK_LING([1], [aperitum-lol])</code>, then the configure script will have a --with-lang1 option to set to the location of the package apertium-lol (and if you don't pass --with-lang1 to autogen.sh, configure will attempt to find the location of an installed apertium-lol package using pkg-config).
-The gory details: The actual configure code for all this checking is in apertium.m4, typically in /usr/share/aclocal/apertium.m4 or /usr/local/share/aclocal/apertium.m4 if you're very interested in reading m4sh code.
+:;The gory details: The actual configure code for all this checking is in apertium.m4, typically in /usr/share/aclocal/apertium.m4 or /usr/local/share/aclocal/apertium.m4 if you're very interested in reading m4sh code.
 [[Category:Tools]]

@@ Line 2: / Line 2: @@
 {{TOCD}}
 ==Modes==
-If you have <code>apertium</code> revision 51184 or higher, you can do this to simplify dealing with [[Modes]] files / modes.xml:
+If you have <code>apertium</code> version 3.3 or higher, you can do this to simplify dealing with [[Modes]] files / modes.xml:
 In <code>configure.ac</code>, add this:
@@ Line 63: / Line 63: @@
 	-rm -rf .deps modes
 </pre>
+==Where does this $AP_SRC1 stuff come from?==
+When you do <code>./autogen.sh --with-lang1=foo</code>, the variable AP_SRC1 will be set to "foo" in the makefile.
+The details:
+The autogen.sh script passes its arguments on to the configure script. If configure.ac says e.g. <code>AP_CHECK_LING([1], [aperitum-lol])</code>, then the configure script will have a --with-lang1 option to set to the location of the package apertium-lol (and if you don't pass --with-lang1 to autogen.sh, configure will attempt to find the location of an installed apertium-lol package using pkg-config).
+The gory details: The actual configure code for all this checking is in apertium.m4, typically in /usr/share/aclocal/apertium.m4 or /usr/local/share/aclocal/apertium.m4 if you're very interested in reading m4sh code.
 [[Category:Tools]]

@@ Line 44: / Line 44: @@
 .PRECIOUS: .deps/.d
 </pre>
+(If using apertium 3.3 or higher, you can just do AP_MKINCLUDE, which includes the above .deps/.d goal.)
 And then, instead of creating the dir in each goal, just depend on .deps/.d for those goals:
 <pre>

@@ Line 4: / Line 4: @@
 If you have <code>apertium</code> revision 51184 or higher, you can do this to simplify dealing with [[Modes]] files / modes.xml:
-First add <code>AP_MKINCLUDE</code> to <code>configure.ac</code> in the language pair.
+In <code>configure.ac</code>, add this:
+<pre>AP_MKINCLUDE</pre>
-Now let your <code>Makefile.am</code> include this:
+In <code>Makefile.am</code>, add this:
 <pre>
 # Only include one mode file here, the rest will be built along with it (listing several leads to problems with parallell make):
@@ Line 13: / Line 14: @@
 @ap_include@
+# Most language pairs don't need to specify anything else for install-data-local:
 install-data-local: install-modes
 EXTRA_DIST:
 	modes.xml \
-	# other files, typically .dix and .t1x
+	# here you'll typically also have other things, like .dix and .t1x
+        # files that are to be included when you make a release
 </pre>
 ''Nowhere else should modes be mentioned in the <code>Makefile.am</code>.''
+If you follow this system, the modes with install="yes" in modes.xml will be installed, and you won't end up with root-owned modes files, and make -j4 will work fine.
 ==Use .deps/.d to say that the .deps directory must be created==

@@ Line 47: / Line 47: @@
 ==Removing directories on make clean==
-Say you want to remove .deps and modes on "make clean". Don't do </code>CLEANFILES=-rf .deps modes file1 file2 …</code>, it doesn't work everywhere.
+Say you want to remove .deps and modes on "make clean". Don't do <code>CLEANFILES=-rf .deps modes file1 file2 …</code>, it doesn't work everywhere.
 A more portable solution is this:
@@ Line 55: / Line 55: @@
 	-rm -rf .deps modes
 </pre>
+[[Category:Tools]]