Add route table guide and formatting tweaks
The route table guide has been added to the repo so that it
can be published on the RTD site. This change also includes
pulling full examples into the user guide from the repo
example directory (rather than maintaining snipits in the
doc), and generates RST definition lists in a more traditional
format that just look better in the rendered HTML.
Issue-ID: RIC-378
Signed-off-by: E. Scott Daniels <daniels@research.att.com>
Change-Id: I2661dbb28daf3575640426a847f17fe45ea0ba43
diff --git a/docs/rmr_str2meid.3.rst b/docs/rmr_str2meid.3.rst
index 93b5286..ae8b57b 100644
--- a/docs/rmr_str2meid.3.rst
+++ b/docs/rmr_str2meid.3.rst
@@ -1,80 +1,91 @@
-
-
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. SPDX-License-Identifier: CC-BY-4.0
.. CAUTION: this document is generated from source in doc/src/rtd.
.. To make changes edit the source and recompile the document.
.. Do NOT make changes directly to .rst or .md files.
-
============================================================================================
Man Page: rmr_str2meid
============================================================================================
-RMR Library Functions
-============================================================================================
-
-NAME
---------------------------------------------------------------------------------------------
-
+
+
+RMR LIBRARY FUNCTIONS
+=====================
+
+
+
+NAME
+----
+
rmr_str2meid
-
-SYNOPSIS
---------------------------------------------------------------------------------------------
-
+
+
+SYNOPSIS
+--------
+
::
-
+
#include <rmr/rmr.h>
+
int rmr_str2meid( rmr_mbuf_t* mbuf, unsigned char* src, int len )
-
-
-DESCRIPTION
---------------------------------------------------------------------------------------------
-
-The rmr_str2meid function will copy the string pointed to by
-src to the managed entity ID (meid) field in the given
+
+
+DESCRIPTION
+-----------
+
+The ``rmr_str2meid`` function will copy the string pointed to
+by src to the managed entity ID (meid) field in the given
message. The field is a fixed length, gated by the constant
-RMR_MAX_MEID and if string length is larger than this value,
-then **nothing** will be copied. (Note, this differs slightly
-from the behaviour of the lrmr_bytes2meid() function.)
-
-RETURN VALUE
---------------------------------------------------------------------------------------------
-
+``RMR_MAX_MEID`` and if string length is larger than this
+value, then **nothing** will be copied. (Note, this differs
+slightly from the behaviour of the ``lrmr_bytes2meid()``
+function.)
+
+
+RETURN VALUE
+------------
+
On success, the value RMR_OK is returned. If the string
cannot be copied to the message, the return value will be one
of the errors listed below.
-
-ERRORS
---------------------------------------------------------------------------------------------
-
+
+
+ERRORS
+------
+
If the return value is not RMR_OK, then it will be set to one
of the values below.
+ .. list-table::
+ :widths: auto
+ :header-rows: 0
+ :class: borderless
+
+ * - **RMR_ERR_BADARG**
+ -
+ The message, or an internal portion of the message, was
+ corrupted or the pointer was invalid.
+
+ * - **RMR_ERR_OVERFLOW**
+ -
+ The length passed in was larger than the maximum length of
+ the field; only a portion of the source bytes were copied.
+
-
-RMR_ERR_BADARG
-
- The message, or an internal portion of the message, was
- corrupted or the pointer was invalid.
-
-
-RMR_ERR_OVERFLOW
-
- The length passed in was larger than the maximum length of
- the field; only a portion of the source bytes were copied.
-
-
-EXAMPLE
---------------------------------------------------------------------------------------------
-
-
-SEE ALSO
---------------------------------------------------------------------------------------------
-
+
+
+EXAMPLE
+-------
+
+
+
+SEE ALSO
+--------
+
rmr_alloc_msg(3), rmr_call(3), rmr_free_msg(3),
rmr_get_meid(3), rmr_get_rcvfd(3), rmr_payload_size(3),
rmr_send_msg(3), rmr_rcv_msg(3), rmr_rcv_specific(3),