Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pfultz2 committed Jun 6, 2017
1 parent 2e80656 commit 3161e79
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 8 deletions.
12 changes: 4 additions & 8 deletions doc/src/BCMPkgConfig.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,22 +42,18 @@ Additional libraries to be linked.

List of other pkgconfig packages that this module depends on.

---------------------------
------------------
bcm_auto_pkgconfig
---------------------------
------------------

.. program:: bcm_auto_pkgconfig

This will auto generate pkgconfig from a given target. All the compiler and linker flags come from the target.

.. option:: <target>

The first parameter is target that will be used to generate the pkgconfig file.

.. option:: NAME <name>

This is the name of the pkgconfig module. By default, this will use the project name.

.. option:: REQUIRES <packages>...
.. option:: TARGET <TARGET>

List of other pkgconfig packages that this module depends on.
This is the target which will be used to set the various pkgconfig fields. This is optional. If a target is not given it will use the target define by either ``bcm_package`` or ``bcm_boost_package``.
24 changes: 24 additions & 0 deletions doc/src/BCMProperties.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,27 @@ CXX_STATIC_RUNTIME
------------------

This property can be used to enable or disable linking against the static C++ runtime. This can be applied at global, directory or target scope. At global scope this defaults to Off.

---------------------
INTERFACE_DESCRIPTION
---------------------

Description of the target.

-------------
INTERFACE_URL
-------------

An URL where people can get more information about and download the package.

-----------------------------
INTERFACE_PKG_CONFIG_REQUIRES
-----------------------------

A list of packages required by this package for pkgconfig. The versions of these packages may be specified using the comparison operators =, <, >, <= or >=.

-------------------------
INTERFACE_PKG_CONFIG_NAME
-------------------------

The name of the pkgconfig package for this target.

0 comments on commit 3161e79

Please sign in to comment.