newtmgr - Clarify comment.

Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/repo
Commit: 
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/commit/996bc977
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/tree/996bc977
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/diff/996bc977

Branch: refs/heads/develop
Commit: 996bc97720ef51d0b2cab41cef76467a7e672618
Parents: da250ea
Author: Christopher Collins <[email protected]>
Authored: Thu Jan 12 19:34:11 2017 -0800
Committer: Christopher Collins <[email protected]>
Committed: Fri Jan 13 13:19:09 2017 -0800

----------------------------------------------------------------------
 mgmt/newtmgr/src/newtmgr.c | 4 ++++
 1 file changed, 4 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/blob/996bc977/mgmt/newtmgr/src/newtmgr.c
----------------------------------------------------------------------
diff --git a/mgmt/newtmgr/src/newtmgr.c b/mgmt/newtmgr/src/newtmgr.c
index 138a94b..56214a2 100644
--- a/mgmt/newtmgr/src/newtmgr.c
+++ b/mgmt/newtmgr/src/newtmgr.c
@@ -141,6 +141,10 @@ nmgr_rsp_frag_alloc(uint16_t frag_size, void *arg)
  * Sends a newtmgr response, fragmenting it as needed.  The supplied response
  * mbuf is consumed on success and in some failure cases.  If the mbuf is
  * consumed, the supplied pointer is set to NULL.
+ *
+ * This function prefers not to consume the supplied mbuf on failure.  The
+ * reason for this is to allow the caller to reuse the mbuf for an error
+ * response.
  */
 static int
 nmgr_rsp_tx(struct nmgr_transport *nt, struct os_mbuf **rsp, uint16_t mtu)

Reply via email to