rtems/rtems-libbsd
1
0
Fork 0
mirror of https://git.rtems.org/rtems-libbsd/ synced 2025-06-02 02:23:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

doc: Update rules to modify FreeBSD code

Browse Source
This commit is contained in:
Sebastian Huber 2016-08-23 15:37:01 +02:00
parent 0c24e06130
commit 7c77211d0f
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
libbsd.txt
View File

@ -651,12 +651,23 @@ missing_rtems_comments_in_the_guards(int j)
}
-------------------------------------------------------------------------------
Do not disable option header includes via guards. Instead, add an empty option
header, e.g. `rtemsbsd/include/rtems/bsd/local/opt_xyz.h`. In general, provide
empty header files and do not guard includes.
The FreeBSD build and configuration system uses option header files, e.g.
`#include "opt_xyz.h"` in an unmodified FreeBSD file. This include is
transformed by the import script into `#include <rtems/bsd/local/opt_xyz.h>`. Do
not disable option header includes via guards. Instead, add an empty option
header, e.g. `touch rtemsbsd/include/rtems/bsd/local/opt_xyz.h`.
-------------------------------------------------------------------------------
/* WRONG */
#ifndef __rtems__
#include <rtems/bsd/local/opt_xyz.h>
#endif /* __rtems__ */
-------------------------------------------------------------------------------
In general, provide empty header files and do not guard includes.
For new code use
http://www.freebsd.org/cgi/man.cgi?query=style&apropos=0&sektion=9&manpath=FreeBSD+9.2-RELEASE&arch=default&format=html[STYLE(9)].
Do not format original FreeBSD code.
== BSD Library Source