doc/power: add info on jansson conditional build

Message ID 20181101165549.17497-1-david.hunt@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series doc/power: add info on jansson conditional build |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Hunt, David Nov. 1, 2018, 4:55 p.m. UTC
  Add more info to the docs on how to set environmental variable to
correctly build the vm_power_manager sample app in a cross compile
or multilib environment by setting PKG_CONFIG_LIBDIR.

Signed-off-by: David Hunt <david.hunt@intel.com>
---
 .../sample_app_ug/vm_power_management.rst     | 24 +++++++++++++++++++
 1 file changed, 24 insertions(+)
  

Patch

diff --git a/doc/guides/sample_app_ug/vm_power_management.rst b/doc/guides/sample_app_ug/vm_power_management.rst
index 1ad4f1490..b5280d727 100644
--- a/doc/guides/sample_app_ug/vm_power_management.rst
+++ b/doc/guides/sample_app_ug/vm_power_management.rst
@@ -657,6 +657,30 @@  To build just the ``guest_vm_power_manager`` application using ``make``:
 
 The resulting binary will be ${RTE_SDK}/build/examples/guest_cli
 
+Note: This sample application conditionally links in the Jansson JSON
+library, so if you are using a multilib or cross compile environment you
+may need to set the PKG_CONFIG_LIBDIR environmental variable to point to
+the relevant pkgconfig folder so that the correct library is linked in.
+
+For example, if you are building for a 32-bit target, you could find the
+correct directory using the following ``find`` command:
+
+.. code-block:: console
+
+    # find /usr -type d -name pkgconfig
+    /usr/lib/i386-linux-gnu/pkgconfig
+    /usr/lib/x86_64-linux-gnu/pkgconfig
+
+Then use:
+
+.. code-block:: console
+
+    export PKG_CONFIG_LIBDIR=/usr/lib/i386-linux-gnu/pkgconfig
+
+You then use the make command as normal, which should find the 32-bit
+version of the library, if it installed. If not, the application will
+be built without the JSON interface functionality.
+
 To build just the ``vm_power_manager`` application using ``meson/ninja``:
 
 .. code-block:: console