tequilaOS/platform_external_dtc
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Split out information for contributors to CONTRIBUTING.md

Browse source 
README.md covers both general information for people using and building
the software, and more specific information for people contributing to
either dtc or libfdt.  Split out the latter information into its own file
for easier reference.

Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
This commit is contained in:
David Gibson 2022-07-28 16:24:28 +10:00
parent 0ee1d479b2
commit 90b9d9de42
2 changed files with 25 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,25 @@
# Contributing to dtc or libfdt
There are two ways to submit changes for dtc or libfdt:
* Post patches directly to the the
[devicetree-compiler](mailto:devicetree-compiler@vger.kernel.org)
mailing list.
* Submit pull requests via
[Github](https://github.com/dgibson/dtc/pulls)
## Adding a new function to libfdt.h
The shared library uses `libfdt/version.lds` to list the exported
functions, so add your new function there. Check that your function
works with pylibfdt. If it cannot be supported, put the declaration in
`libfdt.h` behind `#ifndef SWIG` so that swig ignores it.
## Tests
Test files are kept in the `tests/` directory. Use `make check` to build and run
all tests.
If you want to adjust a test file, be aware that `tree_tree1.dts` is compiled
and checked against a binary tree from assembler macros in `trees.S`. So
if you change that file you must change `tree.S` also.

19
README.md
View file

@ -91,25 +91,6 @@ $ make NO_PYTHON=1
More work remains to support all of libfdt, including access to numeric
values.
## Adding a new function to libfdt.h
The shared library uses `libfdt/version.lds` to list the exported
functions, so add your new function there. Check that your function
works with pylibfdt. If it cannot be supported, put the declaration in
`libfdt.h` behind `#ifndef SWIG` so that swig ignores it.
## Tests
Test files are kept in the `tests/` directory. Use `make check` to build and run
all tests.
If you want to adjust a test file, be aware that `tree_tree1.dts` is compiled
and checked against a binary tree from assembler macros in `trees.S`. So
if you change that file you must change `tree.S` also.
## Mailing lists
* The [devicetree-compiler](mailto:devicetree-compiler@vger.kernel.org)