diff mbox series

[v2] doc/power: add info on jansson conditional build

Message ID 20181116154721.56245-1-david.hunt@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers show
Series [v2] doc/power: add info on jansson conditional build | expand

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/mellanox-Performance-Testing success Performance Testing PASS
ci/intel-Performance-Testing success Performance Testing PASS
ci/Intel-compilation success Compilation OK

Commit Message

David Hunt Nov. 16, 2018, 3:47 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>

---
v2:
  Changed the note to be shown using the ``.. Note::`` tag.
---
 .../sample_app_ug/vm_power_management.rst     | 25 +++++++++++++++++++
 1 file changed, 25 insertions(+)

Comments

Kovacevic, Marko Nov. 16, 2018, 3:52 p.m. UTC | #1
Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>
Thomas Monjalon Nov. 19, 2018, 12:25 a.m. UTC | #2
16/11/2018 16:47, David Hunt:
> 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>

Applied, thanks
diff mbox series

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..5be9f24d5 100644
--- a/doc/guides/sample_app_ug/vm_power_management.rst
+++ b/doc/guides/sample_app_ug/vm_power_management.rst
@@ -657,6 +657,31 @@  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