From 6ad2d207c5f56320a3573dd883c6d0400c145a77 Mon Sep 17 00:00:00 2001
From: Tanu Kaskinen <tanuk@iki.fi>
Date: Sun, 22 Nov 2020 16:14:58 +0200
Subject: [PATCH] alsa-mixer: Document the description and description-key
 mapping options

---
 src/modules/alsa/mixer/profile-sets/default.conf | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/src/modules/alsa/mixer/profile-sets/default.conf b/src/modules/alsa/mixer/profile-sets/default.conf
index 92f23d272..9b691fed4 100644
--- a/src/modules/alsa/mixer/profile-sets/default.conf
+++ b/src/modules/alsa/mixer/profile-sets/default.conf
@@ -44,7 +44,11 @@
 ; [Mapping id]
 ; device-strings = ...                      # ALSA device string. %f will be replaced by the card identifier.
 ; channel-map = ...                         # Channel mapping to use for this device
-; description = ...
+; description = ...                         # Description for the mapping. Note that it's better to set the description
+;                                           # in the well_known_descriptions table in alsa-mixer.c than with this
+;                                           # option, because the descriptions in alsa-mixer.c are translatable.
+; description-key = ...                     # A custom key for the well_known_descriptions table (by default the mapping
+;                                           # name is used).
 ; paths-input = ...                         # A list of mixer paths to use. Every path in this list will be probed.
 ;                                           # If multiple are found to be working they will be available as device ports
 ; paths-output = ...