aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2011-01-09 13:33:20 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2011-01-09 13:33:20 +0000
commit59cd671ba931279556dff5abf1db652f7611a6a6 (patch)
treee732795af9dadc7c8bf93c3bf1a26fa212191fdb
parent463cf04eef626e77e60533a1d1a199f45aa755fc (diff)
downloadChibiOS-59cd671ba931279556dff5abf1db652f7611a6a6.tar.gz
ChibiOS-59cd671ba931279556dff5abf1db652f7611a6a6.tar.bz2
ChibiOS-59cd671ba931279556dff5abf1db652f7611a6a6.zip
Fixed bug 3153591.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2629 35acf78f-673a-0410-8e92-d51de3d6d3f4
-rw-r--r--os/hal/dox/adc.dox2
-rw-r--r--os/hal/dox/can.dox2
-rw-r--r--os/hal/dox/i2c.dox2
-rw-r--r--os/hal/dox/mac.dox2
-rw-r--r--os/hal/dox/mmc_spi.dox2
-rw-r--r--os/hal/dox/pal.dox2
-rw-r--r--os/hal/dox/pwm.dox2
-rw-r--r--os/hal/dox/serial.dox2
-rw-r--r--os/hal/dox/spi.dox2
-rw-r--r--os/hal/dox/uart.dox2
-rw-r--r--readme.txt1
11 files changed, 11 insertions, 10 deletions
diff --git a/os/hal/dox/adc.dox b/os/hal/dox/adc.dox
index 8e31d983b..9ebfca99c 100644
--- a/os/hal/dox/adc.dox
+++ b/os/hal/dox/adc.dox
@@ -21,7 +21,7 @@
* @defgroup ADC ADC Driver
* @brief Generic ADC Driver.
* @details This module implements a generic ADC driver.
- * @pre In order to use the ADC driver the @p CH_HAL_USE_ADC option
+ * @pre In order to use the ADC driver the @p HAL_USE_ADC option
* must be enabled in @p halconf.h.
*
* @section adc_1 Driver State Machine
diff --git a/os/hal/dox/can.dox b/os/hal/dox/can.dox
index 44c11c1de..81ee24e8b 100644
--- a/os/hal/dox/can.dox
+++ b/os/hal/dox/can.dox
@@ -21,7 +21,7 @@
* @defgroup CAN CAN Driver
* @brief Generic CAN Driver.
* @details This module implements a generic CAN driver.
- * @pre In order to use the CAN driver the @p CH_HAL_USE_CAN option
+ * @pre In order to use the CAN driver the @p HAL_USE_CAN option
* must be enabled in @p halconf.h.
*
* @section can_1 Driver State Machine
diff --git a/os/hal/dox/i2c.dox b/os/hal/dox/i2c.dox
index dfac0fb7c..151c7a66e 100644
--- a/os/hal/dox/i2c.dox
+++ b/os/hal/dox/i2c.dox
@@ -21,7 +21,7 @@
* @defgroup I2C I2C Driver
* @brief Generic I2C Driver.
* @details This module implements a generic I2C driver.
- * @pre In order to use the ADC driver the @p CH_HAL_USE_I2C option
+ * @pre In order to use the I2C driver the @p HAL_USE_I2C option
* must be enabled in @p halconf.h.
*
* @section i2c_1 Driver State Machine
diff --git a/os/hal/dox/mac.dox b/os/hal/dox/mac.dox
index b3aca74ab..778795f15 100644
--- a/os/hal/dox/mac.dox
+++ b/os/hal/dox/mac.dox
@@ -22,7 +22,7 @@
* @brief Generic MAC driver.
* @details This module implements a generic interface for MAC (Media
* Access Control) drivers, as example Ethernet controllers.
- * @pre In order to use the ADC driver the @p CH_HAL_USE_MAC option
+ * @pre In order to use the MAC driver the @p HAL_USE_MAC option
* must be enabled in @p halconf.h.
*
* @ingroup IO
diff --git a/os/hal/dox/mmc_spi.dox b/os/hal/dox/mmc_spi.dox
index 65e66391e..e18ff1a8a 100644
--- a/os/hal/dox/mmc_spi.dox
+++ b/os/hal/dox/mmc_spi.dox
@@ -22,7 +22,7 @@
* @brief Generic MMC driver.
* @details This module implements a portable MMC driver that uses a SPI
* driver as physical layer.
- * @pre In order to use the ADC driver the @p CH_HAL_USE_MMC_SPI option
+ * @pre In order to use the MMC_SPI driver the @p HAL_USE_MMC_SPI option
* must be enabled in @p halconf.h.
*
* @section mmc_spi_1 Driver State Machine
diff --git a/os/hal/dox/pal.dox b/os/hal/dox/pal.dox
index 12a1192be..4c7fe685a 100644
--- a/os/hal/dox/pal.dox
+++ b/os/hal/dox/pal.dox
@@ -32,7 +32,7 @@
* functions in order to support specific features but, of course, the use of
* such interfaces would not be portable. Such interfaces shall be marked with
* the architecture name inside the function names.
- * @pre In order to use the ADC driver the @p CH_HAL_USE_PAL option
+ * @pre In order to use the PAL driver the @p HAL_USE_PAL option
* must be enabled in @p halconf.h.
*
* @section pal_1 Implementation Rules
diff --git a/os/hal/dox/pwm.dox b/os/hal/dox/pwm.dox
index ebc3731ab..6fbe2efa1 100644
--- a/os/hal/dox/pwm.dox
+++ b/os/hal/dox/pwm.dox
@@ -21,7 +21,7 @@
* @defgroup PWM PWM Driver
* @brief Generic PWM Driver.
* @details This module implements a generic PWM driver.
- * @pre In order to use the ADC driver the @p CH_HAL_USE_PWM option
+ * @pre In order to use the PWM driver the @p HAL_USE_PWM option
* must be enabled in @p halconf.h.
*
* @section pwm_1 Driver State Machine
diff --git a/os/hal/dox/serial.dox b/os/hal/dox/serial.dox
index f9d46d360..071b2dac5 100644
--- a/os/hal/dox/serial.dox
+++ b/os/hal/dox/serial.dox
@@ -27,7 +27,7 @@
* events.<br>
* The module also contains functions that make the implementation of the
* interrupt service routines much easier.
- * @pre In order to use the ADC driver the @p CH_HAL_USE_SERIAL option
+ * @pre In order to use the SERIAL driver the @p HAL_USE_SERIAL option
* must be enabled in @p halconf.h.
*
* @ingroup IO
diff --git a/os/hal/dox/spi.dox b/os/hal/dox/spi.dox
index 732536a17..7f68f3c40 100644
--- a/os/hal/dox/spi.dox
+++ b/os/hal/dox/spi.dox
@@ -21,7 +21,7 @@
* @defgroup SPI SPI Driver
* @brief Generic SPI Driver.
* @details This module implements a generic SPI driver.
- * @pre In order to use the ADC driver the @p CH_HAL_USE_SPI option
+ * @pre In order to use the SPI driver the @p HAL_USE_SPI option
* must be enabled in @p halconf.h.
*
* @section spi_1 Driver State Machine
diff --git a/os/hal/dox/uart.dox b/os/hal/dox/uart.dox
index 00753195d..192ce4d91 100644
--- a/os/hal/dox/uart.dox
+++ b/os/hal/dox/uart.dox
@@ -39,7 +39,7 @@
* .
* If your application requires a synchronoyus buffered driver then the
* @ref SERIAL should be used instead.
- * @pre In order to use the ADC driver the @p CH_HAL_USE_UART option
+ * @pre In order to use the UART driver the @p HAL_USE_UART option
* must be enabled in @p halconf.h.
*
* @section uart_1 Driver State Machine
diff --git a/readme.txt b/readme.txt
index f5e7fa2de..5b49ca75b 100644
--- a/readme.txt
+++ b/readme.txt
@@ -65,6 +65,7 @@
*****************************************************************************
*** 2.1.7 ***
+- FIX: Fixed various errors in the HAL documentation (bug 3153591).
- FIX: Fixed error in chIOGetxxxxxEventSource() macros (bug 3153550)
(backported to 2.0.10)
- FIX: Fixed error in STM32 unbuffered UART driver (bug 3153437).