SDL: Note that SDL_HAPTIC_GAIN_MAX should remain an environment variable.

From 6f399c3beb9e5c72e1e460cf30b6da44221cbe48 Mon Sep 17 00:00:00 2001
From: Sam Lantinga <[EMAIL REDACTED]>
Date: Sat, 3 Aug 2024 11:50:23 -0700
Subject: [PATCH] Note that SDL_HAPTIC_GAIN_MAX should remain an environment
 variable.

---
 docs/README-migration.md | 1 +
 src/haptic/SDL_haptic.c  | 2 +-
 2 files changed, 2 insertions(+), 1 deletion(-)

diff --git a/docs/README-migration.md b/docs/README-migration.md
index 526f7c844ddfd..676ad1332ed97 100644
--- a/docs/README-migration.md
+++ b/docs/README-migration.md
@@ -812,6 +812,7 @@ The following environment variables have been removed:
 * SDL_DISKAUDIOFILE - replaced with the hint SDL_HINT_AUDIO_DISK_OUTPUT_FILE
 * SDL_DISKAUDIOFILEIN - replaced with the hint SDL_HINT_AUDIO_DISK_INPUT_FILE
 * SDL_DUMMYAUDIODELAY - replaced with the hint SDL_HINT_AUDIO_DUMMY_TIMESCALE which allows scaling the audio time rather than specifying an absolute delay.
+* SDL_HAPTIC_GAIN_MAX
 * SDL_HIDAPI_DISABLE_LIBUSB - replaced with the hint SDL_HINT_HIDAPI_LIBUSB
 * SDL_HIDAPI_JOYSTICK_DISABLE_UDEV - replaced with the hint SDL_HINT_HIDAPI_UDEV
 * VITA_DISABLE_TOUCH_BACK - replaced with the hint SDL_HINT_VITA_ENABLE_BACK_TOUCH
diff --git a/src/haptic/SDL_haptic.c b/src/haptic/SDL_haptic.c
index bb009ec565c31..be296261709ff 100644
--- a/src/haptic/SDL_haptic.c
+++ b/src/haptic/SDL_haptic.c
@@ -539,7 +539,7 @@ int SDL_SetHapticGain(SDL_Haptic *haptic, int gain)
         return SDL_SetError("Haptic: Gain must be between 0 and 100.");
     }
 
-    /* We use the envvar to get the maximum gain. */
+    /* The user can use an environment variable to override the max gain. */
     env = SDL_getenv("SDL_HAPTIC_GAIN_MAX");
     if (env) {
         max_gain = SDL_atoi(env);