KDE TechBase - User contributions [en]

Development/ECM SourceIncompatChanges

2013-02-16T17:37:21Z

Neundorf: /* FindKDE4Internal.cmake */

=== FindFlex.cmake ===

We use the version from CMake now, which is named FindFLEX.cmake (different casing !).
Beside that there should be no changes in behaviour.

* find_package(Flex) -> find_package(FLEX)

=== FindGettext.cmake ===

We use the version from CMake now.
The syntax of GETTEXT_PROCESS_PO_FILES() changed a bit, it now needs the additional keyword "PO_FILES.

* gettext_process_po_files(de ALL INSTALL_DESTINATION ${dest} file1.po file2.po) -> gettext_process_po_files(de ALL INSTALL_DESTINATION ${dest} PO_FILES file1.po file2.po)

=== FindGIF.cmake ===

We use the version from CMake now.
There is a minor difference, which will not affect many systems. The KDE version accepted only giflib version 4, while the CMake version accepted any version of giflib. If giflib version 4 .x is required, the version can now be specified:

* find_package(GIF) -> find_package(GIF 4 )

This actually only was an issue on some relatively old Sun machines in 2006. Maybe today it is not even there a problem anymore.

=== FindLibXslt.cmake ===

We use the version from CMake 2.8.7 now.
There are two changes compared to the one in kdelibs:

* ${LIBEXSLT_LIBRARIES} -> ${LIBXSLT_EXSLT_LIBRARIES}
* WinCE is probably not supported anymore, patches are welcome

=== FindMsgfmt.cmake ===

This file does not exist anymore, use GETTEXT_MSGFMT_EXECUTABLE from [[#FindGettext.cmake]] coming with CMake instead.

=== FindPostgreSQL.cmake ===

The variable names have changed:
* POSTGRESQL_INCLUDE_DIR -> PostgreSQL_INCLUDE_DIRS
* POSTGRESQL_LIBRARIES -> PostgreSQL_LIBRARIES

=== FindRUBY.cmake ===

This file does not exist anymore, use FindRuby.cmake coming with CMake instead. Most variables are the same. Below are the changes:

* find_package(RUBY) -> find_package(Ruby)
* RUBY_INCLUDE_PATH -> RUBY_INCLUDE_DIRS

=== FindX11.cmake ===

The following two variables have been removed, use the newer ones instead:

* X11_Xss_FOUND -> X11_Xscreensaver_FOUND
* X11_Xss_LIB -> X11_Xscreensaver_LIB

The following libraries are now not part of X11_LIBRARIES anymore, so they may have to be added to target_link_libraries() explicitely where needed:

* X11_Xau_LIB
* X11_Xft_LIB
* X11_Xdmcp_LIB
* X11_Xpm_LIB

=== MacroAddCompileFlags.cmake ===

This file has been removed. Use set_property(.. APPEND_STRING) instead (new in CMake 2.8.6).

* include(MacroAddCompileFlags) -> delete
* macro_add_compile_flags(target "-O2 -g") -> set_property(TARGET target APPEND_STRING PROPERTY COMPILE_FLAGS " -O2 -g")

=== MacroAddLinkFlags.cmake ===

This file has been removed. Use set_property(.. APPEND_STRING) instead (new in CMake 2.8.6).

* include(MacroAddLinkFlags) -> delete
* macro_add_link_flags(target "-no-rpath") -> set_property(TARGET target APPEND_STRING PROPERTY LINK_FLAGS " -no-rpath")

=== MacroAdditionalCleanFiles.cmake ===

This file has been removed. Use set_property(... APPEND ...) instead.

* include(MacroAdditionalCleanFiles) -> delete
* macro_additional_clean_files(file1 file2 fileN) -> set_property(DIRECTORY APPEND PROPERTY ADDITIONAL_MAKE_CLEAN_FILES "file1;file2;fileN" )

=== MacroEnsureVersion.cmake ===

This file has been removed, use VERSION_LESS or VERSION_GREATER instead.
Example:
if ( ${MY_VERSION} VERSION_LESS ${REQUIRED_VERSION} )
# error, version is too old
endif()

=== MacroLogFeature.cmake ===

This file has been removed, instead FeatureSummary.cmake from CMake >= 2.8.6 has to be used, which has even more functionality.
Please have a look at the documentation of FeatureSummary.cmake on the cmake manpage.

* macro_log_feature(<variable> <FEATURE> <DESCRIPTION> <URL> <REQUIRED> <MIN_VERSION> <COMMENTS>) -> set_package_properties(FEATURE PROPERTIES DESCRIPTION <DESCRIPTION> URL <URL> TYPE (RUNTIME|OPTIONAL|RECOMMENDED|REQUIRED) PURPOSE "good for something")

* macro_display_feature_log() -> feature_summary(WHAT ALL FATAL_ON_MISSING_REQUIRED_PACKAGE)

=== MacroOptionalAddSubdirectory.cmake ===

This file is now part of the extra-cmake-modules package and thus has been renamed to ECMOptionalAddSubdirectory.cmake

* include(MacroOptionalAddSubdirectory) -> include (ECMOptionalAddSubdirectory)
* macro_optional_add_subdirectory(...) -> ecm_optional_add_subdirectory(...)

=== MacroOptionalDependPackage.cmake ===

This file has been removed, the purpose was broken.

* include (MacroOptionalDependPackage) -> delete
* macro_optional_depend_package() -> delete

=== MacroOptionalFindPackage.cmake ===

This file does not exist anymore. Instead, starting with CMake 2.8.6, every find_package() call which is not REQUIRED can be disabled by setting the variable CMAKE_DISABLE_FIND_PACKAGE_<PackageName> to TRUE. This makes this macro unnecessary.

* include(MacroFindPackage) -> delete
* macro_optional_find_package(Foo ...) -> find_package(Foo ... )

=== MacroPushRequiredVars.cmake ===

This file has been merged into CMake, but has been renamed to CMakePushCheckState.cmake.

* include(MacroPushRequiredVars) -> include(CMakePushCheckState)
* macro_push_required_vars() -> cmake_push_check_state()
* macro_pop_required_vars() -> cmake_pop_check_state()

=== MacroWriteBasicCMakeVersionFile.cmake ===

This macro has been merged into CMake, but has been renamed to WriteBasicConfigVersionFile.cmake, also the syntax changed slightly. To get exactly the same behaviour as with the old macro, do as shown below. For details see the documentation in the man page.

* include(MacroWriteBasicCMakeVersionFile) -> include (WriteBasicConfigVersionFile)
* macro_write_basic_cmake_version_file(<outfilename> 1 2 3) -> write_basic_config_version_file(<outfilename> VERSION 1.2.3 COMPATIBILITY AnyNewerVersion )

=== GenerateExportHeader.cmake ===

This has been added to CMake and provides the generate_export_header macro. This macro is the replacement of kde4_create_exports_header.

=== FindKDE4Internal.cmake ===

This file does not exist anymore.
Removed variables:
* MIME_INSTALL_DIR
* INFO_INSTALL_DIR
* KDE4_MIME_INSTALL_DIR
* KDE4_INFO_INSTALL_DIR
* LIB_SUFFIX : if the automatic detection does not work as it should, set LIB_INSTALL_DIR
* KDE4_CXX_FPIE_FLAGS, KDE4_PIE_LDFLAGS: not needed anymore, works automatically since CMake 2.8.11 via automatic handling of the POSITION_INDEPENDENT_CODE target property

=== KDE4Defaults.cmake ===

* test related settings have been removed. Get them now via find_package(KF5 COMPONENTS CMake)

Development/ECM SourceIncompatChanges

2013-02-15T21:00:32Z

Neundorf: /* FindKDE4Internal.cmake */

=== FindFlex.cmake ===

We use the version from CMake now, which is named FindFLEX.cmake (different casing !).
Beside that there should be no changes in behaviour.

* find_package(Flex) -> find_package(FLEX)

=== FindGettext.cmake ===

We use the version from CMake now.
The syntax of GETTEXT_PROCESS_PO_FILES() changed a bit, it now needs the additional keyword "PO_FILES.

* gettext_process_po_files(de ALL INSTALL_DESTINATION ${dest} file1.po file2.po) -> gettext_process_po_files(de ALL INSTALL_DESTINATION ${dest} PO_FILES file1.po file2.po)

=== FindGIF.cmake ===

We use the version from CMake now.
There is a minor difference, which will not affect many systems. The KDE version accepted only giflib version 4, while the CMake version accepted any version of giflib. If giflib version 4 .x is required, the version can now be specified:

* find_package(GIF) -> find_package(GIF 4 )

This actually only was an issue on some relatively old Sun machines in 2006. Maybe today it is not even there a problem anymore.

=== FindLibXslt.cmake ===

We use the version from CMake 2.8.7 now.
There are two changes compared to the one in kdelibs:

* ${LIBEXSLT_LIBRARIES} -> ${LIBXSLT_EXSLT_LIBRARIES}
* WinCE is probably not supported anymore, patches are welcome

=== FindMsgfmt.cmake ===

This file does not exist anymore, use GETTEXT_MSGFMT_EXECUTABLE from [[#FindGettext.cmake]] coming with CMake instead.

=== FindPostgreSQL.cmake ===

The variable names have changed:
* POSTGRESQL_INCLUDE_DIR -> PostgreSQL_INCLUDE_DIRS
* POSTGRESQL_LIBRARIES -> PostgreSQL_LIBRARIES

=== FindRUBY.cmake ===

This file does not exist anymore, use FindRuby.cmake coming with CMake instead. Most variables are the same. Below are the changes:

* find_package(RUBY) -> find_package(Ruby)
* RUBY_INCLUDE_PATH -> RUBY_INCLUDE_DIRS

=== FindX11.cmake ===

The following two variables have been removed, use the newer ones instead:

* X11_Xss_FOUND -> X11_Xscreensaver_FOUND
* X11_Xss_LIB -> X11_Xscreensaver_LIB

The following libraries are now not part of X11_LIBRARIES anymore, so they may have to be added to target_link_libraries() explicitely where needed:

* X11_Xau_LIB
* X11_Xft_LIB
* X11_Xdmcp_LIB
* X11_Xpm_LIB

=== MacroAddCompileFlags.cmake ===

This file has been removed. Use set_property(.. APPEND_STRING) instead (new in CMake 2.8.6).

* include(MacroAddCompileFlags) -> delete
* macro_add_compile_flags(target "-O2 -g") -> set_property(TARGET target APPEND_STRING PROPERTY COMPILE_FLAGS " -O2 -g")

=== MacroAddLinkFlags.cmake ===

This file has been removed. Use set_property(.. APPEND_STRING) instead (new in CMake 2.8.6).

* include(MacroAddLinkFlags) -> delete
* macro_add_link_flags(target "-no-rpath") -> set_property(TARGET target APPEND_STRING PROPERTY LINK_FLAGS " -no-rpath")

=== MacroAdditionalCleanFiles.cmake ===

This file has been removed. Use set_property(... APPEND ...) instead.

* include(MacroAdditionalCleanFiles) -> delete
* macro_additional_clean_files(file1 file2 fileN) -> set_property(DIRECTORY APPEND PROPERTY ADDITIONAL_MAKE_CLEAN_FILES "file1;file2;fileN" )

=== MacroEnsureVersion.cmake ===

This file has been removed, use VERSION_LESS or VERSION_GREATER instead.
Example:
if ( ${MY_VERSION} VERSION_LESS ${REQUIRED_VERSION} )
# error, version is too old
endif()

=== MacroLogFeature.cmake ===

This file has been removed, instead FeatureSummary.cmake from CMake >= 2.8.6 has to be used, which has even more functionality.
Please have a look at the documentation of FeatureSummary.cmake on the cmake manpage.

* macro_log_feature(<variable> <FEATURE> <DESCRIPTION> <URL> <REQUIRED> <MIN_VERSION> <COMMENTS>) -> set_package_properties(FEATURE PROPERTIES DESCRIPTION <DESCRIPTION> URL <URL> TYPE (RUNTIME|OPTIONAL|RECOMMENDED|REQUIRED) PURPOSE "good for something")

* macro_display_feature_log() -> feature_summary(WHAT ALL FATAL_ON_MISSING_REQUIRED_PACKAGE)

=== MacroOptionalAddSubdirectory.cmake ===

This file is now part of the extra-cmake-modules package and thus has been renamed to ECMOptionalAddSubdirectory.cmake

* include(MacroOptionalAddSubdirectory) -> include (ECMOptionalAddSubdirectory)
* macro_optional_add_subdirectory(...) -> ecm_optional_add_subdirectory(...)

=== MacroOptionalDependPackage.cmake ===

This file has been removed, the purpose was broken.

* include (MacroOptionalDependPackage) -> delete
* macro_optional_depend_package() -> delete

=== MacroOptionalFindPackage.cmake ===

This file does not exist anymore. Instead, starting with CMake 2.8.6, every find_package() call which is not REQUIRED can be disabled by setting the variable CMAKE_DISABLE_FIND_PACKAGE_<PackageName> to TRUE. This makes this macro unnecessary.

* include(MacroFindPackage) -> delete
* macro_optional_find_package(Foo ...) -> find_package(Foo ... )

=== MacroPushRequiredVars.cmake ===

This file has been merged into CMake, but has been renamed to CMakePushCheckState.cmake.

* include(MacroPushRequiredVars) -> include(CMakePushCheckState)
* macro_push_required_vars() -> cmake_push_check_state()
* macro_pop_required_vars() -> cmake_pop_check_state()

=== MacroWriteBasicCMakeVersionFile.cmake ===

This macro has been merged into CMake, but has been renamed to WriteBasicConfigVersionFile.cmake, also the syntax changed slightly. To get exactly the same behaviour as with the old macro, do as shown below. For details see the documentation in the man page.

* include(MacroWriteBasicCMakeVersionFile) -> include (WriteBasicConfigVersionFile)
* macro_write_basic_cmake_version_file(<outfilename> 1 2 3) -> write_basic_config_version_file(<outfilename> VERSION 1.2.3 COMPATIBILITY AnyNewerVersion )

=== GenerateExportHeader.cmake ===

This has been added to CMake and provides the generate_export_header macro. This macro is the replacement of kde4_create_exports_header.

=== FindKDE4Internal.cmake ===

This file does not exist anymore.
Removed variables:
* MIME_INSTALL_DIR
* INFO_INSTALL_DIR
* KDE4_MIME_INSTALL_DIR
* KDE4_INFO_INSTALL_DIR
* LIB_SUFFIX : if the automatic detection does not work as it should, set LIB_INSTALL_DIR

=== KDE4Defaults.cmake ===

* test related settings have been removed. Get them now via find_package(KF5 COMPONENTS CMake)

Development/ECM SourceIncompatChanges

2013-02-15T20:51:57Z

Neundorf: /* FindKDE4Internal.cmake */

Development/ECM SourceIncompatChanges

2013-02-15T20:48:13Z

Neundorf:

Development/ECM SourceIncompatChanges

2012-10-27T14:57:13Z

Neundorf: /* FindPostgreSQL.cmake */

Development/ECM SourceIncompatChanges

2012-10-27T14:55:40Z

Neundorf: /* FindMsgfmt.cmake */

=== FindFlex.cmake ===

We use the version from CMake now, which is named FindFLEX.cmake (different casing !).
Beside that there should be no changes in behaviour.

* find_package(Flex) -> find_package(FLEX)

=== FindGettext.cmake ===

We use the version from CMake now.
The syntax of GETTEXT_PROCESS_PO_FILES() changed a bit, it now needs the additional keyword "PO_FILES.

* gettext_process_po_files(de ALL INSTALL_DESTINATION ${dest} file1.po file2.po) -> gettext_process_po_files(de ALL INSTALL_DESTINATION ${dest} PO_FILES file1.po file2.po)

=== FindGIF.cmake ===

We use the version from CMake now.
There is a minor difference, which will not affect many systems. The KDE version accepted only giflib version 4, while the CMake version accepted any version of giflib. If giflib version 4 .x is required, the version can now be specified:

* find_package(GIF) -> find_package(GIF 4 )

This actually only was an issue on some relatively old Sun machines in 2006. Maybe today it is not even there a problem anymore.

=== FindLibXslt.cmake ===

We use the version from CMake 2.8.7 now.
There are two changes compared to the one in kdelibs:

* ${LIBEXSLT_LIBRARIES} -> ${LIBXSLT_EXSLT_LIBRARIES}
* WinCE is probably not supported anymore, patches are welcome

=== FindMsgfmt.cmake ===

This file does not exist anymore, use GETTEXT_MSGFMT_EXECUTABLE from [[#FindGettext.cmake]] coming with CMake instead.

=== FindPostgreSQL.cmake ===

The variable names have changed:

=== FindRUBY.cmake ===

This file does not exist anymore, use FindRuby.cmake coming with CMake instead. Most variables are the same. Below are the changes:

* find_package(RUBY) -> find_package(Ruby)
* RUBY_INCLUDE_PATH -> RUBY_INCLUDE_DIRS

=== FindX11.cmake ===

The following two variables have been removed, use the newer ones instead:

* X11_Xss_FOUND -> X11_Xscreensaver_FOUND
* X11_Xss_LIB -> X11_Xscreensaver_LIB

The following libraries are now not part of X11_LIBRARIES anymore, so they may have to be added to target_link_libraries() explicitely where needed:

* X11_Xau_LIB
* X11_Xft_LIB
* X11_Xdmcp_LIB
* X11_Xpm_LIB

=== MacroAddCompileFlags.cmake ===

This file has been removed. Use set_property(.. APPEND_STRING) instead (new in CMake 2.8.6).

* include(MacroAddCompileFlags) -> delete
* macro_add_compile_flags(target "-O2 -g") -> set_property(TARGET target APPEND_STRING PROPERTY COMPILE_FLAGS " -O2 -g")

=== MacroAddLinkFlags.cmake ===

This file has been removed. Use set_property(.. APPEND_STRING) instead (new in CMake 2.8.6).

* include(MacroAddLinkFlags) -> delete
* macro_add_link_flags(target "-no-rpath") -> set_property(TARGET target APPEND_STRING PROPERTY LINK_FLAGS " -no-rpath")

=== MacroAdditionalCleanFiles.cmake ===

This file has been removed. Use set_property(... APPEND ...) instead.

* include(MacroAdditionalCleanFiles) -> delete
* macro_additional_clean_files(file1 file2 fileN) -> set_property(DIRECTORY APPEND PROPERTY ADDITIONAL_MAKE_CLEAN_FILES "file1;file2;fileN" )

=== MacroEnsureVersion.cmake ===

This file has been removed, use VERSION_LESS or VERSION_GREATER instead.
Example:
if ( ${MY_VERSION} VERSION_LESS ${REQUIRED_VERSION} )
# error, version is too old
endif()

=== MacroLogFeature.cmake ===

This file has been removed, instead FeatureSummary.cmake from CMake >= 2.8.6 has to be used, which has even more functionality.
Please have a look at the documentation of FeatureSummary.cmake on the cmake manpage.

* macro_log_feature(<variable> <FEATURE> <DESCRIPTION> <URL> <REQUIRED> <MIN_VERSION> <COMMENTS>) -> set_package_properties(FEATURE PROPERTIES DESCRIPTION <DESCRIPTION> URL <URL> TYPE (RUNTIME|OPTIONAL|RECOMMENDED|REQUIRED) PURPOSE "good for something")

* macro_display_feature_log() -> feature_summary(WHAT ALL FATAL_ON_MISSING_REQUIRED_PACKAGE)

=== MacroOptionalAddSubdirectory.cmake ===

This file is now part of the extra-cmake-modules package and thus has been renamed to ECMOptionalAddSubdirectory.cmake

* include(MacroOptionalAddSubdirectory) -> include (ECMOptionalAddSubdirectory)
* macro_optional_add_subdirectory(...) -> ecm_optional_add_subdirectory(...)

=== MacroOptionalDependPackage.cmake ===

This file has been removed, the purpose was broken.

* include (MacroOptionalDependPackage) -> delete
* macro_optional_depend_package() -> delete

=== MacroOptionalFindPackage.cmake ===

This file does not exist anymore. Instead, starting with CMake 2.8.6, every find_package() call which is not REQUIRED can be disabled by setting the variable CMAKE_DISABLE_FIND_PACKAGE_<PackageName> to TRUE. This makes this macro unnecessary.

* include(MacroFindPackage) -> delete
* macro_optional_find_package(Foo ...) -> find_package(Foo ... )

=== MacroPushRequiredVars.cmake ===

This file has been merged into CMake, but has been renamed to CMakePushCheckState.cmake.

* include(MacroPushRequiredVars) -> include(CMakePushCheckState)
* macro_push_required_vars() -> cmake_push_check_state()
* macro_pop_required_vars() -> cmake_pop_check_state()

=== MacroWriteBasicCMakeVersionFile.cmake ===

This macro has been merged into CMake, but has been renamed to WriteBasicConfigVersionFile.cmake, also the syntax changed slightly. To get exactly the same behaviour as with the old macro, do as shown below. For details see the documentation in the man page.

* include(MacroWriteBasicCMakeVersionFile) -> include (WriteBasicConfigVersionFile)
* macro_write_basic_cmake_version_file(<outfilename> 1 2 3) -> write_basic_config_version_file(<outfilename> VERSION 1.2.3 COMPATIBILITY AnyNewerVersion )

=== GenerateExportHeader.cmake ===

This has been added to CMake and provides the generate_export_header macro. This macro is the replacement of kde4_create_exports_header.

Policies/CMake Coding Style

2012-01-15T13:46:58Z

Neundorf:

This document describes the recommended coding style for CMake files in KDE, i.e. CMakeLists.txt files and *.cmake files.

=General=

To put in in one sentence: be as careful when writing the CMake files as when you are writing C++ code.

==Indentation==

Indent all code correctly, i.e. the body of

* if/else/endif
* foreach/endforeach
* while/endwhile
* macro/endmacro
* function/endfunction

Use spaces for indenting, 2, 3 or 4 spaces preferably. Use the same amount
of spaces for indenting as is used in the rest of the file. Do not use tabs.

==Upper/lower casing==

Most important: use consistent upper- or lowercasing within one file !

In general, in KDE the '''all-lowercase''' style is preferred.

So, this is recommended:
<syntaxhighlight lang="cmake">
add_executable(foo foo.c)
</syntaxhighlight>

This is also acceptable:

<syntaxhighlight lang="cmake">
ADD_EXECUTABLE(bar bar.c)
</syntaxhighlight>

Mixed casing as shown below works too, but should '''not''' be done within KDE:
<pre>
Add_Executable(hello hello.c)
aDd_ExEcUtAbLe(blub blub.c)
</pre>

== End commands ==

To make the code easier to read, use empty commands for endforeach(), endif(), endfunction(), endmacro() and endwhile(). Also, use empty else() commands.

For example, do this:
<syntaxhighlight lang="cmake">
if(FOOVAR)
some_command(...)
else()
another_command(...)
endif()
</syntaxhighlight>

and '''not''' this:
<pre>
if(BARVAR)
some_other_command(...)
endif(BARVAR)
</pre>

=Writing CMake Find-modules=

==(Not) Using pkg-config==

You are free to use pkg-config in FindXXX.cmake modules, as long as the following conditions are met:
* the FindXXX.cmake must also work without pkg-config, as long as the package is either installed to one of the default locations (as /usr or /usr/local) or if CMAKE_PREFIX_PATH is set accordingly
* use only find_package(PkgConfig), don't use include(UsePkgConfig), this one is deprecated
* make sure the variables created by pkg_check_modules() are all prefixed with "PC_", so they don't mix up with other variables, e.g. set via find_path() etc.
* FindLibXml2.cmake as shipped with CMake 2.8.5 is a good example how pkg-config should be handled
* putting something like if(NOT WIN32) around the pkg-config stuff is not necessary (and should be removed if it is somewhere). If pkg-config is not found, e.g. on Windows, the macros simply do nothing.

==Follow CMake's readme.txt==

Follow the style guide from CMake when writing some FindFoo.cmake module:
[http://www.cmake.org/cgi-bin/viewcvs.cgi/Modules/readme.txt?root=CMake&view=markup readme.txt]

==Use FindPackageHandleStandardArgs.cmake==
For checking the results inside the Find-module, the macro find_package_handle_standard_args() (coming with CMake) should be used, using the new extended syntax, which supports also version checking.

==Avoid Micro-Optimzations==
Micro-optimizations like
<pre>
if(FOO_LIBRARY AND FOO_INCLUDE_DIR)
set(FOO_FOUND TRUE)
else()
... execute the whole find-logic
endif()
</pre>
should be removed, the find-logic should be executed always. These shortcuts can cause problems e.g. when the same file is used from multiple directories but e.g. with different required versions or components etc.

Also manually quieting the module should not be done:
<pre>
if ( SQLITE_INCLUDE_DIR AND SQLITE_LIBRARIES )
set(Sqlite_FIND_QUIETLY TRUE)
endif ( SQLITE_INCLUDE_DIR AND SQLITE_LIBRARIES )
</pre>

If find_package_handle_standard_args() is used, this is completely unnecessary, since find_package_handle_standard_args() only prints something if the result has changed compared to the previous run. So if, as in this example, sqlite has already been found, find_package_handle_standard_args() will only print this information during the first CMake run, but not on successive runs.

So, do not add such code. It is unnecessary and makes the modules look more complicated than necessary.

=Writing FooConfig.cmake files=

* See http://quickgit.kde.org/?p=kdeexamples.git&a=tree&hb=HEAD&f=buildsystem/HowToInstallALibrary for a fully commented example

* See also:
** http://www.cmake.org/Wiki/CMake/Tutorials/Exporting_and_Importing_Targets
** http://www.cmake.org/Wiki/CMake/Tutorials/How_to_create_a_ProjectConfig.cmake_file
** http://www.cmake.org/Wiki/CMake/Tutorials/Packaging

Policies/CMake Coding Style

2012-01-15T13:39:31Z

Neundorf:

2011-08-03T20:43:32Z

Neundorf:

Development/ECM SourceIncompatChanges

2011-08-02T20:19:00Z

Neundorf:

=== FindGIF.cmake ===

We use the version from CMake now.
There is a minor difference, which will not affect many systems. The KDE version accepted only giflib version 4, while the CMake version accepted any version of giflib. If giflib version 4 .x is required, the version can now be specified:

* find_package(GIF) -> find_package(GIF 4 )

This actually only was an issue on some relatively old Sun machines in 2006. Maybe today it is not even there a problem anymore.

=== FindRUBY.cmake ===

This file does not exist anymore, use FindRuby.cmake coming with CMake instead. Most variables are the same. Below are the changes:

* find_package(RUBY) -> find_package(Ruby)
* RUBY_INCLUDE_PATH -> RUBY_INCLUDE_DIRS

=== MacroAddCompileFlags.cmake ===

This file has been removed. Use set_property(.. APPEND_STRING) instead (new in CMake 2.8.6).

* include(MacroAddCompileFlags) -> delete
* macro_add_compile_flags(target "-O2 -g") -> set_property(TARGET target APPEND_STRING PROPERTY COMPILE_FLAGS " -O2 -g")

=== MacroAddLinkFlags.cmake ===

This file has been removed. Use set_property(.. APPEND_STRING) instead (new in CMake 2.8.6).

* include(MacroAddLinkFlags) -> delete
* macro_add_link_flags(target "-no-rpath") -> set_property(TARGET target APPEND_STRING PROPERTY LINK_FLAGS " -no-rpath")

=== MacroAdditionalCleanFiles.cmake ===

This file has been removed. Use set_property(... APPEND ...) instead.

* include(MacroAdditionalCleanFiles) -> delete
* macro_additional_clean_files(file1 file2 fileN) -> set_property(DIRECTORY APPEND PROPERTY ADDITIONAL_MAKE_CLEAN_FILES "file1;file2;fileN" )

=== MacroOptionalAddSubdirectory.cmake ===

This file is now part of the extra-cmake-modules package and thus has been renamed to ECMOptionalAddSubdirectory.cmake

* include(MacroOptionalAddSubdirectory) -> include (ECMOptionalAddSubdirectory)
* macro_optional_add_subdirectory(...) -> ecm_optional_add_subdirectory(...)

=== MacroOptionalDependPackage.cmake ===

This file has been removed, the purpose was broken.

* include (MacroOptionalDependPackage) -> delete
* macro_optional_depend_package() -> delete

=== MacroOptionalFindPackage.cmake ===

This file does not exist anymore. Instead, starting with CMake 2.8.6, every find_package() call which is not REQUIRED can be disabled by setting the variable CMAKE_DISABLE_FIND_PACKAGE_<PackageName> to TRUE. This makes this macro unnecessary.

* include(MacroFindPackage) -> delete
* macro_optional_find_package(Foo ...) -> find_package(Foo ... )

=== MacroPushRequiredVars.cmake ===

This file has been merged into CMake, but has been renamed to CMakePushCheckState.cmake.

* include(MacroPushRequiredVars) -> include(CMakePushCheckState)
* macro_push_required_vars() -> cmake_push_check_state()
* macro_pop_required_vars() -> cmake_pop_check_state()

Development/ECM SourceIncompatChanges

2011-07-26T19:24:58Z

Neundorf:

=== FindRUBY.cmake ===

This file does not exist anymore, use FindRuby.cmake coming with CMake instead. Most variables are the same. Below are the changes:

* find_package(RUBY) -> find_package(Ruby)
* RUBY_INCLUDE_PATH -> RUBY_INCLUDE_DIRS

=== MacroAddCompileFlags.cmake ===

This file has been removed. Use set_property(.. APPEND_STRING) instead (new in CMake 2.8.6).

* include(MacroAddCompileFlags) -> delete
* macro_add_compile_flags(target "-O2 -g") -> set_property(TARGET target APPEND_STRING PROPERTY COMPILE_FLAGS " -O2 -g")

=== MacroAddLinkFlags.cmake ===

This file has been removed. Use set_property(.. APPEND_STRING) instead (new in CMake 2.8.6).

* include(MacroAddLinkFlags) -> delete
* macro_add_link_flags(target "-no-rpath") -> set_property(TARGET target APPEND_STRING PROPERTY LINK_FLAGS " -no-rpath")

=== MacroAdditionalCleanFiles.cmake ===

This file has been removed. Use set_property(... APPEND ...) instead.

* include(MacroAdditionalCleanFiles) -> delete
* macro_additional_clean_files(file1 file2 fileN) -> set_property(DIRECTORY APPEND PROPERTY ADDITIONAL_MAKE_CLEAN_FILES "file1;file2;fileN" )

=== MacroOptionalAddSubdirectory.cmake ===

This file is now part of the extra-cmake-modules package and thus has been renamed to ECMOptionalAddSubdirectory.cmake

* include(MacroOptionalAddSubdirectory) -> include (ECMOptionalAddSubdirectory)
* macro_optional_add_subdirectory(...) -> ecm_optional_add_subdirectory(...)

=== MacroOptionalDependPackage.cmake ===

This file has been removed, the purpose was broken.

* include (MacroOptionalDependPackage) -> delete
* macro_optional_depend_package() -> delete

=== MacroOptionalFindPackage.cmake ===

This file does not exist anymore. Instead, starting with CMake 2.8.6, every find_package() call which is not REQUIRED can be disabled by setting the variable CMAKE_DISABLE_FIND_PACKAGE_<PackageName> to TRUE. This makes this macro unnecessary.

* include(MacroFindPackage) -> delete
* macro_optional_find_package(Foo ...) -> find_package(Foo ... )

=== MacroPushRequiredVars.cmake ===

This file has been merged into CMake, but has been renamed to CMakePushCheckState.cmake.

* include(MacroPushRequiredVars) -> include(CMakePushCheckState)
* macro_push_required_vars() -> cmake_push_check_state()
* macro_pop_required_vars() -> cmake_pop_check_state()

Development/ECM SourceIncompatChanges

2011-07-10T18:21:58Z

2011-07-08T19:47:31Z

Neundorf:

{{Template:I18n/Language Navigation Bar|Development/CMake}}

This is the central directory of all [http://www.cmake.org CMake]-related pages on TechBase.

== KDE4 Specific CMake Documentation==

;[[Development/Tutorials/CMake|CMake tutorial]]
:''An introduction to using CMake for KDE4''

;[[Development/CMake_FAQ|KDE's CMake FAQ]]
:''Some Frequently Asked Questions''

;[http://api.kde.org/cmake/modules.html KDE CMake modules API]
:''Documentation for all CMake modules in kdelibs (generated from kdelibs svn)''

;[[Development/CMake/DashboardBuilds|Nightly dashboard builds for KDE]]
: ''Describes the quality dashboard for KDE and how to set up Nightly builds for it''

;[[Development/CMake/Addons for KDE|KDE4 CMake Buildtypes, macros and variables]]
:''Documentation for the buildtypes (debugfull, release, ...), macros and variables for building KDE4 software, provided by FindKDE4Internal.cmake (manually written)''

;[[Development/Tools/Automoc4|Automoc4]]
:''Automoc4 documentation.''

;[[Development/CMake/Python|CMake for Python projects]]
:''How to integrate a Python project into the KDE4 cmake system.''

==Policies==

;[[Policies/CMake_Commit_Policy|Commit Policy for kdelibs/cmake/modules/]]
:''The files in kdelibs/cmake/modules/ are part of the public interface of KDE, some special policies apply to committing there.''

;[[Policies/CMake_and_Source_Compatibility|Source compatiblity with CMake]]
:''This page discusses what has to be taken care of in order to stay source compatible on the CMake level.''

;[[Policies/CMake_Coding_Style|Coding style for CMake files]]
:''Some guidelines how to write CMake scripts in KDE.''

==Changelog for KDE's CMake buildsystem==

;[[Development/CMake_KDE_4_5 |Changes in the buildsystem with KDE 4.5]]
:''What has changed in KDE 4.5 compared to KDE 4.4''

;[[Development/CMake_KDE_4_4 |Changes in the buildsystem with KDE 4.4]]
:''What has changed in KDE 4.4 compared to KDE 4.3''

;[[Development/CMake_KDE_4_3 |Changes in the buildsystem with KDE 4.3]]
:''What has changed in KDE 4.3 compared to KDE 4.2''

;[[Development/CMake_KDE_4_2 |Changes in the buildsystem with KDE 4.2]]
:''What has changed in KDE 4.2 compared to KDE 4.0/4.1''

==Extra-CMake-Modules==
* [[Development/ECM_SourceIncompatChanges|Source Incompatible changes]]

==More Places to learn about CMake==

Here are some good places to learn about CMake in general:
* [http://www.cmake.org/HTML/Documentation.html CMake Manual]
* [http://www.cmake.org/Wiki/CMake CMake Wiki]
* [http://www.cmake.org/Wiki/CMake_HowToDoPlatformChecks CMake System Checks ]
* [http://www.cmake.org/Wiki/CMake_HowToFindInstalledSoftware Finding Optional Packages ]
* [http://www.cmake.org/Wiki/HowToBuildKDE4Software KDE 4 Tutorial at the CMake Wiki ]
* [http://www.cmake.org/Wiki/CMake_FAQ CMake FAQ]
* [http://www.elpauer.org/stuff/learning_cmake.pdf Slides for the "Learning CMake" seminar]
* [http://mail.kde.org/pipermail/kde-buildsystem/ The kde-buildsystem Mailing List Archive]

Also, consider joining the [http://www.cmake.org/mailman/listinfo/cmake CMake mailing list].

Development

2011-05-15T11:49:37Z

Neundorf:

__NOEDITSECTION__ __NOTOC__ {{Template:I18n/Language Navigation Bar|Development}}
{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
|-
|colspan=2|[[Image:Discover.png|noframe]]
|-
| style="padding-left: 50px;" |[[Image:Action_launch.svg|noframe|left|40px]] ||
;[[Development/Architecture|KDE Architecture]]
:Architectural design documents explaining KDE technologies.
:''Related'': [http://api.kde.org API Documentation]
|-
| style="padding-left: 50px;"|[[Image:Action_configure.svg|noframe|left|40px]] ||
;[[Development/Tutorials|Programming Tutorials]]
:Step by step tutorials for KDE development.
:''Related:'' [[Development/Tools|Development Tools]] | [[Development/FAQs|FAQs]]
|-
| style="padding-left: 50px;"|[[Image:Action_rebuild.svg|noframe|left|40px]] ||
;[[Development/Languages|Programming Languages]]
:Supported programming languages for KDE development.
|-
| style="padding-left: 50px;"|[[Image:CMake-logo-48.png|noframe|left|48px]] ||
;[[Development/CMake|CMake]]
:CMake related information.
|-
| style="padding-left: 50px;"|[[Image:Git_icon.png|noframe|left|48px]] ||
;[[Development/Git|Version-control System - Git]]
:Git related information.
|-
| style="padding-left: 50px;" |[[Image:Action_note.svg|noframe|left|40px]] ||
;[[Development/Guidelines|Standards & Guidelines]]
:Developer guidelines and technical standards KDE uses.
:''Related:'' [[Policies|Code Contribution and Development Policies]] | [[Development/Further Information|Further Information]] (links, books, blogs, etc.)
|-
| style="padding-left: 50px;" |[[Image:Action_tool.svg|noframe|left|40px]] ||
;[[Development/Software Engineering Framework|Software Engineering Framework]]
:Software Engineering tools and processes used by KDE.
|-
| style="padding-left: 50px;" |[[Image:Action_help.svg|noframe|left|40px]] ||
;[[Development/Getting Help|Getting Help]]
:Resources for finding help with KDE development.
|-
|}

File:Git icon.png

2011-05-15T11:46:21Z

Neundorf: git icon from http://commons.wikimedia.org/wiki/File:Git_icon.svg

git icon from http://commons.wikimedia.org/wiki/File:Git_icon.svg

Development/Tutorials/Git/GitQuickStart

2011-05-15T11:36:51Z

Neundorf: /* Pushing your changes */

== Getting the sources from git ==
* head over to https://projects.kde.org/projects . There you'll see a long list with all the projects hosted on KDE git.
* find the project you are interested in, and click the link, e.g. to Attica
* on the Attica project page, go to the repository page. There you will find the clone command.
* Execute this clone command and you'll get a copy of the sources:
$ git clone git://anongit.kde.org/attica

== Pushing your changes ==

If you followed the steps above, you now have a clone of the git repository.

In order to be able to commit your changes, you need
* tell git to push to git.kde.org, instead of anongit.kde.org
* to setup a ssh key for authentication
* tell ssh to use that key for git.kde.org

In the following we go through this step by step

=== Telling git to push to git.kde.org ===

Above, we got the sources from anongit.kde.org. These are mirrors of git.kde.org and should for performance reasons be used for obtaining the sources. But for committing git.kde.org has to be used.

This is done by putting the following into ~/.gitconfig:

[url "git@git.kde.org:"]
pushInsteadOf = git://anongit.kde.org/

=== Setting up ssh keys for authentication ===

* create a set of keys to use using ssh-keygen, and name the key e.g. id_rsa.kde.
* log in to https://identity.kde.org/
* go to "Profile" -> "Edit" -> "Edit public ssh keys"
* upload the public key you just created

=== Tell ssh to use this key ===

* put the following in your ~/.ssh/config :

Host git.kde.org
User git
IdentityFile ~/.ssh/id_rsa.kde

* now you should be able to push your changes to the central git repository:
$ git push

Development/Tutorials/Git/GitQuickStart

2011-05-15T11:31:44Z

Neundorf: /* Getting the sources from git */

Development/Tutorials/Git/GitQuickStart

2011-05-15T11:30:58Z

Neundorf: /* Pushing your changes */

== Getting the sources from git ==
* head over to https://projects.kde.org/projects . There you'll see a long list with all the projects hosted on KDE git.
* find the project you are interested in, and click the link, e.g. to Attica
* on the Attica project page, go to the repository page. There you will find the clone command.
* Execute this clone command and you'll get a copy of the sources: $ git clone git://anongit.kde.org/attica

== Pushing your changes ==

If you followed the steps above, you now have a clone of the git repository.

In order to be able to commit your changes, you need
* tell git to push to git.kde.org, instead of anongit.kde.org
* to setup a ssh key for authentication
* tell ssh to use that key for git.kde.org

In the following we go through this step by step

=== Telling git to push to git.kde.org ===

Above, we got the sources from anongit.kde.org. These are mirrors of git.kde.org and should for performance reasons be used for obtaining the sources. But for committing git.kde.org has to be used.

This is done by putting the following into ~/.gitconfig:

[url "git@git.kde.org:"]
pushInsteadOf = git://anongit.kde.org/

=== Setting up ssh keys for authentication ===

* create a set of keys to use using ssh-keygen, and name the key e.g. id_rsa.kde.
* log in to https://identity.kde.org/
* go to "Profile" -> "Edit" -> "Edit public ssh keys"
* upload the public key you just created

=== Tell ssh to use this key ===

* put the following in your ~/.ssh/config :

Host git.kde.org
User git
IdentityFile ~/.ssh/id_rsa.kde

2011-04-28T20:28:45Z

Neundorf: Replaced content with '{{warning|This page is obsolete. Proceed to Development/Git. }}'

{{warning|This page is obsolete. Proceed to [[Development/Git]]. }}

Development/Tutorials/Git/git-svn

2011-04-28T20:28:00Z

Neundorf:

Archive:Development/Tutorials/Git/BestPractices

2011-04-28T20:25:33Z

Neundorf: Deleted as discussed on k-c-d.

{{warning|This page is obsolete. Proceed to [[Development/Git]]. }}

Neundorf: /* How to do it under Unix */

= What is a dashboard ? =

A dashboard can show the results of Nightly and Continuous builds of a software package. This includes warnings and errors from the configure and build process as well as the results of the executed tests belonging to the software package. This is not only displayed for one machine, but ideally for all supported operating systems such results are submitted, also with different configurations, e.g. one for a minimal system with most optional features disabled and one for a full featured system.

For KDE [http://www.cdash.org CDash-based] dashboards are set up at http://my.cdash.org, a service provided by [http://www.kitware.com Kitware]. CDash only displays the results, the actual building and testing is done decentral on other machines.
When failures occur, like build errors or failed tests, notification emails can be sent by CDash.
So by building and testing KDE each day on the supported platforms and collecting the results in a central place, we can make sure that KDE stays compiling and also working on all supported platforms.

You can help too to increase the quality by setting up a Nightly build and submitting the results to http://my.cdash.org.

= For which modules/packages are there dashboards ?=

Currently there are dashboards set up for all modules of KDE, and one for kdesupport. There are not yet dashboards for extragear and koffice.
If you are interested in setting dashboards up for these too, just go to http://my.cdash.org and do it, or ask on the kde-buildsystem mailing list if you have any questions.

So, here comes the list of currently existing KDE dashboards:

* kdesupport
** [http://my.cdash.org/index.php?project=kdesupport kdesupport]
** [http://my.cdash.org/index.php?project=automoc4 automoc4]

* KDE
** [http://my.cdash.org/index.php?project=kdeaccessibility kdeaccessibility]
** [http://my.cdash.org/index.php?project=kdeadmin kdeadmin]
** [http://my.cdash.org/index.php?project=kdeartwork kdeartwork]
** [http://my.cdash.org/index.php?project=kdebase-apps kdebase/apps]
** [http://my.cdash.org/index.php?project=kdebase-runtime kdebase/runtime]
** [http://my.cdash.org/index.php?project=kdebase-workspace kdebase/workspace]
** [http://my.cdash.org/index.php?project=kdebindings kdebindings]
** [http://my.cdash.org/index.php?project=kdeedu kdeedu]
** [http://my.cdash.org/index.php?project=kdeexamples kdeexamples]
** [http://my.cdash.org/index.php?project=kdegames kdegames]
** [http://my.cdash.org/index.php?project=kdegraphics kdegraphics]
** [http://my.cdash.org/index.php?project=kdelibs kdelibs]
** [http://my.cdash.org/index.php?project=kdemultimedia kdemultimedia]
** [http://my.cdash.org/index.php?project=kdenetwork kdenetwork]
** [http://my.cdash.org/index.php?project=kdepim kdepim]
** [http://my.cdash.org/index.php?project=kdepimlibs kdepimlibs]
** [http://my.cdash.org/index.php?project=kdeplasma-addons kdeplasma-addons]
** [http://my.cdash.org/index.php?project=kdesdk kdesdk]
** [http://my.cdash.org/index.php?project=kdetoys kdetoys]
** [http://my.cdash.org/index.php?project=kdeutils kdeutils]
** [http://my.cdash.org/index.php?project=kdewebdev kdewebdev]

= How to set up a Nightly build =

Setting up a Nightly build and this way contributing to keep KDE working is not hard.

You need:
* A computer. It should be running the Nightly build ''every day'', at some time after 20:00 CET (for the Nightly builds the state of the repository at 20:00 CET is used).
* A KDE development environment installed on this computer, i.e.
** CMake >= 2.6.2, >= 2.8.0 is recommended for the Nightly builds (better warning and error reporting)
** Compiler etc.
** Subversion client
** Qt4 and the other required libraries for building KDE4
* Some time to maintain the Nightly build, i.e. to upgrade the required libraries, e.g. Qt4 when necessary, to install new required libraries etc.

== How to do it under Unix ==

This applies to Linux, FreeBSD and other Unixes. It should also apply to Mac OSX, but this hasn't been tested yet.
You can figure out how to set up the Nightly builds yourself, but we have also something prepared to make it really easy. Let's assume you want to contribute a Nightly build for the kdeutils modules. That's how you do it:

* Go to http://my.cdash.org and register
* Once registered, subscribe to the kdeutils project
* Checkout KDE/kdesdk/cmake/nightly-support/ from KDE svn. There, in the KDE/ subdirectory is a ctest-script ready to use for each KDE module.
* Write a shell script which sets the CMAKE_PREFIX_PATH environment variable so that CMake will find everything required and then execute ctest with the KDEUtilsNightly.cmake script. This will look something like the following:

<tt>
CMAKE_PREFIX_PATH=/opt/kde-qt:/opt/phonon:/what/ever/else/you/need
ctest -V -S /where/you/checked/out/KDE/KDEUtilsNightly.cmake,KDE_CTEST_BUILD_SUFFIX=gcc-4.2.3
</tt>

That's it basically. The -V option for ctest makes ctest verbose, so you can see what it's doing. The KDE_CTEST_BUILD_SUFFIX will be appended to the buildname displayed at http://my.cdash.org/index.php?project=kdeutils. Setting it to the used compiler is a sensible choice.

* Set up a cron job which runs this script every day:
<tt>
$ crontab -e
00 22 * * * /where/is/my/script/run_kdeutils_nightly.sh
</tt>

That's it. Probably you first want to run the script manually a few times until everything works, but after that you can just have it executed via cron.
The next day you should then see your results on http://my.cdash.org.

If you want to contribute Nightly builds for more than one KDE module, it gets a little bit more complicated. You have to make sure that the modules are built in the right order, and that the modules are installed correctly, if other modules depend on them. For examples see kdesdk/cmake/nightly-support/example-scripts/, e.g. [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/cmake/nightly-support/example-scripts/Nightlys-2.6.2 Nightlys-2.6.2] is the shell script I use on my machine to build (and install where necessary) all KDE modules on my Linux machine.

== How to do it under Windows ==

Nobody has done this yet for KDE, but it should be quite similar. If you intend to do this, please contact the kde-buildsystem mailing list, we will do our best to get it working quickly.

Development/CMake/DashboardBuilds

2010-03-26T00:11:59Z

Neundorf: /* How to set up a Nightly build */

Development/CMake/DashboardBuilds

2010-03-26T00:01:00Z

Neundorf: /* How to set up a Nightly build */

Development/CMake/DashboardBuilds

2010-03-25T23:53:02Z

Neundorf: /* How to set up a Nightly build */

Development/CMake/DashboardBuilds

2010-03-25T23:47:38Z

Neundorf:

Development/CMake/DashboardBuilds

2010-03-25T23:45:35Z

Neundorf: /* For which modules/packages are there dashboards ? */

Development/CMake/DashboardBuilds

2010-03-25T23:39:31Z

Neundorf: /* For which modules/packages are there dashboards ? */

Development/CMake/DashboardBuilds

2010-03-25T23:39:14Z

Neundorf:

Development/CMake/DashboardBuilds

2010-03-25T23:36:25Z

Neundorf: /* What is a dashboard ? */