ACPI: Constify ACPI device IDs in documentation
authorMathias Krause <minipli@googlemail.com>
Sat, 13 Jun 2015 12:27:00 +0000 (14:27 +0200)
committerRafael J. Wysocki <rafael.j.wysocki@intel.com>
Thu, 18 Jun 2015 23:14:15 +0000 (01:14 +0200)
ACPI device ID arrays normally don't need to be written to as they're
only ever read. The common usage -- embedding pointers to acpi_device_id
arrays in other data structures -- reference them as 'const', e.g. as in
struct acpi_driver / acpi_scan_handler / device_driver. The matchers are
taking const pointers, too. So it's only natural, to propose using const
arrays. Change the documentation accordingly.

Signed-off-by: Mathias Krause <minipli@googlemail.com>
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Documentation/acpi/enumeration.txt

index f44b0093d177997e8e7785a14f8cc1ecb02aba53..b731b292e8128e30439ae54c1f0f328b56e79b72 100644 (file)
@@ -42,7 +42,7 @@ Adding ACPI support for an existing driver should be pretty
 straightforward. Here is the simplest example:
 
        #ifdef CONFIG_ACPI
-       static struct acpi_device_id mydrv_acpi_match[] = {
+       static const struct acpi_device_id mydrv_acpi_match[] = {
                /* ACPI IDs here */
                { }
        };
@@ -166,7 +166,7 @@ the platform device drivers. Below is an example where we add ACPI support
 to at25 SPI eeprom driver (this is meant for the above ACPI snippet):
 
        #ifdef CONFIG_ACPI
-       static struct acpi_device_id at25_acpi_match[] = {
+       static const struct acpi_device_id at25_acpi_match[] = {
                { "AT25", 0 },
                { },
        };
@@ -230,7 +230,7 @@ Below is an example of how to add ACPI support to the existing mpu3050
 input driver:
 
        #ifdef CONFIG_ACPI
-       static struct acpi_device_id mpu3050_acpi_match[] = {
+       static const struct acpi_device_id mpu3050_acpi_match[] = {
                { "MPU3050", 0 },
                { },
        };