Code Review
/
ric-plt
/
lib
/
rmr.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
review
|
tree
raw
|
inline
| side by side
Add route table guide and formatting tweaks
[ric-plt/lib/rmr.git]
/
doc
/
src
/
man
/
rmr_ready.3.xfm
diff --git
a/doc/src/man/rmr_ready.3.xfm
b/doc/src/man/rmr_ready.3.xfm
index
9a82010
..
a846749
100644
(file)
--- a/
doc/src/man/rmr_ready.3.xfm
+++ b/
doc/src/man/rmr_ready.3.xfm
@@
-1,7
+1,7
@@
.if false
==================================================================================
.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.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@
-17,31
+17,20
@@
==================================================================================
.fi
.if false
==================================================================================
.fi
.if false
-
Mnemonic
rmr_ready_man.xfm
-
Abstract
The manual page for the rmr_ready function.
-
Author
E. Scott Daniels
-
Date
28 January 2019
+
Mnemonic
rmr_ready_man.xfm
+
Abstract
The manual page for the rmr_ready function.
+
Author
E. Scott Daniels
+
Date
28 January 2019
.fi
.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
.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)
&line_len(6i)
&h1(RMR Library Functions)
&h2(NAME)
-
rmr_ready
+ rmr_ready
&h2(SYNOPSIS )
&indent
&h2(SYNOPSIS )
&indent
@@
-59,7
+48,7
@@
The return value indicates the state of readiness.
&h2(RETURN VALUE)
A return value of 1 (true) indicates that the routing table is in place and
&h2(RETURN VALUE)
A return value of 1 (true) indicates that the routing table is in place and
-attempts to send messages can be made.
+attempts to send messages can be made.
When 0 is returned (false) the routing table has not been received and thus
attempts to send messages will fail with &ital(no endpoint) errors.
When 0 is returned (false) the routing table has not been received and thus
attempts to send messages will fail with &ital(no endpoint) errors.
@@
-81,6
+70,3
@@
rmr_mk_ring(3),
rmr_ring_free(3)
.ju on
rmr_ring_free(3)
.ju on
-
-.qu
-