documentation: remove extraneous words
[git.git] / banned.h
blob44e76bd90af76938f04f7e7b0df8818d4bb81e61
1 #ifndef BANNED_H
2 #define BANNED_H
4 /*
5 * This header lists functions that have been banned from our code base,
6 * because they're too easy to misuse (and even if used correctly,
7 * complicate audits). Including this header turns them into compile-time
8 * errors.
9 */
11 #define BANNED(func) sorry_##func##_is_a_banned_function
13 #undef strcpy
14 #define strcpy(x,y) BANNED(strcpy)
15 #undef strcat
16 #define strcat(x,y) BANNED(strcat)
17 #undef strncpy
18 #define strncpy(x,y,n) BANNED(strncpy)
19 #undef strncat
20 #define strncat(x,y,n) BANNED(strncat)
21 #undef strtok
22 #define strtok(x,y) BANNED(strtok)
23 #undef strtok_r
24 #define strtok_r(x,y,z) BANNED(strtok_r)
26 #undef sprintf
27 #undef vsprintf
28 #define sprintf(...) BANNED(sprintf)
29 #define vsprintf(...) BANNED(vsprintf)
31 #undef gmtime
32 #define gmtime(t) BANNED(gmtime)
33 #undef localtime
34 #define localtime(t) BANNED(localtime)
35 #undef ctime
36 #define ctime(t) BANNED(ctime)
37 #undef ctime_r
38 #define ctime_r(t, buf) BANNED(ctime_r)
39 #undef asctime
40 #define asctime(t) BANNED(asctime)
41 #undef asctime_r
42 #define asctime_r(t, buf) BANNED(asctime_r)
44 #endif /* BANNED_H */