Advanced CMake Features - Revision history

Mgloff at 21:27, 17 November 2015

2015-11-17T21:27:15Z

Mdean: Approved for FinalDraft status.

2015-11-17T20:57:20Z

Approved for FinalDraft status.

Kyoungmeyer at 19:24, 17 November 2015

2015-11-17T19:24:41Z

Mdean: (you forgot your datestamp). Made some corrections, added a couple of notes, and marked Buggy.

2015-11-17T18:12:26Z

(you forgot your datestamp). Made some corrections, added a couple of notes, and marked Buggy.

Mdean: When a page is downgraded to Buggy, its next status will always be Review rather than going back to FinalDraft, because too much was changed.

2015-11-17T17:46:04Z

When a page is downgraded to Buggy, its next status will always be Review rather than going back to FinalDraft, because too much was changed.

Kyoungmeyer: Added link to "Where to go next"

2015-11-17T16:53:33Z

Added link to "Where to go next"

Mdean: Fixed tag.

2015-11-13T23:44:07Z

Fixed tag.

Kyoungmeyer at 20:05, 25 September 2015

2015-09-25T20:05:04Z

Show changes

Mdean: Reviewed and put in some notes.

2015-09-24T23:17:36Z

Reviewed and put in some notes.

Kyoungmeyer at 22:35, 21 September 2015

2015-09-21T22:35:56Z

@@ Line 1: / Line 1: @@
-{{todo| FinalDraft (09.14.2015-11:59->KY+)(09.21.2015-11:08->KY+)(09.24.2015-18:15->MD-);(11.16.2015-12:10->MD-);(11.16.2015-13:22->KY+);(11.17.2015-14:55->MD+)|Klint Youngmeyer| project=OE 5.0,KY,MD,FinalDraft }}
+{{todo| Complete (09.14.2015-11:59->KY+)(09.21.2015-11:08->KY+)(09.24.2015-18:15->MD-);(11.16.2015-12:10->MD-);(11.16.2015-13:22->KY+);(11.17.2015-14:55->MD+);(11.17.2015-15:30->MG+)|Klint Youngmeyer| project=OE 5.0,KY,MD,MG,Complete }}
 {{#seo:
 |title=Advanced CMake Features

@@ Line 1: / Line 1: @@
-{{todo| Review (09.14.2015-11:59->KY+)(09.21.2015-11:08->KY+)(09.24.2015-18:15->MD-);(11.16.2015-12:10->MD-);(11.16.2015-13:22->KY+)|Klint Youngmeyer| project=OE 5.0,KY,MD,Review }}
+{{todo| FinalDraft (09.14.2015-11:59->KY+)(09.21.2015-11:08->KY+)(09.24.2015-18:15->MD-);(11.16.2015-12:10->MD-);(11.16.2015-13:22->KY+);(11.17.2015-14:55->MD+)|Klint Youngmeyer| project=OE 5.0,KY,MD,FinalDraft }}
 {{#seo:
 |title=Advanced CMake Features
@@ Line 227: / Line 227: @@
 <!-- /*********************************************************************************************************/ -->
 {{:Templateimpl:conclusion | initials=KY | title=Advanced CMake Features | desc=Advanced features of the CMake build system for use with the EMAC SDK. | project=OE 5.0 }}
-In this guide, several relatively common, advanced CMake topics were covered. It was demonstrated how to: Add different types of library files, add a version number in a config file, and build with cross-platform support.
+In this guide, several relatively common, advanced CMake topics were covered. It was demonstrated how to: add different types of library files, add a version number in a config file, and build with cross-platform support.
 With the information provided on this page, you are well on your way to having the tools needed for building a large project with CMake. While EMAC fully supports CMake, we are not able to provide the full documentation. Please refer to official or other third-party documentation for more information.
@@ Line 240: / Line 240: @@
 *[[Creating_a_New_EMAC_OE_SDK_Project_with_CMake | Creating a New EMAC OE SDK Project with CMake]]
 <br />
-Some information on this page was provided by the official [http://www.cmake.org/cmake-tutorial/ CMake Tutorial].
+''Some information on this page was provided by the official [http://www.cmake.org/cmake-tutorial/ CMake Tutorial].''

@@ Line 1: / Line 1: @@
-{{todo| Buggy (09.14.2015-11:59->KY+)(09.21.2015-11:08->KY+)(09.24.2015-18:15->MD-);(11.16.2015-12:10->MD-)|Klint Youngmeyer| project=OE 5.0,KY,MD,Buggy }}
+{{todo| Review (09.14.2015-11:59->KY+)(09.21.2015-11:08->KY+)(09.24.2015-18:15->MD-);(11.16.2015-12:10->MD-);(11.16.2015-13:22->KY+)|Klint Youngmeyer| project=OE 5.0,KY,MD,Review }}
 {{#seo:
 |title=Advanced CMake Features
@@ Line 178: / Line 178: @@
      ${PROJECT_SOURCE_DIR}/include/tools.cpp
      ${PROJECT_SOURCE_DIR}/include/funcs.cpp
+     )
@@ Line 193: / Line 191: @@
 TARGET_LINK_LIBRARIES(main tools funcs)
 </syntaxhighlight>
 ===Cross-Platform Building===
@@ Line 252: / Line 227: @@
 <!-- /*********************************************************************************************************/ -->
 {{:Templateimpl:conclusion | initials=KY | title=Advanced CMake Features | desc=Advanced features of the CMake build system for use with the EMAC SDK. | project=OE 5.0 }}
-As stated previously, this guide is just a small list of common task requests. Please refer to official or other third-party documentation for more information.
+In this guide, several relatively common, advanced CMake topics were covered. It was demonstrated how to: Add different types of library files, add a version number in a config file, and build with cross-platform support.
-{{ warning | This conclusion could be much better.  This looks like it was just tossed in to meet the requirement of having a conclusion.  It doesn't summarize anything.}}
 <!-- /*********************************************************************************************************/ -->

@@ Line 1: / Line 1: @@
-{{todo| Review (09.14.2015-11:59->KY+)(09.21.2015-11:08->KY+)(09.24.2015-18:15->MD-)|Klint Youngmeyer| project=OE 5.0,KY,MD,Review }}
+{{todo| Buggy (09.14.2015-11:59->KY+)(09.21.2015-11:08->KY+)(09.24.2015-18:15->MD-);(11.16.2015-12:10->MD-)|Klint Youngmeyer| project=OE 5.0,KY,MD,Buggy }}
 {{#seo:
 |title=Advanced CMake Features
@@ Line 83: / Line 83: @@
 The main points of note are the inclusion of the <code>ExampleConfig.h</code> header file and printing out a version number as part of the usage message.
 ===Adding External Library Files===
-A library is a collection of precompiled object files which can be linked into programs. The most common use of libraries is to provide system functions, such as the image resize function <code>MagickResizeImage</code> found in the ImageMagick library. The linker needs to know where to find these objects, CMake can accomplish this with the <code>INCLUDE_DIRECTORIES</code> and <code>TARGET_LINK_LIBRARIES</code> functions.
+A library is a collection of precompiled object files which can be linked into programs. The most common use of libraries is to provide system functions, such as the image resize function, <code>MagickResizeImage</code>, found in the ImageMagick library. The linker needs to know where to find these objects; CMake can accomplish this with the <code>INCLUDE_DIRECTORIES</code> and <code>TARGET_LINK_LIBRARIES</code> functions.
 To add an external library to the CMake project, more changes will need to be made to the <code>CMakeLists.txt</code> file. Please refer to the code sample below. In this example, the ''ImageMagick'' library will be linked into the project.
 #The library directory must be included using the <code>INCLUDE_DIRECTORIES()</code> function. This function must be before the <code>ADD_EXECUTABLE()</code> function.
@@ Line 193: / Line 193: @@
 TARGET_LINK_LIBRARIES(main tools funcs)
 </syntaxhighlight>
 ===Cross-Platform Building===
-If a project is meant to be used on multiple different platforms, it is sometimes necessary to have different options for each platform. These options could be additional C flags, variables to #define what code is to be run, or various other tasks. The following example shows how to #define which architecture is being built based on the <code>ARCH</code> variable that is set by the EMAC toolchain:
+If a project is meant to be used on multiple different platforms, it is sometimes necessary to have different options for each platform. These options could be additional C flags, variables to <code>#define</code> what code is to be run, or various other tasks. The following example shows how to <code>#define</code> which architecture is being built based on the <code>ARCH</code> variable that is set by the EMAC toolchain:
 <syntaxhighlight lang="cmake">
 if(${ARCH} STREQUAL "x86")
@@ Line 229: / Line 253: @@
 {{:Templateimpl:conclusion | initials=KY | title=Advanced CMake Features | desc=Advanced features of the CMake build system for use with the EMAC SDK. | project=OE 5.0 }}
 As stated previously, this guide is just a small list of common task requests. Please refer to official or other third-party documentation for more information.
 <!-- /*********************************************************************************************************/ -->
 <!-- /******************************************   More Information   *****************************************/ -->

@@ Line 1: / Line 1: @@
-{{todo| FinalDraft (09.14.2015-11:59->KY+)(09.21.2015-11:08->KY+)(09.24.2015-18:15->MD-)|Klint Youngmeyer| project=OE 5.0,KY,MD,FinalDraft }}
+{{todo| Review (09.14.2015-11:59->KY+)(09.21.2015-11:08->KY+)(09.24.2015-18:15->MD-)|Klint Youngmeyer| project=OE 5.0,KY,MD,Review }}
 {{#seo:
 |title=Advanced CMake Features

@@ Line 233: / Line 233: @@
 <!-- /*********************************************************************************************************/ -->
 {{:Templateimpl:moreinfo | initials=KY | title=Advanced CMake Features | desc=Advanced features of the CMake build system for use with the EMAC SDK. | project=OE 5.0 }}
+* [https://cmake.org/cmake/help/v3.4/ CMake Official Documentation]
 {{:Templateimpl:whatnext | initials=KY | title=Advanced CMake Features | desc=Advanced features of the CMake build system for use with the EMAC SDK. | project=OE 5.0 }}
 *[[Creating_a_New_EMAC_OE_SDK_Project_with_CMake | Creating a New EMAC OE SDK Project with CMake]]
 <br />
-Some information on this page was provided by the official [http://www.cmake.org/cmake-tutorial/ CMake Documentation].
+Some information on this page was provided by the official [http://www.cmake.org/cmake-tutorial/ CMake Tutorial].

@@ Line 1: / Line 1: @@
-{{todo| Review (09.14.2015-11:59->KY+)(09.21.2015-11:08->KY+)|Klint Youngmeyer| project=OE 5.0,KY,MD }}
+{{todo| Buggy (09.14.2015-11:59->KY+)(09.21.2015-11:08->KY+)(09.24.2015-18:15->MD-)|Klint Youngmeyer| project=OE 5.0,KY,MD }}
 {{#seo:
 |title=Advanced CMake Features
@@ Line 19: / Line 19: @@
 {{:Templateimpl:bg | initials=KY | title=Advanced CMake Features | desc=Advanced features of the CMake build system for use with the EMAC SDK. | project=OE 5.0 }}
 This page is written with the assumption that the project being worked on has been created using the [[Creating_a_New_EMAC_OE_SDK_Project_with_CMake | oe_init_project]] script or using the EMAC New C/C++ Project in Qt Creator.
 <!-- /*********************************************************************************************************/ -->
 <!-- /*****************************************  General Information  *****************************************/ -->
@@ Line 29: / Line 31: @@
 {{:Templateimpl:using | initials=KY | title=Advanced CMake Features | desc=Advanced features of the CMake build system for use with the EMAC SDK. | project=OE 5.0 }}
 ===Adding a Version Number and Configured Header File===
 It is possible to provide the executable and project with a version number through CMake. While you can do this exclusively in the source code, doing it in the CMakeLists file provides more flexibility. To add a version number we modify the CMakeLists file as follows:
 <syntaxhighlight lang="cmake">
@@ Line 55: / Line 59: @@
 </syntaxhighlight>
 When CMake configures this header file the values for <code>@Example_VERSION_MAJOR@</code> and <code>@Example_VERSION_MINOR@</code> will be replaced by the values from the CMakeLists file. Next we modify main.c to include the configured header file and to make use of the version numbers. The resulting source code is listed below.
 <syntaxhighlight lang="c">
 // A simple program that computes the square root of a number
@@ Line 80: / Line 85: @@
 The main points of note are the inclusion of the <code>ExampleConfig.h</code> header file and printing out a version number as part of the usage message.
 ===Adding External Library Files===
 To add an external library to the CMake project, more changes will need to be made to the <code>CMakeLists.txt</code> file. Please refer to the code sample below. In this example, the ''ImageMagick'' library will be linked into the project.
 #The library directory must be included using the <code>INCLUDE_DIRECTORIES()</code> function. This function must be before the <code>ADD_EXECUTABLE()</code> function.
@@ Line 91: / Line 98: @@
 TARGET_LINK_LIBRARIES(example MagickWand)
 </syntaxhighlight>
-===Adding Additional C/C++ Sourrce Files as Libraries===
+===Adding Additional C/C++ Source Files as Libraries===
 Adding additional source files is accomplished similarly to adding external library files. See [[#Adding_External_Library_Files | above]].
 # All included files must be included in the <code>SOURCES</code> list.
@@ Line 118: / Line 125: @@
 TARGET_LINK_LIBRARIES(main tools funcs)
 </syntaxhighlight>
 ===Cross-Platform Building===
 If a project is meant to be used on multiple different platforms, it is sometimes necessary to have different options for each platform. These options could be additional C flags, variables to #define what code is to be run, or various other tasks. The following example shows how to #define which architecture is being built based on the <code>ARCH</code> variable that is set by the EMAC toolchain: