X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Frmr_api.rst;h=69caf590c228104e3f810dfe008544987c50221c;hb=b25bb4cf448766e8ce5113878a9cf4d7947ec00f;hp=a33d6a19c19b14c206db512ed81f75ef26110274;hpb=db26ba217530985dbdcf739640c16c6cecd54a1d;p=ric-plt%2Fxapp-frame-py.git diff --git a/docs/rmr_api.rst b/docs/rmr_api.rst index a33d6a1..69caf59 100644 --- a/docs/rmr_api.rst +++ b/docs/rmr_api.rst @@ -1,16 +1,24 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. Copyright (C) 2020 AT&T Intellectual Property + RMR Python Bindings =================== Overview -------- -The xapp python framework repository includes a python submodule -called `rmr`. This package (`ricxappframe.rmr`) is a CTYPES wrapper +The xapp python framework package includes a python subpackage called +`rmr`. This subpackage (`ricxappframe.rmr`) is a CTYPES wrapper around the RMR shared library. Most Xapp users will never use this -package natively; however python apps that need access to the low -level RMR API can use this package. Usage of this python package -requires that you have the RMR shared-object library installed. +subpackage natively; however python apps that need access to the +low-level RMR API can use it. + +Usage of this python package requires that the RMR shared-object +library is installed in a system library that is included in the +directories found by default, usually something like /usr/local/lib. +The RMR library man pages are available here: :doc:`RMR Man Pages ` RMR API -------