From 24e341be62d4411fb7c00c48e8ebc8c538544a0d Mon Sep 17 00:00:00 2001
From: Tanvi Jagtap <139093547+tanvi-jagtap@users.noreply.github.com>
Date: Thu, 29 Aug 2024 22:35:52 -0700
Subject: [PATCH] [Gpr_To_Absl_Logging] Adding comments to experimental absl
 wrappers (#37597)

[Gpr_To_Absl_Logging] Adding comments to experimental absl wrappers .
These will give additional context of why these were needed and when they should be removed.

Closes #37597

COPYBARA_INTEGRATE_REVIEW=https://github.com/grpc/grpc/pull/37597 from tanvi-jagtap:add_comment 7dc38b78e9a7788bb6788017129d396170ab17cd
PiperOrigin-RevId: 669197397
---
 include/grpc/support/log.h | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)

diff --git a/include/grpc/support/log.h b/include/grpc/support/log.h
index aa7f133177d..92a41f0066e 100644
--- a/include/grpc/support/log.h
+++ b/include/grpc/support/log.h
@@ -44,7 +44,10 @@ typedef enum gpr_log_severity {
 /**
  * EXPERIMENTAL. API stability not guaranteed.
  * Should only be used from gRPC PHP and RUBY.
- * Equivalent to ABSL_LOG(severity) << message_str;
+ * This will be removed once Ruby and PHP can start using C++ APIs.
+ * We would replace this with calls to absl LOG functions.
+ * grpc_absl_log is equivalent to
+ * ABSL_LOG(severity) << message_str;
  * **/
 GPRAPI void grpc_absl_log(const char* file, int line, gpr_log_severity severity,
                           const char* message_str);
@@ -52,7 +55,10 @@ GPRAPI void grpc_absl_log(const char* file, int line, gpr_log_severity severity,
 /**
  * EXPERIMENTAL. API stability not guaranteed.
  * Should only be used from gRPC PHP and RUBY.
- * Equivalent to ABSL_LOG(severity) << message_str << num;
+ * This will be removed once Ruby and PHP can start using C++ APIs.
+ * We would replace this with calls to absl LOG functions.
+ * grpc_absl_log_int is equivalent to
+ * ABSL_LOG(severity) << message_str << num;
  * **/
 GPRAPI void grpc_absl_log_int(const char* file, int line,
                               gpr_log_severity severity,
@@ -61,7 +67,10 @@ GPRAPI void grpc_absl_log_int(const char* file, int line,
 /**
  * EXPERIMENTAL. API stability not guaranteed.
  * Should only be used from gRPC PHP and RUBY.
- * Equivalent to ABSL_LOG(severity) << message_str1 << message_str2;
+ * This will be removed once Ruby and PHP can start using C++ APIs.
+ * We would replace this with calls to absl LOG functions.
+ * grpc_absl_log_str is equivalent to
+ * ABSL_LOG(severity) << message_str1 << message_str2;
  * **/
 GPRAPI void grpc_absl_log_str(const char* file, int line,
                               gpr_log_severity severity,