X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=doc%2Fsrc%2Fman%2Frmr_trace_ref.3.xfm;h=9768d221f8da8055bbc758ff8ab9e453d90cb3ef;hb=56a5312c71837e727379f627900fc22e46637a6b;hp=a5db1ddee66daa6520904afba1e18fa641fa23c0;hpb=a7610c690a3976e296ca768977e38ceb9aafa5ff;p=ric-plt%2Flib%2Frmr.git diff --git a/doc/src/man/rmr_trace_ref.3.xfm b/doc/src/man/rmr_trace_ref.3.xfm index a5db1dd..9768d22 100644 --- a/doc/src/man/rmr_trace_ref.3.xfm +++ b/doc/src/man/rmr_trace_ref.3.xfm @@ -1,7 +1,7 @@ .if false ================================================================================== - Copyright (c) 2019 Nokia - Copyright (c) 2018-2019 AT&T Intellectual Property. + Copyright (c) 2019 Nokia + Copyright (c) 2018-2019 AT&T Intellectual Property. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -18,31 +18,20 @@ .fi .if false - Mnemonic rmr_trace_ref.3.xfm - Abstract The manual page for the rmr_trace_ref function. - Author E. Scott Daniels - Date 11 July 2019 + Mnemonic rmr_trace_ref.3.xfm + Abstract The manual page for the rmr_trace_ref function. + Author E. Scott Daniels + Date 11 July 2019 .fi -.** if formatting with tfm, the roff.im will cause roff output to be generated -.** if formatting with pfm, then pretty postscript will be generated .gv e LIB lib -.if pfm - .im &{lib}/generic_ps.im -.ei - .gv e OUTPUT_RST use_rst - .if .ev &use_rst 1 = - .im &{lib}/rst.im - .ei - .im &{lib}/roff.im - .fi -.fi +.im &{lib}/man/setup.im &line_len(6i) &h1(RMR Library Functions) &h2(NAME) - rmr_trace_ref + rmr_trace_ref &h2(SYNOPSIS) &indent @@ -55,12 +44,12 @@ int rmr_trace_ref( rmr_mbuf_t* mbuf, int* sizeptr ) &uindent &h2(DESCRIPTION) -The &cw(rmr_trace_ref) function return a pointer to the trace area in the message, and optionally -populate the user programme supplied size integer with the trace area size, if &ital(sizeptr) is +The &cw(rmr_trace_ref) function returns a pointer to the trace area in the message, and optionally +populates the user programme supplied size integer with the trace area size, if &ital(sizeptr) is not nil. &h2(RETURN VALUE) -On success, a void pointer to the trace area of the message is returned. +On success, a void pointer to the trace area of the message is returned. A nil pointer is returned if the message has no trace data area allocated, or if the message itself is invalid. @@ -94,7 +83,3 @@ rmr_wh_open(3), rmr_wh_send_msg(3), rmr_set_trace(3) .ju on - - -.qu -