docs: driver-model: move it to the driver-api book
authorMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Tue, 18 Jun 2019 15:34:59 +0000 (12:34 -0300)
committerMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Mon, 15 Jul 2019 14:03:02 +0000 (11:03 -0300)
The audience for the Kernel driver-model is clearly Kernel hackers.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Acked-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com> # ice driver changes
24 files changed:
Documentation/driver-api/driver-model/binding.rst [moved from Documentation/driver-model/binding.rst with 100% similarity]
Documentation/driver-api/driver-model/bus.rst [moved from Documentation/driver-model/bus.rst with 100% similarity]
Documentation/driver-api/driver-model/class.rst [moved from Documentation/driver-model/class.rst with 100% similarity]
Documentation/driver-api/driver-model/design-patterns.rst [moved from Documentation/driver-model/design-patterns.rst with 100% similarity]
Documentation/driver-api/driver-model/device.rst [moved from Documentation/driver-model/device.rst with 100% similarity]
Documentation/driver-api/driver-model/devres.rst [moved from Documentation/driver-model/devres.rst with 100% similarity]
Documentation/driver-api/driver-model/driver.rst [moved from Documentation/driver-model/driver.rst with 100% similarity]
Documentation/driver-api/driver-model/index.rst [moved from Documentation/driver-model/index.rst with 96% similarity]
Documentation/driver-api/driver-model/overview.rst [moved from Documentation/driver-model/overview.rst with 100% similarity]
Documentation/driver-api/driver-model/platform.rst [moved from Documentation/driver-model/platform.rst with 100% similarity]
Documentation/driver-api/driver-model/porting.rst [moved from Documentation/driver-model/porting.rst with 99% similarity]
Documentation/driver-api/gpio/driver.rst
Documentation/driver-api/index.rst
Documentation/eisa.txt
Documentation/filesystems/sysfs.txt
Documentation/hwmon/submitting-patches.rst
Documentation/translations/zh_CN/filesystems/sysfs.txt
drivers/base/platform.c
drivers/gpio/gpio-cs5535.c
drivers/net/ethernet/intel/ice/ice_main.c
drivers/staging/unisys/Documentation/overview.txt
include/linux/device.h
include/linux/platform_device.h
scripts/coccinelle/free/devm_free.cocci

similarity index 96%
rename from Documentation/driver-model/index.rst
rename to Documentation/driver-api/driver-model/index.rst
index 9f85d579ce56488e14b23f0deeb6be8f4ee46bb3..755016422269fb6e01ec3896d622b6f2949c6ffc 100644 (file)
@@ -1,5 +1,3 @@
-:orphan:
-
 ============
 Driver Model
 ============
similarity index 99%
rename from Documentation/driver-model/porting.rst
rename to Documentation/driver-api/driver-model/porting.rst
index ae4bf843c1d638f4c62e53e63083e9730871edd6..931ea879af3ff686f9a9c75c911825b9f8ba63ae 100644 (file)
@@ -9,7 +9,7 @@ Patrick Mochel
 
 Overview
 
-Please refer to `Documentation/driver-model/*.rst` for definitions of
+Please refer to `Documentation/driver-api/driver-model/*.rst` for definitions of
 various driver types and concepts.
 
 Most of the work of porting devices drivers to the new model happens
index 349f2dc33029d6b64ac148f139bb16df590c954b..921c71a3d6839234b04f84d072c3aa1129dd4cdc 100644 (file)
@@ -399,7 +399,7 @@ symbol:
   will pass the struct gpio_chip* for the chip to all IRQ callbacks, so the
   callbacks need to embed the gpio_chip in its state container and obtain a
   pointer to the container using container_of().
-  (See Documentation/driver-model/design-patterns.rst)
+  (See Documentation/driver-api/driver-model/design-patterns.rst)
 
 - gpiochip_irqchip_add_nested(): adds a nested cascaded irqchip to a gpiochip,
   as discussed above regarding different types of cascaded irqchips. The
index b4c993ff765500edeab9cf19d1b0dc197e72ba59..9fb03b7bdeb1ae94c06cdf70175cd5153d44da81 100644 (file)
@@ -14,6 +14,7 @@ available subsections can be seen below.
 .. toctree::
    :maxdepth: 2
 
+   driver-model/index
    basics
    infrastructure
    early-userspace/index
index f388545a85a7539358df86cf90d6ca5628539066..c07565ba57da5830a9fed4f5e7c45015783478a9 100644 (file)
@@ -103,7 +103,7 @@ id_table    an array of NULL terminated EISA id strings,
                (driver_data).
 
 driver         a generic driver, such as described in
-               Documentation/driver-model/driver.rst. Only .name,
+               Documentation/driver-api/driver-model/driver.rst. Only .name,
                .probe and .remove members are mandatory.
 =============== ====================================================
 
@@ -152,7 +152,7 @@ state    set of flags indicating the state of the device. Current
         flags are EISA_CONFIG_ENABLED and EISA_CONFIG_FORCED.
 res     set of four 256 bytes I/O regions allocated to this device
 dma_mask DMA mask set from the parent device.
-dev     generic device (see Documentation/driver-model/device.rst)
+dev     generic device (see Documentation/driver-api/driver-model/device.rst)
 ======== ============================================================
 
 You can get the 'struct eisa_device' from 'struct device' using the
index 5b5311f9358dee0d24979ad8052f68b1417efb89..ddf15b1b0d5a471a0a58fac79b37adcdb27f5baa 100644 (file)
@@ -319,7 +319,7 @@ quick way to lookup the sysfs interface for a device from the result of
 a stat(2) operation.
 
 More information can driver-model specific features can be found in
-Documentation/driver-model/. 
+Documentation/driver-api/driver-model/.
 
 
 TODO: Finish this section.
index d5b05d3e54baeb95aaed199fc8e966b115af01c3..452fc28d8e0bb3f7efefc6f20c5a0786ae72b22e 100644 (file)
@@ -89,7 +89,7 @@ increase the chances of your change being accepted.
   console. Excessive logging can seriously affect system performance.
 
 * Use devres functions whenever possible to allocate resources. For rationale
-  and supported functions, please see Documentation/driver-model/devres.rst.
+  and supported functions, please see Documentation/driver-api/driver-model/devres.rst.
   If a function is not supported by devres, consider using devm_add_action().
 
 * If the driver has a detect function, make sure it is silent. Debug messages
index 452271dda141abd5596b04f01e53fc01d6bfc175..ee1f37da5b234394b3034058fc0deb886a8dfc1b 100644 (file)
@@ -288,7 +288,7 @@ dev/ 包含两个子目录: char/ 和 block/。在这两个子目录中,有
 中相应的设备。/sys/dev 提供一个通过一个 stat(2) 操作结果,查找
 设备 sysfs 接口快捷的方法。
 
-更多有关 driver-model 的特性信息可以在 Documentation/driver-model/
+更多有关 driver-model 的特性信息可以在 Documentation/driver-api/driver-model/
 中找到。
 
 
index 71390329038553cf5b56693f8ac7abbbf94c640d..506a0175a5a781cf297cc0153038dc4aa9b48d86 100644 (file)
@@ -5,7 +5,7 @@
  * Copyright (c) 2002-3 Patrick Mochel
  * Copyright (c) 2002-3 Open Source Development Labs
  *
- * Please see Documentation/driver-model/platform.rst for more
+ * Please see Documentation/driver-api/driver-model/platform.rst for more
  * information.
  */
 
index 3611a05716673bdfbba22b2c017b113d88e8f281..53b24e3ae7de0613a93ac20242454893185bb555 100644 (file)
@@ -41,7 +41,7 @@ MODULE_PARM_DESC(mask, "GPIO channel mask.");
 
 /*
  * FIXME: convert this singleton driver to use the state container
- * design pattern, see Documentation/driver-model/design-patterns.rst
+ * design pattern, see Documentation/driver-api/driver-model/design-patterns.rst
  */
 static struct cs5535_gpio_chip {
        struct gpio_chip chip;
index 41c90f2ddb31d6e4471172b2174d5e3e5bd7f23d..63db08d9bafabfd95b5c4d66035f4dd5e7f5da03 100644 (file)
@@ -2286,7 +2286,7 @@ ice_probe(struct pci_dev *pdev, const struct pci_device_id __always_unused *ent)
        struct ice_hw *hw;
        int err;
 
-       /* this driver uses devres, see Documentation/driver-model/devres.rst */
+       /* this driver uses devres, see Documentation/driver-api/driver-model/devres.rst */
        err = pcim_enable_device(pdev);
        if (err)
                return err;
index 9ab30af265a5df6e01ccc95f8cf76edcfdfbd565..f8a4144b239c59374a367fd3e6136fd63597ba0f 100644 (file)
@@ -15,7 +15,7 @@ normally be unsharable, specifically:
 * visorinput - keyboard and mouse
 
 These drivers conform to the standard Linux bus/device model described
-within Documentation/driver-model/, and utilize a driver named visorbus to
+within Documentation/driver-api/driver-model/, and utilize a driver named visorbus to
 present the virtual busses involved. Drivers in the 'visor*' driver set are
 commonly referred to as "guest drivers" or "client drivers".  All drivers
 except visorbus expose a device of a specific usable class to the Linux guest
@@ -141,7 +141,7 @@ called automatically by the visorbus driver at appropriate times:
 -----------------------------------
 
 Because visorbus is a standard Linux bus driver in the model described in
-Documentation/driver-model/, the hierarchy of s-Par virtual devices is
+Documentation/driver-api/driver-model/, the hierarchy of s-Par virtual devices is
 published in the sysfs tree beneath /bus/visorbus/, e.g.,
 /sys/bus/visorbus/devices/ might look like:
 
index 5eabfa0c4dee65437e733e29c7031c91fbde4752..c330b75c6c57cdbd46a360bff2b50c96bde4d515 100644 (file)
@@ -6,7 +6,7 @@
  * Copyright (c) 2004-2009 Greg Kroah-Hartman <gregkh@suse.de>
  * Copyright (c) 2008-2009 Novell Inc.
  *
- * See Documentation/driver-model/ for more information.
+ * See Documentation/driver-api/driver-model/ for more information.
  */
 
 #ifndef _DEVICE_H_
index beb25f277889a6aed5ad676e328708782b07c18f..9bc36b589827fe41e47c975044622108f127bff5 100644 (file)
@@ -4,7 +4,7 @@
  *
  * Copyright (c) 2001-2003 Patrick Mochel <mochel@osdl.org>
  *
- * See Documentation/driver-model/ for more information.
+ * See Documentation/driver-api/driver-model/ for more information.
  */
 
 #ifndef _PLATFORM_DEVICE_H_
index fefd0331a2ded935d79d11af707433fcc401611e..441799b5359b59dab4fd684ef6b88f8afca7b5c4 100644 (file)
@@ -3,7 +3,7 @@
 /// functions.  Values allocated using the devm_functions are freed when
 /// the device is detached, and thus the use of the standard freeing
 /// function would cause a double free.
-/// See Documentation/driver-model/devres.rst for more information.
+/// See Documentation/driver-api/driver-model/devres.rst for more information.
 ///
 /// A difficulty of detecting this problem is that the standard freeing
 /// function might be called from a different function than the one