mirror of
https://github.com/micropython/micropython.git
synced 2025-12-16 09:50:15 +01:00
all: Unify header guard usage.
The code conventions suggest using header guards, but do not define how those should look like and instead point to existing files. However, not all existing files follow the same scheme, sometimes omitting header guards altogether, sometimes using non-standard names, making it easy to accidentally pick a "wrong" example. This commit ensures that all header files of the MicroPython project (that were not simply copied from somewhere else) follow the same pattern, that was already present in the majority of files, especially in the py folder. The rules are as follows. Naming convention: * start with the words MICROPY_INCLUDED * contain the full path to the file * replace special characters with _ In addition, there are no empty lines before #ifndef, between #ifndef and one empty line before #endif. #endif is followed by a comment containing the name of the guard macro. py/grammar.h cannot use header guards by design, since it has to be included multiple times in a single C file. Several other files also do not need header guards as they are only used internally and guaranteed to be included only once: * MICROPY_MPHALPORT_H * mpconfigboard.h * mpconfigport.h * mpthreadport.h * pin_defs_*.h * qstrdefs*.h
This commit is contained in:
committed by
Damien George
parent
d91c1170ca
commit
299bc62586
@@ -23,12 +23,12 @@
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
* THE SOFTWARE.
|
||||
*/
|
||||
#ifndef __MICROPY_INCLUDED_PY_UNICODE_H__
|
||||
#define __MICROPY_INCLUDED_PY_UNICODE_H__
|
||||
#ifndef MICROPY_INCLUDED_PY_UNICODE_H
|
||||
#define MICROPY_INCLUDED_PY_UNICODE_H
|
||||
|
||||
#include "py/mpconfig.h"
|
||||
#include "py/misc.h"
|
||||
|
||||
mp_uint_t utf8_ptr_to_index(const byte *s, const byte *ptr);
|
||||
|
||||
#endif // __MICROPY_INCLUDED_PY_UNICODE_H__
|
||||
#endif // MICROPY_INCLUDED_PY_UNICODE_H
|
||||
|
||||
Reference in New Issue
Block a user