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@xxxxxxxxxxxxxxxxxxxxx> --- CONTRIBUTING.md | 25 +++++++++++++++++++++++++ README.md | 19 ------------------- 2 files changed, 25 insertions(+), 19 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..51f7a82 --- /dev/null +++ b/CONTRIBUTING.md @@ -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@xxxxxxxxxxxxxxx) + 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. diff --git a/README.md b/README.md index 36a3912..8f1a5d2 100644 --- a/README.md +++ b/README.md @@ -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@xxxxxxxxxxxxxxx) -- 2.37.1
