Received-SPF: pass (google.com: domain of keerthigd4990@gmail.com designates 2607:f8b0:400e:c00::241 as permitted sender) client-ip=2607:f8b0:400e:c00::241;
Date: Thu, 28 Sep 2017 20:06:02 +0530
From: Keerthi Reddy <keerthigd4990@gmail.com>
To: outreachy-kernel@googlegroups.com, speakup@linux-speakup.org,
	chris@the-brannons.com, w.d.hubbs@gmail.com, kirk@reisers.ca,
	samuel.thibault@ens-lyon.org
Subject: [PATCH] Staging: speakup: Add comment for spinlock definition
Message-ID: <20170928143602.GA15962@manoharreddy>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
User-Agent: Mutt/1.5.24 (2015-08-30)

Its good practice to comment the usage of spinlock variable.
Specially because, at the time of congestion, it becomes easy
to identify how a particular mutex is used. This improves
readability of code. So add comment for spinlock variable.

Signed-off-by: Keerthi Reddy <keerthigd4990@gmail.com>
---
 drivers/staging/speakup/main.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/staging/speakup/main.c b/drivers/staging/speakup/main.c
index e215d05..bb3908a 100644
--- a/drivers/staging/speakup/main.c
+++ b/drivers/staging/speakup/main.c
@@ -246,7 +246,7 @@ static u_long last_spk_jiffy;
 
 struct st_spk_t *speakup_console[MAX_NR_CONSOLES];
 
-DEFINE_MUTEX(spk_mutex);
+DEFINE_MUTEX(spk_mutex); /* Spinlock for synth_release() */
 
 static int keyboard_notifier_call(struct notifier_block *,
 				  unsigned long code, void *param);
-- 
2.7.4