organicmaps/gflags
13
Fork 0
mirror of https://github.com/gflags/gflags.git synced 2025-04-05 05:25:04 +00:00
Code Issues 1 Projects Releases Wiki Activity Actions

doc: Use of find_package COMPONENTS or inclusion as subproject

Browse source
This commit is contained in:
Andreas Schuh 2016-03-01 22:00:58 +00:00
parent 16651b7870
commit ea1cc83b50
1 changed files with 25 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
index.html
View file

@ -39,7 +39,7 @@
<dt> Table of contents </dt>
<dd> <a href="#intro">Introduction</a> </dd>
<dd> <a href="#download">Download and Installation</a> </dd>
<dd> <a href="#cmake">Finding and Linking to gflags using CMake</a></dd>
<dd> <a href="#cmake">Linking to gflags using CMake</a></dd>
<dd> <a href="#define">DEFINE: Defining Flags In Program</A> </dd>
<dd> <a href="#using">Accessing the Flag</A> </dd>
<dd> <a href="#declare">DECLARE: Using the Flag in a Different File</a> </dd>
@ -103,28 +103,37 @@ You can clone the project using the command:</p>
</pre>
<p>Build and installation instructions are provided in the <A href="https://github.com/gflags/gflags/blob/master/INSTALL.md">INSTALL</A> file.</p>
<h2> <A name=cmake>Finding and Linking to gflags </A> using CMake</h2>
<h2> <A name=cmake>Linking to gflags </A> using CMake</h2>
<p> Using gflags within a project which uses <A href="http://www.cmake.org">CMake</A> for its build system is easy. Therefore, simply add the following CMake code to your <code>CMakeLists.txt</code> file.
<p>Using gflags within a project which uses <A href="http://www.cmake.org">CMake</A> for its build system is easy.
You can either require an external installation of the gflags package and find it using CMake's find_package
command, or include the gflags project as subtree or submodule within your project's source tree and add the directory
using CMake's add_subdirectory command.
<p>To use an external gflags installation, add the following CMake code to your <code>CMakeLists.txt</code> file.</p>
<p>The following CMake variables can be set to request a particular imported gflags library target
to link against. By default, the multi-threaded gflags library with static linkage is chosen if available.
It is recommended to only define these variables if a specific library must be used.
Otherwise, the gflags-config.cmake module will choose a suitable and available library for you.
These configuration options can also be added to the CMake cache (using CMake's option command) so they can
be modified via the CMake GUI or specified as arguments to CMake instead, e.g.,
"cmake -D gflags_SHARED:BOOL=TRUE -D gflags_NOTHREADS:BOOL=FALSE &lt;foo_source_dir&gt;".</p>
<pre>
set(gflags_SHARED FALSE)
set(gflags_NOTHREADS FALSE)
</pre>
<p>Find gflags installation. The gflags_DIR variable must be set to the &lt;prefix&gt;/lib/cmake/gflags directory
<p>Find gflags installation. The <code>gflags_DIR</code> variable must be set to the &lt;prefix&gt;/lib/cmake/gflags directory
containing the gflags-config.cmake file if &lt;prefix&gt; is a non-standard location. Otherwise, CMake should find
the gflags installation automatically.</p>
<pre>
find_package(gflags REQUIRED)
</pre>
<p>To request a particular imported gflags library target to link against, use the <code>COMPONENTS</code> option of
the find_package command. For example, to force the use of the single-threaded static library, use the command</p>
<pre>
find_package(gflags COMPONENTS nothreads_static)
</pre>
<p>Note that this will raise a fatal error when the installed gflags package does not contain the requested library.
It is therefore recommended to only specify the particular component to look for if a specific library must be used.
Otherwise, the gflags-config.cmake module will choose a suitable and available library for you. By default, the
multi-threaded gflags library with shared linkage is chosen if available.</p>
<p>When the source tree of the gflags project is included as subtree or submodule in the "gflags" directory of your project,
replace the above find_package command by <code>add_subdirectory(gflags)</code>. See the top of the <code>gflags/CMakeLists.txt</code>
file for a listing of available CMake variables that can be set before this command to configure the build of the
gflags library. The default build settings are the build of a single-threaded static library which does not require
any installation of the gflags subproject products.</p>
<p>Finally, add your executable build target which uses gflags to parse the command arguments with dependency on the
imported gflags library target:</p>
<pre>