aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-12-30 13:28:10 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2009-12-30 13:28:10 +0000
commit320a3f140e693a0d8647fd05ec6d2d4cb10c523a (patch)
tree8ab4b7cb54b76ab6214fc387594a433790f8e30a
parenta6c74277befa3b1354aaf4b3bec386eebfdb61f7 (diff)
downloadChibiOS-320a3f140e693a0d8647fd05ec6d2d4cb10c523a.tar.gz
ChibiOS-320a3f140e693a0d8647fd05ec6d2d4cb10c523a.tar.bz2
ChibiOS-320a3f140e693a0d8647fd05ec6d2d4cb10c523a.zip
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1484 35acf78f-673a-0410-8e92-d51de3d6d3f4
-rw-r--r--docs/src/main.dox9
-rw-r--r--os/kernel/kernel.dox4
-rw-r--r--os/kernel/src/chevents.c2
-rw-r--r--os/kernel/src/chmemcore.c4
-rw-r--r--readme.txt1
5 files changed, 11 insertions, 9 deletions
diff --git a/docs/src/main.dox b/docs/src/main.dox
index ee1a2654c..4ce9b64b1 100644
--- a/docs/src/main.dox
+++ b/docs/src/main.dox
@@ -40,21 +40,22 @@
* event flags, messages, mailboxes, I/O queues.
* - No static setup at compile time, there is no need to configure a maximum
* number of all the above objects.
- * - PC simulator target included, the development can be done on the PC
- * using MinGW.<br>
+ * - PC simulator target included, the development can be done on a PC
+ * under Linux or Windows.<br>
* Timers, I/O channels and other HW resources are simulated in a
* Win32 process and the application code does not need to be aware of it.
- * MinGW demo available.
* - No *need* for a memory allocator, all the kernel structures are static
* and declaratively allocated.
* - Optional, thread safe, Heap Allocator subsystem.
* - Optional, thread safe, Memory Pools Allocator subsystem.
* - Blocking and non blocking I/O channels with timeout and events generation
* capability.
- * - Minimal system requirements: about 8KiB ROM with all options enabled and
+ * - Minimal system requirements: about 6KiB ROM with all options enabled and
* speed optimizations on. The size can shrink under 2KiB by disabling the
* the unused subsystems and optimizing for size.
* - Almost totally written in C with little ASM code required for ports.
+ * - Optional Hardware Abstraction Layer (HAL) with support for many device
+ * driver models and device driver implementations.
* .
* <h2>Related pages</h2>
* - @subpage lic_faq
diff --git a/os/kernel/kernel.dox b/os/kernel/kernel.dox
index 720e71977..0f544d04e 100644
--- a/os/kernel/kernel.dox
+++ b/os/kernel/kernel.dox
@@ -25,7 +25,7 @@
/**
* @defgroup kernel_info Version Numbers and Identification
- * Kernel related settings and hooks.
+ * Kernel related info.
* @ingroup kernel
*/
@@ -97,7 +97,7 @@
* mutexes are recommended for this kind of use) but also have other uses,
* queues guards and counters as example.<br>
* Semaphores usually use FIFO queues but it is possible to make them
- * order threads by priority by specifying CH_USE_SEMAPHORES_PRIORITY in
+ * order threads by priority by specifying @p CH_USE_SEMAPHORES_PRIORITY in
* @p chconf.h.<br>
* In order to use the Semaphores APIs the @p CH_USE_SEMAPHORES
* option must be specified in @p chconf.h.<br><br>
diff --git a/os/kernel/src/chevents.c b/os/kernel/src/chevents.c
index 70cab9d70..64636da66 100644
--- a/os/kernel/src/chevents.c
+++ b/os/kernel/src/chevents.c
@@ -175,7 +175,7 @@ void chEvtBroadcastI(EventSource *esp) {
}
/**
- * @brief Invokes the event handlers associated with a mask.
+ * @brief Invokes the event handlers associated to an event flags mask.
*
* @param[in] mask mask of the events to be dispatched
* @param[in] handlers an array of @p evhandler_t. The array must have size
diff --git a/os/kernel/src/chmemcore.c b/os/kernel/src/chmemcore.c
index 214504df7..65962bde1 100644
--- a/os/kernel/src/chmemcore.c
+++ b/os/kernel/src/chmemcore.c
@@ -50,7 +50,7 @@ void core_init(void) {
}
/**
- * @brief Allocates a block of memory.
+ * @brief Allocates a memory block.
* @details The size of the returned block is aligned to the alignment
* type @p align_t so it is not possible to allocate less than
* <code>sizeof(align_t)</code>.
@@ -70,7 +70,7 @@ void *chCoreAlloc(size_t size) {
}
/**
- * @brief Allocates a block of memory.
+ * @brief Allocates a memory block.
* @details The size of the returned block is aligned to the alignment
* type @p align_t so it is not possible to allocate less than
* <code>sizeof(align_t)</code>.
diff --git a/readme.txt b/readme.txt
index 21fea3db5..a341dc800 100644
--- a/readme.txt
+++ b/readme.txt
@@ -9,6 +9,7 @@
- FIX: Fixed section separators comments into the HAL-related files. Now all
the files should use the same style.
- NEW: Improved HAL configuration file.
+- Documentation fixes and improvements.
*** 1.3.6 ***
- FIX: Fixed missing STM32 PWM low level driver error in platform.mk by