gpio: Clarify that <linux/gpio.h> is legacy

Message ID 20171130100453.29561-1-linus.walleij@linaro.org
State Accepted
Commit 56a46b6144e7311e2bf605755a168409ef527fc4
Headers show
Series
  • gpio: Clarify that <linux/gpio.h> is legacy
Related show

Commit Message

Linus Walleij Nov. 30, 2017, 10:04 a.m.
It should be clear to developers that they should not include
this file in new code.

Suggested-by: Arnd Bergmann <arnd@arndb.de>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>

---
While I should certainly try to fix checkpatch.pl to warn
about this, it doesn't hurt to spell it out in the file as well.
---
 include/linux/gpio.h | 10 ++++++++++
 1 file changed, 10 insertions(+)

-- 
2.14.3

--
To unsubscribe from this list: send the line "unsubscribe linux-gpio" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Patch

diff --git a/include/linux/gpio.h b/include/linux/gpio.h
index 8ef7fc0ce0f0..91ed23468530 100644
--- a/include/linux/gpio.h
+++ b/include/linux/gpio.h
@@ -1,4 +1,14 @@ 
 /* SPDX-License-Identifier: GPL-2.0 */
+/*
+ * <linux/gpio.h>
+ *
+ * This is the LEGACY GPIO bulk include file, including legacy APIs. It is
+ * used for GPIO drivers still referencing the global GPIO numberspace,
+ * and should not be included in new code.
+ *
+ * If you're implementing a GPIO driver, only include <linux/gpio/driver.h>
+ * If you're implementing a GPIO consumer, only include <linux/gpio/consumer.h>
+ */
 #ifndef __LINUX_GPIO_H
 #define __LINUX_GPIO_H