kdb: Corrects comment for kdballocenv

This patch corrects the comment for the kdballocenv function.
The previous comment incorrectly described the function's
parameters and return values.

Signed-off-by: Yuran Pereira <yuran.pereira@hotmail.com>
Link: https://lore.kernel.org/r/DB3PR10MB6835B383B596133EDECEA98AE8ABA@DB3PR10MB6835.EURPRD10.PROD.OUTLOOK.COM
[daniel.thompson@linaro.org: fixed whitespace alignment in new lines]
Signed-off-by: Daniel Thompson <daniel.thompson@linaro.org>

diff --git a/kernel/debug/kdb/kdb_main.c b/kernel/debug/kdb/kdb_main.c
index 438b868cbfa9228fde28eb95375ec9b7218ff136..6b213c8252d62df7a30dd2b0f861e6bb1895be36 100644 (file)
--- a/kernel/debug/kdb/kdb_main.c
+++ b/kernel/debug/kdb/kdb_main.c
@@ -272,11 +272,10 @@ char *kdbgetenv(const char *match)
  * kdballocenv - This function is used to allocate bytes for
  *     environment entries.
  * Parameters:
- *     match   A character string representing a numeric value
- * Outputs:
- *     *value  the unsigned long representation of the env variable 'match'
+ *     bytes   The number of bytes to allocate in the static buffer.
  * Returns:
- *     Zero on success, a kdb diagnostic on failure.
+ *     A pointer to the allocated space in the buffer on success.
+ *     NULL if bytes > size available in the envbuffer.
  * Remarks:
  *     We use a static environment buffer (envbuffer) to hold the values
  *     of dynamically generated environment variables (see kdb_set).  Buffer