rtems/rtems-libbsd
1
0
Fork 0
mirror of https://git.rtems.org/rtems-libbsd/ synced 2025-05-14 04:09:26 +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-19 11:18:52 +02:00
parent 69355c3ce3
commit a971614a91
1 changed files with 30 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
libbsd.txt
View File

@ -625,6 +625,36 @@ include a `__rtems__` in the guards to make searches easy, so use
* `#else /* __rtems__ */`, and * `#else /* __rtems__ */`, and
* `#endif /* __rtems__ */`. * `#endif /* __rtems__ */`.
The guards must start at the begin of the line. Examples for wrong guards:
-------------------------------------------------------------------------------
static void
guards_must_start_at_the_begin_of_the_line(int j)
{
#ifdef __rtems__
return (j + 1);
#else /* __rtems__ */
return (j + 2);
#endif /* __rtems__ */
}
static void
missing_rtems_comments_in_the_guards(int j)
{
#ifdef __rtems__
return (j + 3);
#else
return (j + 4);
#endif
}
-------------------------------------------------------------------------------
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.
For new code use 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)]. 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. Do not format original FreeBSD code.