From: Simon Glass <sjg@chromium.org>
Date: Wed, 7 Sep 2022 02:26:53 +0000 (-0600)
Subject: log: update the comment for log_msg_ret()
X-Git-Tag: v2023.07~312^2^2~40
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=b7f134eeceb51c9bfe7ab82e0e5f751ddcb74976;p=platform%2Fkernel%2Fu-boot.git

log: update the comment for log_msg_ret()

Add some advice on string size here.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

diff --git a/include/log.h b/include/log.h
index df497ba..8a7b961 100644
--- a/include/log.h
+++ b/include/log.h
@@ -322,7 +322,10 @@ void __assert_fail(const char *assertion, const char *file, unsigned int line,
  *
  * or:
  *
- *	return log_msg_ret("fred failed", fred_call());
+ *	return log_msg_ret("get", fred_call());
+ *
+ * It is recommended to use <= 3 characters for the name since this will only
+ * use 4 bytes in rodata
  */
 #define log_ret(_ret) ({ \
 	int __ret = (_ret); \