diff options
| author | Alexander Steffen <devel.20.webmeister@spamgourmet.com> | 2017-06-29 23:14:58 +0200 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2017-07-18 11:57:39 +1000 |
| commit | 299bc625864b9e624ed599c94a5f95870516139a (patch) | |
| tree | 0ecb36ebb856aa26850f6995bb70500ff348348b /lib/netutils/netutils.h | |
| parent | d91c1170ca489b6f754918e678ed412a246eb8cc (diff) | |
| download | micropython-299bc625864b9e624ed599c94a5f95870516139a.tar.gz micropython-299bc625864b9e624ed599c94a5f95870516139a.zip | |
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
Diffstat (limited to 'lib/netutils/netutils.h')
| -rw-r--r-- | lib/netutils/netutils.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/lib/netutils/netutils.h b/lib/netutils/netutils.h index 45e0216402..1e147afa95 100644 --- a/lib/netutils/netutils.h +++ b/lib/netutils/netutils.h @@ -24,8 +24,8 @@ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. */ -#ifndef __MICROPY_INCLUDED_LIB_NETUTILS_H__ -#define __MICROPY_INCLUDED_LIB_NETUTILS_H__ +#ifndef MICROPY_INCLUDED_LIB_NETUTILS_NETUTILS_H +#define MICROPY_INCLUDED_LIB_NETUTILS_NETUTILS_H #define NETUTILS_IPV4ADDR_BUFSIZE 4 @@ -47,4 +47,4 @@ void netutils_parse_ipv4_addr(mp_obj_t addr_in, uint8_t *out_ip, netutils_endian // puts IP in out_ip (which must take at least IPADDR_BUF_SIZE bytes). mp_uint_t netutils_parse_inet_addr(mp_obj_t addr_in, uint8_t *out_ip, netutils_endian_t endian); -#endif // __MICROPY_INCLUDED_LIB_NETUTILS_H__ +#endif // MICROPY_INCLUDED_LIB_NETUTILS_NETUTILS_H |