Development/Tutorials/KDE3/Makefile.am - Revision history

Neverendingo: Text replace - "" to ""

2011-06-29T20:52:13Z

Text replace - "</code>" to "</syntaxhighlight>"

Neverendingo: Text replace - "`" to ""`


2011-06-29T20:44:53Z
Text replace - "<code>" to "<syntaxhighlight lang="text">"
Show changes



Neverendingo: Text replace - "" to ""

2011-06-29T20:39:01Z
Text replace - "<code bash>" to "<syntaxhighlight lang="bash">"
Show changes


Neverendingo: Text replace - "" to ""

2011-06-29T20:36:38Z
Text replace - "<code ini>" to "<syntaxhighlight lang="ini">"

				
				
				
				
			
			← Older revision
			Revision as of 20:36, 29 June 2011
			
Line 212:
Line 212:
  The first step is to add a file called uninstall.desktop to your sources.  It can be shared among subdirectories if needed.  It should contain the following lines:   The first step is to add a file called uninstall.desktop to your sources.  It can be shared among subdirectories if needed.  It should contain the following lines:
    
− <code ini>[Desktop Entry] + <syntaxhighlight lang="ini">[Desktop Entry]
  Encoding=UTF-8   Encoding=UTF-8
  Hidden=true</code>   Hidden=true</code>



Milliams: This is not about Documentation
2007-03-04T15:58:51Z
This is not about Documentation

				
				
				
				
			
			← Older revision
			Revision as of 15:58, 4 March 2007
			
Line 1:
Line 1:
− [[Category:Documentation]]  
  {{KDE3}}   {{KDE3}}
    





Mpyne: Complete migrating the Makefile.am howto.  See you guys next week.
2007-02-22T04:19:53Z
Complete migrating the Makefile.am howto.  See you guys next week.

				
				
				
				
			
			← Older revision
			Revision as of 04:19, 22 February 2007
			
Line 1:
Line 1:
  [[Category:Documentation]]   [[Category:Documentation]]
  {{KDE3}}   {{KDE3}}
− {{movepage|http://developer.kde.org/documentation/other/makefile_am_howto/en/index.html}}  
    
  == Introduction ==   == Introduction ==
  + Original Author: David Faure (faure@kde.org)
  + 
  This is the Makefile.am HOWTO (English version).  Makefile.am is a file used to describe how to build KDE programs.  Usually each subdirectory in a KDE module has a Makefile.am.  As you may guess from the name, it is supposed to be similar to a Makefile, but it processed first by the KDE build system, then by the autotools to generate the final Makefile.   This is the Makefile.am HOWTO (English version).  Makefile.am is a file used to describe how to build KDE programs.  Usually each subdirectory in a KDE module has a Makefile.am.  As you may guess from the name, it is supposed to be similar to a Makefile, but it processed first by the KDE build system, then by the autotools to generate the final Makefile.
    
Line 300:
Line 301:
    
  You can also force a particular installation directory: <code>KDE_DOCS = kcontrol/mouse</code>   You can also force a particular installation directory: <code>KDE_DOCS = kcontrol/mouse</code>
  + 
  + == Translation Support ==
  + 
  + To make your application translatable, you must use <tt>i18n()</tt> in the code, around the English strings that appear to the user. You must also define a messages target in your toplevel Makefile.am. A script runs every night, and calls all messages targets as they are, to create the .pot files that end up in the l10n module. Then translators can create .po files that contain the translations of those messages.
  + 
  + For applications not in SVN, run <code bash>make -f admin/Makefile.common package-messages</code> to generate the .pot file and <code bash>make merge</code> for the message merge (new .pot file with old .po file).
  + 
  + {{note|You need to use a patched gettext program, available from [ftp://ftp.kde.org/pub/kde/devel/gettext-kde/ ftp.kde.org] for proper support of contextual translations and plural handling.}}
  + 
  + The messages target in the Makefile.am should simply call <tt>xgettext</tt> on the sources that contain translatable text.  This is not the same as the _SOURCES value, since _SOURCES contains .ui and .skel files that do not work with <tt>xgettext</tt>. This is why you usually use something like *.cpp *.h instead (make sure to include sub-directories, if any). So in the simple case a messages target will look like:
  + 
  + <code>messages:
  +         $(XGETTEXT) *.cpp *.h -o $(podir)/mypotfile.pot</code>
  + 
  + {{note|Just as with other Makefile rules, the second line must begin with a tab.  Also, the name of the .pot file must be ''unique'' across KDE, so it is best to use an application name or module name as the prefix, such as kofficefilters.pot.}}
  + 
  + The file name you use for the .pot file is the name of your main KInstance (for a application, it is the first argument passed to KAboutData, and for components/modules it's the name of the KInstance that you create).
  + 
  + If you have .ui (Qt Designer), .rc (XML-GUI) or .kcfg (KConfigXT) files, add <code>messages: rc.cpp</code> and the script will create rc.cpp from the ui, rc, and kcfg files in the current directory.  If you have .ui, .rc or .kcfg files in subdirectories, you need to add something like <code>$(EXTRACTRC) */*.rc >> rc.cpp</code> to the messages target, before the xgettext call (don't forget to start the line with a tab).
  + 
  + Another special case is the "tips" file &mdash; an XML file containing tips shown to the user.  In this case, use something like 
  + 
  + <code>messages:
  +         perl ./preparetips > tips.cc
  +         $(XGETTEXT) *.cpp *.h tips.cc -o $(podir)/mypotfile.pit
  +         rm -f tips.cc</code>
  + 
  + You can find the preparetips script under kdebase/ktip, for instance.  The name of the temporary tips.cc file doesn't matter.
  + 
  + The last matter is the compilation and installation of .po files.  Inside l10n, Makefile.am files contain <code>KDE_LANG = language</code> and <code>POFILES = AUTO</code> to mean that all the .po files in the directory are installed into that language.
  + 
  + If you ship a separate application and you want it to install its own .po files, you'll usually have a {{path|po/}} subdirectory, and inside the Makefile.am will simply say <code>POFILES = AUTO</code>
  + 
  + In that case, the .po files are copied depending on their name as $(PACKAGE).mo (for instance, de.po is installed under {{path|de/LC_MESSAGES/$(PACKAGE).mo}}).
  + 
  + == Qt only programs ==
  + 
  + By default the build system assumes you're building a KDE application, so it might do things which require kdecore (e.g. using klocale.h when compiling Qt Designer .ui files).  To disable this when building a Qt-only program, use <code>KDE_OPTIONS = qtonly</code>
  + 
  + == Disabling "final" compilation ==
  + 
  + To prevent the --enable-final configure option from working in a specific directory (for instance, to work on the directory when --enable-final was used for the whole module), you can either use <code bash>make no-final ; make no-final-install</code> or edit the Makefile.am and add <code>KDE_OPTIONS = nofinal</code>
  + 
  + == Things to avoid ==
  + 
  + Do ''NOT'' use the following constructs:
  + 
  + * %.foo: %.bar rules.  They are not portable.
  + * $< in a custom rule.  It's not portable.  $@ is, however.
  + * BUILT_SOURCES.  Automake doesn't support it properly, it makes $(BUILT_SOURCES) a dependency on Makefile, so e.g. they are regenerated when you call make clean twice.
  + * Obviously, don't call gcc or ld yourself.
  + 
  + == Turning Makefile.am into a Makefile ==
  + 
  + When you change a Makefile.am, if there is already a Makefile generated from it you can simply run make and the Makefile will automatically be re-generated.
  + 
  + If there is no Makefile created yet, you have two choices.
  + # Run make -f Makefile.cvs at the toplevel of the module, and re-run configure to regenerate all Makefiles.
  + # You can also use the [http://websvn.kde.org/*checkout*/branches/KDE/3.5/kdesdk/scripts/create_makefile create_makefile] script (from kdesdk/scripts, installed as part of kdesdk).
  + 
  + To use the create_makefile script, simply type <code bash>create_makefile subdir</code> in the parent directory of {{path|subdir}}.  This will create {{path|subdir/Makefile}} from {{path|subdir/Makefile.am}}.  There is also a create_makefiles script which works recursively down a directory tree.
  + 
  + == Questions? ==
  + 
  + If you're still stuck, there's several things you can do:
  + 
  + * Email the [http://www.kde.org/mailinglists/ kde-devel mailing list] with your question.
  + * You can use the Discussion tab of this wiki to request clarification of a point.
  + * Never forget that the source code for KDE is [http://websvn.kde.org/branches/KDE/3.5 available online].  It can be instructive to see how other software projects use Makefile.am.
  + * You can also ask in the #kde-devel chatroom in irc.kde.org



Mpyne: Port over most of the Makefile.am howto to techbase.  Still have to add a few more sections.
2007-02-21T04:07:06Z
Port over most of the Makefile.am howto to techbase.  Still have to add a few more sections.
Show changes


Mpyne: Development/Documentation/HOWTOs/Makefile.am moved to Development/Tutorials/KDE3/Makefile.am: Consistency with current policy for KDE3-related documentation.
2007-02-21T00:40:22Z
Development/Documentation/HOWTOs/Makefile.am moved to Development/Tutorials/KDE3/Makefile.am: Consistency with current policy for KDE3-related documentation.

			
			← Older revision
			Revision as of 00:40, 21 February 2007
			


Mpyne: Commit initial migration of Makefile.am howto
2007-02-20T04:25:17Z
Commit initial migration of Makefile.am howto
New page
[[Category:Documentation]]

{{KDE3}}

{{movepage|http://developer.kde.org/documentation/other/makefile_am_howto/en/index.html}}



== Introduction ==

This is the Makefile.am HOWTO (English version).  Makefile.am is a file used to describe how to build KDE programs.  Usually each subdirectory in a KDE module has a Makefile.am.  As you may guess from the name, it is supposed to be similar to a Makefile, but it processed first by the KDE build system, then by the autotools to generate the final Makefile.



This is the build system for KDE 3.  KDE 4 uses a different build system, [[Development/Tutorials/CMake|CMake]].



== Makefile.am for a simple program ==

<code bash># Notice the bin_ prefix.

bin_PROGRAMS = kdialog



kdialog_SOURCES = kdialog.cpp widgets.cpp

kdialog_LDADD = $(LIB_KIO)

kdialog_LDFLAGS = $(all_libraries) $(KDE_RPATH)



AM_CPPFLAGS = $(all_includes)



METASOURCES = AUTO

</code>



=== bin ===

bin means that you want to create something that will install into the bin directory of KDE. *_PROGRAMS means you want to compile a program. Use _SCRIPTS for scripts, etc. Then you can see the name of the program, which is what is used in the lines below to define what has to be done to create that program.



=== _SOURCES ===

You list all of the source files that need to be compiled for each of the PROGRAMS you have listed.  Don't include header files or other files that don't need processed in the build procedure.



=== _LDADD ===

This variable is used for each program to define the libraries that the program links to.  You can use three types of libraries references:



# A library reference as you would pass it to gcc. (Like -lfoo)

# A relative path to a Libtool library (Like {{path|../path/to/thelib.la}}).

# A library macro set by the KDE build system.  (Like $(LIB_KIO)).  It is recommended to use the macro version if set by the KDE build system.



If a library (A) depends on another library (B), you don't need to specify the dependency library (B).  But if you do, (e.g. because the dependencies on A might change), make sure you specify A before B.  So usually libtool .la libraries are first, then $(LIB_*), then -lfoo if any.



=== _LDFLAGS ===

This defines any flags that need to be passed to the linker.  Note that the flags do not get passed to the linker by using _LDADD!  These can be -L flags (to change the library search path, usually set by configure into a variable).  $(all_libraries) contains all the -L flags necessary to find Qt and KDE, so you must have it there.  For programs you should also add $(KDE_RPATH), it helps to get installed programs to find their libraries without having to set LD_LIBRARY_PATH.



=== AM_CPPFLAGS ===

These specify additional compilation flags.  This must contain $(all_includes).  This is also where other compile-time flags like -DWITHOUTBUGS and -I$(srcdir)/subdir go. {{Note|Insert -I directives before $(all_includes).  This ensures that your own headers will be used, not some older installed version.}}



Note that $(srcdir) and . (the build directory) are always included automatically.  You may find that Makefile.am files in KDE still use INCLUDES (the old name for AM_CPPFLAGS), but AM_CPPFLAGS is the recommended way to add include paths and other compilation flags.



=== KDE_CXXFLAGS ===

There is also KDE_CXXFLAGS.  It is always appended to the end of the other flags used in the build, so it can undo one of the flags set by the KDE build framework.  This is the case for exception handling support, which is disabled by default.  If you want to use exception handling you need to write <code bash>KDE_CXXFLAGS = $(USE_EXCEPTIONS)</code>



=== METASOURCES ===

METASOURCES = AUTO is the magic line that makes the KDE build system take care of the moc files automatically. It is the recommended way if all your .cpp/.cc files include their .moc file (this is the best way since it gives faster compilation), or if you are compiling a single binary/library.



In case you have multiple binaries/libraries in the same directory, you might need to use the longer form of <code bash>libfoo_la_METASOURCES = myfile.moc myotherfile.moc

mybinary_METASOURCES = someotherfile.moc</code>

← Older revision		Revision as of 15:58, 4 March 2007
Line 1:		Line 1:
−	~~[[Category:Documentation]]~~
	{{KDE3}}		{{KDE3}}