<p>Neels Hofmeyr has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/12384">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">add API doc for LOGPFSM* macros<br><br>Change-Id: I3bf6500889aa58195f50a726dec0876c0c2baec3<br>---<br>M include/osmocom/core/fsm.h<br>1 file changed, 31 insertions(+), 0 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/84/12384/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/include/osmocom/core/fsm.h b/include/osmocom/core/fsm.h</span><br><span>index ee71451..0b02e9a 100644</span><br><span>--- a/include/osmocom/core/fsm.h</span><br><span>+++ b/include/osmocom/core/fsm.h</span><br><span>@@ -119,9 +119,24 @@</span><br><span> </span><br><span> void osmo_fsm_log_addr(bool log_addr);</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+/*! Log using FSM instance's context, on explicit logging level.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param fi  An osmo_fsm_inst.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param level  A logging level, e.g. LOGL_INFO.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param fmt  printf-like string format.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param args  String format arguments.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span> #define LOGPFSML(fi, level, fmt, args...) \</span><br><span>                 LOGPFSMLSRC(fi, level, __FILE__, __LINE__, fmt, ## args)</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+/*! Log using FSM instance's context, on explicit logging level, and with explicit source file and line info.</span><br><span style="color: hsl(120, 100%, 40%);">+ * The log subsystem to log on is obtained from the underlying FSM definition.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param fi  An osmo_fsm_inst.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param level  A logging level, e.g. LOGL_INFO.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param caller_file  A string constant containing a source file path, like __FILE__.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param caller_line  A number constant containing a source file line, like __LINE__.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param fmt  printf-like string format.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param args  String format arguments.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span> #define LOGPFSMLSRC(fi, level, caller_file, caller_line, fmt, args...) \</span><br><span>            LOGPSRC((fi)->fsm->log_subsys, level, \</span><br><span>                        caller_file, caller_line, \</span><br><span>@@ -130,9 +145,25 @@</span><br><span>                   osmo_fsm_state_name((fi)->fsm, (fi)->state), \</span><br><span>                         ## args)</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+/*! Log using FSM instance's context.</span><br><span style="color: hsl(120, 100%, 40%);">+ * The log level to log on is obtained from the FSM instance.</span><br><span style="color: hsl(120, 100%, 40%);">+ * The log subsystem to log on is obtained from the underlying FSM definition.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param fi  An osmo_fsm_inst.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param fmt  printf-like string format.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param args  String format arguments.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span> #define LOGPFSM(fi, fmt, args...) \</span><br><span>             LOGPFSML(fi, (fi)->log_level, fmt, ## args)</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+/*! Log using FSM instance's context, with explicit source file and line info.</span><br><span style="color: hsl(120, 100%, 40%);">+ * The log level to log on is obtained from the FSM instance.</span><br><span style="color: hsl(120, 100%, 40%);">+ * The log subsystem to log on is obtained from the underlying FSM definition.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param fi  An osmo_fsm_inst.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param caller_file  A string constant containing a source file path, like __FILE__.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param caller_line  A number constant containing a source file line, like __LINE__.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param fmt  printf-like string format.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param args  String format arguments.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span> #define LOGPFSMSRC(fi, caller_file, caller_line, fmt, args...) \</span><br><span>                 LOGPFSMLSRC(fi, (fi)->log_level, \</span><br><span>                            caller_file, caller_line, \</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/12384">change 12384</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/12384"/><meta itemprop="name" content="View Change"/></div></div>

<div style="display:none"> Gerrit-Project: libosmocore </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>
<div style="display:none"> Gerrit-Change-Id: I3bf6500889aa58195f50a726dec0876c0c2baec3 </div>
<div style="display:none"> Gerrit-Change-Number: 12384 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Neels Hofmeyr <nhofmeyr@sysmocom.de> </div>