diff options
author | Masahiro Yamada <masahiroy@kernel.org> | 2020-06-26 15:13:33 +0900 |
---|---|---|
committer | Tom Rini <trini@konsulko.com> | 2020-07-17 09:30:13 -0400 |
commit | b75d8dc5642b71eb029e7cd38031a32029e736cc (patch) | |
tree | e13a2c309a27c528a79f7c49b468c0c2d246a499 /doc/README.POST | |
parent | 02ff91e8c60f1f48bee8f4bd1c87ea0892cc5dae (diff) | |
download | u-boot-b75d8dc5642b71eb029e7cd38031a32029e736cc.tar.gz |
treewide: convert bd_t to struct bd_info by coccinelle
The Linux coding style guide (Documentation/process/coding-style.rst)
clearly says:
It's a **mistake** to use typedef for structures and pointers.
Besides, using typedef for structures is annoying when you try to make
headers self-contained.
Let's say you have the following function declaration in a header:
void foo(bd_t *bd);
This is not self-contained since bd_t is not defined.
To tell the compiler what 'bd_t' is, you need to include <asm/u-boot.h>
#include <asm/u-boot.h>
void foo(bd_t *bd);
Then, the include direcective pulls in more bloat needlessly.
If you use 'struct bd_info' instead, it is enough to put a forward
declaration as follows:
struct bd_info;
void foo(struct bd_info *bd);
Right, typedef'ing bd_t is a mistake.
I used coccinelle to generate this commit.
The semantic patch that makes this change is as follows:
<smpl>
@@
typedef bd_t;
@@
-bd_t
+struct bd_info
</smpl>
Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
Diffstat (limited to 'doc/README.POST')
0 files changed, 0 insertions, 0 deletions