From b33da506b546ebca3a92c9d0355ed30cc7495cfd Mon Sep 17 00:00:00 2001
From: wanghailiangx <hailiangx.e.wang@intel.com>
Date: Tue, 2 Mar 2021 11:49:16 -0500
Subject: [PATCH] lib/iscsi: add a comment for iscsi_parse_params()

When param len > 0, param data must not be NULL.
So we add a comment to make it clearer.

Change-Id: I053c3e45ddb8fa23fb67ce899d32dadd8e286946
Signed-off-by: wanghailiangx <hailiangx.e.wang@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/6618
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
---
 lib/iscsi/param.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/lib/iscsi/param.c b/lib/iscsi/param.c
index ab2c9cd26..0d0452c47 100644
--- a/lib/iscsi/param.c
+++ b/lib/iscsi/param.c
@@ -306,6 +306,8 @@ iscsi_parse_param(struct iscsi_param **params, const uint8_t *data, uint32_t dat
  *
  * \param data "KEY=VAL<NUL>KEY=VAL<NUL>..."
  * \param len length of data in bytes
+ *
+ * Data must point to a valid pointer if len > 0.
  */
 int
 iscsi_parse_params(struct iscsi_param **params, const uint8_t *data,