Policies/CMake and Source Compatibility - Revision history

Neverendingo: Text replace - "" to ""

2011-06-29T20:57:27Z

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

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


2011-06-29T20:48:22Z
Text replace - "<code>" to "<syntaxhighlight lang="text">"

				
				
				
				
			
			← Older revision
			Revision as of 20:48, 29 June 2011
			
Line 7:
Line 7:
  A program which was developed against KDE 4.0.0, must also build against let's say KDE 4.5.9. The CMakeLists.txt may look like that (ignoring KDE specific stuff):   A program which was developed against KDE 4.0.0, must also build against let's say KDE 4.5.9. The CMakeLists.txt may look like that (ignoring KDE specific stuff):
    
− <code> + <syntaxhighlight lang="text">
  find_package(FooBar)   find_package(FooBar)
    
Line 91:
Line 91:
  If a new and better alternative to an existing macro is added, the old one may be marked as deprecated like this:   If a new and better alternative to an existing macro is added, the old one may be marked as deprecated like this:
    
− <code> + <syntaxhighlight lang="text">
  macro(OLD_SIMPLE_MACRO args...)   macro(OLD_SIMPLE_MACRO args...)
      message(STATUS "OLD_SIMPLE_MACRO() is deprecated,         message(STATUS "OLD_SIMPLE_MACRO() is deprecated,  
Line 117:
Line 117:
  is used, just add this module to your application, put it e.g. in myapp/cmake/FindFooBar.cmake. To make CMake look in this directory if it searches the file FindFooBar.cmake, you have to adjust the <tt>CMAKE_MODULE_PATH</tt> CMake variable, so that the top of your top level   is used, just add this module to your application, put it e.g. in myapp/cmake/FindFooBar.cmake. To make CMake look in this directory if it searches the file FindFooBar.cmake, you have to adjust the <tt>CMAKE_MODULE_PATH</tt> CMake variable, so that the top of your top level
  CMakeLists.txt will look something like this:   CMakeLists.txt will look something like this:
− <code> + <syntaxhighlight lang="text">
  set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake     set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake  
                         ${CMAKE_MODULE_PATH})                          ${CMAKE_MODULE_PATH})



Nicolas17: Shorten section title
2010-07-31T02:49:15Z
Shorten section title

				
				
				
				
			
			← Older revision
			Revision as of 02:49, 31 July 2010
			
Line 33:
Line 33:
  with ANY CMake module, e.g. KDE4, Qt4, GIF, Freetype, etc.   with ANY CMake module, e.g. KDE4, Qt4, GIF, Freetype, etc.
    
− ==In order to stay source compatible, the following has to be kept == + == Source compatibility rules ==
  +  
  + In order to stay source compatible, the following has to be kept:
    
  * '''1. The CMake module FindFooBar.cmake must stay available'''   * '''1. The CMake module FindFooBar.cmake must stay available'''
Line 47:
Line 49:
  Otherwise the same as in 1) will happen.   Otherwise the same as in 1) will happen.
    
− * '''3.Macros coming with the module must stay compatible''' + * '''3. Macros coming with the module must stay compatible'''
    
  So if FindFooBar.cmake in kdelibs 4.0.0 has a macro <tt>FOOBAR_DO_STUFF()</tt>, this macro   So if FindFooBar.cmake in kdelibs 4.0.0 has a macro <tt>FOOBAR_DO_STUFF()</tt>, this macro



Rakuco: /* What changes are possible? */ Removed extra blank line at the end.
2009-03-30T19:53:43Z
‎What changes are possible?:  Removed extra blank line at the end.

				
				
				
				
			
			← Older revision
			Revision as of 19:53, 30 March 2009
			
Line 105:
Line 105:
    
  It has to be made sure that the macro stays working as it did before with the old set of arguments.   It has to be made sure that the macro stays working as it did before with the old set of arguments.
−  
    
  ==If nothing else helps...==   ==If nothing else helps...==



Rakuco: /* In order to stay source compatible, the following has to be kept */ Removed extra blank lines
2009-03-30T19:52:02Z
‎In order to stay source compatible, the following has to be kept:  Removed extra blank lines

				
				
				
				
			
			← Older revision
			Revision as of 19:52, 30 March 2009
			
Line 36:
Line 36:
    
  * '''1. The CMake module FindFooBar.cmake must stay available'''   * '''1. The CMake module FindFooBar.cmake must stay available'''
−  
  Otherwise CMake will fail with "could not find FindFooBar.cmake".   Otherwise CMake will fail with "could not find FindFooBar.cmake".
  This means either it has to stay in the KDE module, or in the case that KDE would require a newer     This means either it has to stay in the KDE module, or in the case that KDE would require a newer  
  version of CMake which comes with a (for KDE) usable version of that module, that the minimum required   version of CMake which comes with a (for KDE) usable version of that module, that the minimum required
  version of CMake must ship this module (which must be fully compatible).   version of CMake must ship this module (which must be fully compatible).
−  
    
  * '''2. The file name of the CMake module must stay exactly the same'''   * '''2. The file name of the CMake module must stay exactly the same'''
Line 48:
Line 46:
  exactly the same, also the case must not change (e.g. FindFreeType.cmake).   exactly the same, also the case must not change (e.g. FindFreeType.cmake).
  Otherwise the same as in 1) will happen.   Otherwise the same as in 1) will happen.
−  
    
  * '''3.Macros coming with the module must stay compatible'''   * '''3.Macros coming with the module must stay compatible'''
Line 57:
Line 54:
  It is possible to add new or alternative arguments to a macro, but the old behaviour   It is possible to add new or alternative arguments to a macro, but the old behaviour
  must stay supported.   must stay supported.
−  
    
  * '''4. Variables coming with the module must stay compatible'''   * '''4. Variables coming with the module must stay compatible'''
Line 66:
Line 62:
  module) must be available from this module in all releases of KDE4.   module) must be available from this module in all releases of KDE4.
  This means   This means
  + 
  * their case must not change   * their case must not change
  * they must have equivalent values   * they must have equivalent values



Neundorf: /* What changes are possible? */
2008-01-07T23:20:32Z
‎What changes are possible?

				
				
				
				
			
			← Older revision
			Revision as of 23:20, 7 January 2008
			
Line 81:
Line 81:
  == What changes are possible? ==   == What changes are possible? ==
    
− # '''New modules can be added''' + * '''1. New modules can be added'''
    
− # '''New variables can be added to existing modules''' + * '''2. New variables can be added to existing modules'''
    
  It has to be made sure that the existing ones stay working, s.a.   It has to be made sure that the existing ones stay working, s.a.
    
− # '''New macros can be added''' + * '''3. New macros can be added'''
    
  It has to be made sure that the existing ones stay working, s.a.   It has to be made sure that the existing ones stay working, s.a.
Line 94:
Line 94:
  <code>   <code>
  macro(OLD_SIMPLE_MACRO args...)   macro(OLD_SIMPLE_MACRO args...)
−     message(STATUS "OLD_SIMPLE_MACRO() is deprecated, use NEW_FANCY_MACRO() instead") +     message(STATUS "OLD_SIMPLE_MACRO() is deprecated,  
−     ...keep the macro implementation here, so the macro keeps working +                    use NEW_FANCY_MACRO() instead")
  +     # ...keep the macro implementation here,  
  +    # so the macro keeps working
  endmacro(OLD_SIMPLE_MACRO)   endmacro(OLD_SIMPLE_MACRO)
    
  macro(NEW_FANCY_MACRO args...)   macro(NEW_FANCY_MACRO args...)
−     ... new fancy implementation +     # ... new fancy implementation
  endmacro(NEW_FANCY_MACRO)   endmacro(NEW_FANCY_MACRO)
  </code>   </code>
    
− # '''More arguments can be added to existing macros''' + * '''4. More arguments can be added to existing macros'''
    
  It has to be made sure that the macro stays working as it did before with the old set of arguments.   It has to be made sure that the macro stays working as it did before with the old set of arguments.
  + 
  + 
  + ==If nothing else helps...==
  + 
  + If you are developing an application with the KDE 4, but don't trust the KDE developer team that they will be able to keep the one CMake module you are
  + interested in compatible, there is still an option left for you.
  + 
  + We take the same example as above, i.e. your application uses package
  + FooBar. If you want to make sure that one specific version of FindFooBar.cmake
  + is used, just add this module to your application, put it e.g. in myapp/cmake/FindFooBar.cmake. To make CMake look in this directory if it searches the file FindFooBar.cmake, you have to adjust the <tt>CMAKE_MODULE_PATH</tt> CMake variable, so that the top of your top level
  + CMakeLists.txt will look something like this:
  + <code>
  + set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake 
  +                       ${CMAKE_MODULE_PATH})
  + 
  + find_package(KDE4)
  + 
  + find_package(FooBar)
  + 
  + ...
  + 
  + </code>



Neundorf: /* What changes are possible? */
2008-01-07T23:11:11Z
‎What changes are possible?

				
				
				
				
			
			← Older revision
			Revision as of 23:11, 7 January 2008
			
Line 81:
Line 81:
  == What changes are possible? ==   == What changes are possible? ==
    
− * New modules can be added + # '''New modules can be added'''
    
− * New variables can be added to existing modules. + # '''New variables can be added to existing modules'''
    
  It has to be made sure that the existing ones stay working, s.a.   It has to be made sure that the existing ones stay working, s.a.
    
− * New macros can be added. + # '''New macros can be added'''
    
  It has to be made sure that the existing ones stay working, s.a.   It has to be made sure that the existing ones stay working, s.a.
Line 103:
Line 103:
  </code>   </code>
    
− * More arguments can be added to existing macros. + # '''More arguments can be added to existing macros'''
    
  It has to be made sure that the macro stays working as it did before with the old set of arguments.   It has to be made sure that the macro stays working as it did before with the old set of arguments.



Neundorf: /* In order to stay source compatible, the following has to be kept */
2008-01-07T23:09:51Z
‎In order to stay source compatible, the following has to be kept

				
				
				
				
			
			← Older revision
			Revision as of 23:09, 7 January 2008
			
Line 35:
Line 35:
  ==In order to stay source compatible, the following has to be kept ==   ==In order to stay source compatible, the following has to be kept ==
    
− ===The CMake module FindFooBar.cmake must stay available=== + * '''1. The CMake module FindFooBar.cmake must stay available'''
    
  Otherwise CMake will fail with "could not find FindFooBar.cmake".   Otherwise CMake will fail with "could not find FindFooBar.cmake".
Line 43:
Line 43:
    
    
− ===The file name of the CMake module must stay exactly the same === + * '''2. The file name of the CMake module must stay exactly the same'''
    
  E.g. in KDE 4.0.0 we have a FindFreetype.cmake installed by kdelibs. This filename must stay     E.g. in KDE 4.0.0 we have a FindFreetype.cmake installed by kdelibs. This filename must stay  
Line 50:
Line 50:
    
    
− ===Macros coming with the module must stay compatible=== + * '''3.Macros coming with the module must stay compatible'''
    
  So if FindFooBar.cmake in kdelibs 4.0.0 has a macro <tt>FOOBAR_DO_STUFF()</tt>, this macro   So if FindFooBar.cmake in kdelibs 4.0.0 has a macro <tt>FOOBAR_DO_STUFF()</tt>, this macro
Line 59:
Line 59:
    
    
− ===Variables coming with the module must stay compatible=== + * '''4. Variables coming with the module must stay compatible'''
    
  In the example above several variables from FindFooBar.cmake are used:   In the example above several variables from FindFooBar.cmake are used:



Neundorf: /* What changes are possible? */
2008-01-07T23:07:55Z
‎What changes are possible?

				
				
				
				
			
			← Older revision
			Revision as of 23:07, 7 January 2008
			
Line 80:
Line 80:
    
  == What changes are possible? ==   == What changes are possible? ==
− 1) New modules can be added.  
    
− 2) New variables can be added to existing modules. + * New modules can be added
  +  
  + * New variables can be added to existing modules.
    
  It has to be made sure that the existing ones stay working, s.a.   It has to be made sure that the existing ones stay working, s.a.
    
− 3) New macros can be added. + * New macros can be added.
    
  It has to be made sure that the existing ones stay working, s.a.   It has to be made sure that the existing ones stay working, s.a.
  If a new and better alternative to an existing macro is added, the old one may be marked as deprecated like this:   If a new and better alternative to an existing macro is added, the old one may be marked as deprecated like this:
    
  + <code>
  macro(OLD_SIMPLE_MACRO args...)   macro(OLD_SIMPLE_MACRO args...)
      message(STATUS "OLD_SIMPLE_MACRO() is deprecated, use NEW_FANCY_MACRO() instead")       message(STATUS "OLD_SIMPLE_MACRO() is deprecated, use NEW_FANCY_MACRO() instead")
Line 99:
Line 101:
      ... new fancy implementation       ... new fancy implementation
  endmacro(NEW_FANCY_MACRO)   endmacro(NEW_FANCY_MACRO)
  + </code>
    
−   + * More arguments can be added to existing macros.
− 4) More arguments can be added to existing macros. + 
    
  It has to be made sure that the macro stays working as it did before with the old set of arguments.   It has to be made sure that the macro stays working as it did before with the old set of arguments.



Neundorf: /* What does that mean? */
2008-01-07T23:06:52Z
‎What does that mean?

				
				
				
				
			
			← Older revision
			Revision as of 23:06, 7 January 2008
			
Line 3:
Line 3:
  All KDE 4 releases need to keep binary and source compatibility with KDE 4.0.0. This doesn't affect only the C++ code, but also the CMake modules installed with kdelibs (also the cmake modules of the other KDE modules ?).   All KDE 4 releases need to keep binary and source compatibility with KDE 4.0.0. This doesn't affect only the C++ code, but also the CMake modules installed with kdelibs (also the cmake modules of the other KDE modules ?).
    
− == What does that mean? == + == What does CMake source compatibility mean? ==
    
  A program which was developed against KDE 4.0.0, must also build against let's say KDE 4.5.9. The CMakeLists.txt may look like that (ignoring KDE specific stuff):   A program which was developed against KDE 4.0.0, must also build against let's say KDE 4.5.9. The CMakeLists.txt may look like that (ignoring KDE specific stuff):

@@ Line 27: / Line 27: @@
 target_link_libraries(kapp ${MyLinkLibs})
-</code>
+</syntaxhighlight>
@@ Line 102: / Line 102: @@
     # ... new fancy implementation
 endmacro(NEW_FANCY_MACRO)
-</code>
+</syntaxhighlight>
 * '''4. More arguments can be added to existing macros'''
@@ Line 127: / Line 127: @@
 ...
-</code>
+</syntaxhighlight>

← Older revision		Revision as of 19:53, 30 March 2009
Line 105:		Line 105:

	It has to be made sure that the macro stays working as it did before with the old set of arguments.		It has to be made sure that the macro stays working as it did before with the old set of arguments.
−

	==If nothing else helps...==		==If nothing else helps...==