From 5ea4e8842a786dfc6314d7ac85ddbef4abbcde35 Mon Sep 17 00:00:00 2001 From: Felix Held Date: Mon, 7 Oct 2013 00:39:02 +0200 Subject: [PATCH] Clarify HACKING document use stdint-types, not short types remove info on file stucture of examples, this was removed some time ago, add reference to libopencm3-examples instead. --- HACKING | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/HACKING b/HACKING index 42ffb100..d5a24eee 100644 --- a/HACKING +++ b/HACKING @@ -59,22 +59,12 @@ Development guidelines - All subsystem-specific function names should be prefixed with the subsystem name. For example, gpio_set_mode() or rcc_osc_on(). - - Please consistently use the short form types from , - e.g. u8, u16, u32, and so on. + - Please consistently use the stdint types. - Variables that are used to store register values read from registers or to be stored in a register should be named reg8, reg16, reg32 etc. - - In the examples directory, the following structure should be used: - - - One (or more) subdirectories for the type of microcontroller, e.g. - lm3s, lpc13xx, stm32/f1, stm32/f2, stm32/f4. - - - One subdirectory in there for each eval board or piece of hardware, e.g. - stm32-h103, lisa-m, stm32vl-discovery, stm32f4-discovery, etc. - - - One subdirectory in there for each example, e.g. - miniblink, button, usart, usb_dfu, etc. + - For examples on using libopencm3 see the libopencm3-examples repository. Tips and tricks ---------------