rtems/rtems-libbsd
1
0
Fork 0
mirror of https://git.rtems.org/rtems-libbsd/ synced 2025-10-16 07:28:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Sebastian Huber
2017-10-10 14:35:40 +02:00
parent acf428e92f
commit cd7d52dbe9
1 changed files with 26 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
CONTRIBUTING.md
View File

@@ -159,16 +159,16 @@ threaded execution of the application but minimizes the necessary changes to the
original FreeBSD code. original FreeBSD code.
* Import and commit the unchanged source files like described above. * Import and commit the unchanged source files like described above.
* Add the files to the libbsd.py and build them. * Add the files to the [libbsd.py](libbsd.py) and build them.
* Check the sources for everything that can be made const. This type of patches * Check the sources for everything that can be made const. This type of patches
should go back to the upstream FreeBSD sources. should go back to the upstream FreeBSD sources.
* Move static variables out of functions if necessary (search for * Move static variables out of functions if necessary (search for
"<TAB>static"). These patches most likely will not be accepted into FreeBSD. "\tstatic"). These patches most likely will not be accepted into FreeBSD.
* Add a rtems_bsd_command_PROGNAME() wrapper function to the source file * Add a rtems_bsd_command_PROGNAME() wrapper function to the source file
containing the main function (e.g. PROGNAME = pfctl). For an example look at containing the main function (e.g. PROGNAME = pfctl). For an example look at
`rtems_bsd_command_pfctl()` in `freebsd/sbin/pfctl/pfctl.c`. `rtems_bsd_command_pfctl()` in [pfctl.c](freebsd/sbin/pfctl/pfctl.c).
* You probably have to use getopt_r() instead of getopt(). Have a look at * You probably have to use getopt_r() instead of getopt(). Have a look at
`freebsd/sbin/pfctl/pfctl.c`. [pfctl.c](freebsd/sbin/pfctl/pfctl.c).
* Build the libbsd without optimization. * Build the libbsd without optimization.
* Use the `userspace-header-gen.py` to generate some necessary header * Use the `userspace-header-gen.py` to generate some necessary header
files. It will generate one `rtems-bsd-PROGNAME-MODULE-data.h` per object file, one files. It will generate one `rtems-bsd-PROGNAME-MODULE-data.h` per object file, one
@@ -180,13 +180,29 @@ original FreeBSD code.
has to match the name that is used in the RTEMS linker set further below. has to match the name that is used in the RTEMS linker set further below.
* If you regenerated files that have already been generated, you may have to * If you regenerated files that have already been generated, you may have to
remove RTEMS-specific names from the namespace. The defaults (linker set names remove RTEMS-specific names from the namespace. The defaults (linker set names
and rtems_bsd_program_xxx) should already be filtered. and rtems_bsd_program_.*) should already be filtered.
* Put the generated header files into the same folder like the source files. * Put the generated header files into the same folder like the source files.
* Include `PROGNAME-rtems-bsd-namespace.h` at the top of each source file and * At the top of each source file place the following right after the user-space header:
the `PROGNAME-rtems-bsd-MODULE-data.h` after the include section of the ```c
corresponding source files. #ifdef __rtems__
* Include `machine/rtems-bsd-program.h` at the top of the include block in each #include <machine/rtems-bsd-program.h>
source file. #include "rtems-bsd-PROGNAME-namespace.h"
#endif /* __rtems__ */
```
The following command may be useful:
```
sed -i 's%#include <machine/rtems-bsd-user-space.h>%#include <machine/rtems-bsd-user-space.h>\n#ifdef __rtems__\n#include <machine/rtems-bsd-program.h>\n#include "rtems-bsd-PROGNAME-namespace.h"\n#endif /* __rtems__ */%' *.c
```
* At the bottom of each source file place the follwing:
```c
#ifdef __rtems__
#include "rtems-bsd-PROGNAME-FILE-data.h"
#endif /* __rtems__ */
```
The following command may be useful:
```
for i in *.c ; do n=$(basename $i .c) ; echo -e "#ifdef __rtems__\n#include \"rtems-bsd-PROGNAME-$n-data.h\"\n#endif /* __rtems__ */" >> $i ; done
```
* Create one compilable commit. * Create one compilable commit.
Rules for Modifying FreeBSD Source Rules for Modifying FreeBSD Source