diff options
| -rw-r--r-- | docs/Doxyfile | 2 | ||||
| -rw-r--r-- | docs/src/portguide.dox | 23 | ||||
| -rw-r--r-- | os/kernel/include/ch.h | 4 |
3 files changed, 17 insertions, 12 deletions
diff --git a/docs/Doxyfile b/docs/Doxyfile index 9a11aa4d0..21ec9dac5 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -31,7 +31,7 @@ PROJECT_NAME = ChibiOS/RT # This could be handy for archiving the generated documentation or # if some version control system is used. -PROJECT_NUMBER = 1.3.2 +PROJECT_NUMBER = 1.3.3 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. diff --git a/docs/src/portguide.dox b/docs/src/portguide.dox index 14a3c2eca..fe5870732 100644 --- a/docs/src/portguide.dox +++ b/docs/src/portguide.dox @@ -75,16 +75,21 @@ * core (a common example: ARM7) of a supported microcontroller but has
* differences in the internal peripherals.<br>
* If this is your case proceed as follow:
- * -# Create a new directory under @p ./ports and name it as follow:
- * <code><i>@<arch@></i>-<i>@<chip@></i>[-<i>@<compiler@></i>]</code>
- * The compiler part can be omitted if the port uses GCC (our default).
- * Examples: @p ARM7-LPC236x or @p ARMCM3-STM32F103-IAR
+ * -# Create a new directory under @p <code>./os/io/platforms</code> and
+ * name it with the microcontroller name (or family name).<br>
+ * In case of the ARM-based microcontroller you also need to create a
+ * equally named directory under
+ * @p <code>./os/ports/<i>@<compiler@></i>/<i>@<arch@></i></code> and
+ * put there the microcontroller related files such as the vectors table,
+ * see the existing ports as example.
* -# Copy into the newly created directory the most closely related existing
- * chip port.
- * -# Rename the files in order to reflect the name of the new chip.
- * -# Work out the differences in the drivers.
- * -# Edit the documentation file @p port.dox, this is required if you want
- * to regenerate this documentation including your work.
+ * chip port or the naked template files from
+ * @p <code>./os/io/templates</code>.
+ * -# Work out the differences in the drivers or implement them if you started
+ * from the templates.
+ * -# Edit/create the documentation file @p <code>platform.dox</code>, this
+ * is required if you want to regenerate this documentation including
+ * your work.
* .
* Usually this kind of port just requires a serial driver (and those are very
* similar each other) and some code for the interrupt controller (this one
diff --git a/os/kernel/include/ch.h b/os/kernel/include/ch.h index 5608147b9..46d917e29 100644 --- a/os/kernel/include/ch.h +++ b/os/kernel/include/ch.h @@ -35,7 +35,7 @@ /**
* Kernel version string. */
-#define CH_KERNEL_VERSION "1.3.2unstable"
+#define CH_KERNEL_VERSION "1.3.3unstable"
/**
* Kernel version major number. @@ -50,7 +50,7 @@ /**
* Kernel version patch number. */
-#define CH_KERNEL_PATCH 2
+#define CH_KERNEL_PATCH 3
/*
* Common values.
|