diff options
| author | Marcus Shawcroft <marcus.shawcroft@arm.com> | 2016-10-06 15:41:22 +0100 |
|---|---|---|
| committer | Anas Nashif <anas.nashif@intel.com> | 2016-10-07 08:05:50 -0400 |
| commit | 0b441518d9ce7ccf61476c5567f735de63816d81 (patch) | |
| tree | 5ceeebfb1d6e312fde4a3e8634541f1057f47906 /doc | |
| parent | ca26e7bb13ce9d34194cc6afddc1d9bad9254093 (diff) | |
docs: Adjust driver documentation to show const config_info example.
The driver config structure should be const, that can't happen until
various existing drivers are cleaned up, but it is safe for all
drivers that use config_info to treat it as const. Update the drivers
documentation to depict this usage.
Change-Id: I01507759be7d5c347a0eaf8068636d4a39a243e2
Signed-off-by: Marcus Shawcroft <marcus.shawcroft@arm.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/drivers/drivers.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/drivers/drivers.rst b/doc/drivers/drivers.rst index 0f08afa55..90293af5b 100644 --- a/doc/drivers/drivers.rst +++ b/doc/drivers/drivers.rst @@ -258,7 +258,7 @@ In the implementation of the common init function: int my_driver_init(struct device *device) { - struct my_driver_config *config = device->config->config_info; + const struct my_driver_config *config = device->config->config_info; /* Do other initialization stuff */ ... |