diff options
author | Jan-Simon Möller <jsmoeller@linuxfoundation.org> | 2020-10-14 13:26:09 +0200 |
---|---|---|
committer | Jan-Simon Moeller <jsmoeller@linuxfoundation.org> | 2020-10-14 11:28:17 +0000 |
commit | 93c1058794d8bdab19c49df6d402a40963be65ec (patch) | |
tree | ab893f78a3b9928cf409cd3b63f6129381e4f5aa /docs/3_Developer_Guides/6_AFB_Helper_Guide/3.7.1_Usage.md | |
parent | 11d46ac01cf2b4bbc2e8ffe9b70ca27783af0137 (diff) |
Added Documentation for Jellyfish
(rewrote majority of them and updated with minor changes)
(removed whitespaces, added contribution guide, corrected rcar-gen3 section 7, added aglsetup.h flags to hardware support, some minor changes)
Bug-AGL: [SPEC-3633]
Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com>
Change-Id: Ifd6b3c1cdaa41f05a74c1affe6db9e24763921b9
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25411
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Diffstat (limited to 'docs/3_Developer_Guides/6_AFB_Helper_Guide/3.7.1_Usage.md')
-rw-r--r-- | docs/3_Developer_Guides/6_AFB_Helper_Guide/3.7.1_Usage.md | 97 |
1 files changed, 0 insertions, 97 deletions
diff --git a/docs/3_Developer_Guides/6_AFB_Helper_Guide/3.7.1_Usage.md b/docs/3_Developer_Guides/6_AFB_Helper_Guide/3.7.1_Usage.md deleted file mode 100644 index 62de818..0000000 --- a/docs/3_Developer_Guides/6_AFB_Helper_Guide/3.7.1_Usage.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -edit_link: '' -title: Usage -origin_url: >- - https://git.automotivelinux.org/src/libafb-helpers/plain/docs/usage.md?h=master ---- - -<!-- WARNING: This file is generated by fetch_docs.js using /home/boron/Documents/AGL/docs-webtemplate/site/_data/tocs/devguides/master/afb-helpers-function-references-afb-helpers-book.yml --> - -# Usage - -## Installation - -The afb-helpers library is integrated by default in the AGL SDK since the Guppy -version (>=7) and is also available as a package for the AGL supported linux -distributions. - -You could find the SDK build from Yocto which embed the afb-helpers library -here: - -* For the [releases](https://download.automotivelinux.org/AGL/release/) >= Guppy - in the latest machine's deploy directory. (e.g for Guppy in - `latest/<yourmachine>/deploy/sdk` directory) -* For the [master](https://download.automotivelinux.org/AGL/snapshots/master/) - development branch, in the latest machine's deploy directory. (e.g in - `latest/<yourmachine>/deploy/sdk` directory) - -To install the native package please refer to [this chapter](../1-verify-build-host.html) -in the AGL documentation to install the AGL repository for your distribution. - -Then use your package manager to install the library. - -### OpenSuse - -```bash -sudo zypper ref -sudo zypper install agl-libafb-helpers-devel -``` - -### Fedora - -```bash -sudo dnf ref -sudo dnf install agl-libafb-helpers-devel -``` - -### Ubuntu/Debian - -```bash -sudo apt-get update -sudo apt-get install agl-libafb-helpers-dev -``` - -## (Optional) Remove the git submodule version - -If you already use the afb-helpers component but using the submodule version -then you have to get rid of it to be sure to link and use the library version. -To do so, you have to do the following: - -* Deinitialize the submodule using `git` - -```bash -# This example assumes that the git submodule is named app-afb-helpers-submodule -# and is located at your root project repository. -git submodule deinit app-afb-helpers-submodule -``` - -* Remove the submodule relatives lines from the `.gitmodules` file - -```bash -vim .gitmodules -``` - -* Remove the `afb-helpers` target link from any CMake target you specified. - Those lines look like: - -```bash -TARGET_LINK_LIBRARIES(${TARGET_NAME} - afb-helpers # REMOVE THIS LINE - ${link_libraries} - ) -``` - -## Add the libafb-helpers as a static library to your binding - -In your `config.cmake` file, add a dependency to the controller library, i.e: - -```cmake -set(PKG_REQUIRED_LIST - json-c - afb-daemon - afb-helpers --> this is the afb-helpers library dependency name. -) -``` - -Or you can also use the [FIND_PACKAGE](https://cmake.org/cmake/help/v3.6/command/find_package.html?highlight=find_package) -CMake command to add it if you don't use the [cmake-apps-module](../cmakeafbtemplates/dev_guide/cmake-overview.html) |