devicetree-compiler.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: David Gibson <david-xT8FGy+AXnRB3Ne2BGzF6laj5H9X9Tb+@public.gmane.org>
To: devicetree-compiler-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
Cc: u.kleine-koenig-bIcnvbaLZ9MEGnE8C9+IrQ@public.gmane.org,
	loeliger-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org,
	David Gibson
	<david-xT8FGy+AXnRB3Ne2BGzF6laj5H9X9Tb+@public.gmane.org>
Subject: [PATCH 3/4] Split out information for contributors to CONTRIBUTING.md
Date: Thu, 28 Jul 2022 17:53:47 +1000	[thread overview]
Message-ID: <20220728075348.174412-4-david@gibson.dropbear.id.au> (raw)
In-Reply-To: <20220728075348.174412-1-david-xT8FGy+AXnRB3Ne2BGzF6laj5H9X9Tb+@public.gmane.org>

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-xT8FGy+AXnRB3Ne2BGzF6laj5H9X9Tb+@public.gmane.org>
---
 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-u79uwXL29TY76Z2rM5mHXA@public.gmane.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.
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-u79uwXL29TY76Z2rM5mHXA@public.gmane.org)
-- 
2.37.1


  parent reply	other threads:[~2022-07-28  7:53 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-28  7:53 [PATCH 0/4] Updates to README file David Gibson
     [not found] ` <20220728075348.174412-1-david-xT8FGy+AXnRB3Ne2BGzF6laj5H9X9Tb+@public.gmane.org>
2022-07-28  7:53   ` [PATCH 1/4] Convert README to README.md David Gibson
2022-07-28  7:53   ` [PATCH 2/4] Remove Jon Loeliger from maintainers list David Gibson
2022-07-28  7:53   ` David Gibson [this message]
2022-07-28  7:53   ` [PATCH 4/4] Add description of Signed-off-by lines David Gibson
     [not found]     ` <20220728075348.174412-5-david-xT8FGy+AXnRB3Ne2BGzF6laj5H9X9Tb+@public.gmane.org>
2022-07-28 16:08       ` Uwe Kleine-König
     [not found]         ` <20220728160800.xiexlk52grqxre3j-bIcnvbaLZ9MEGnE8C9+IrQ@public.gmane.org>
2022-07-29  2:57           ` David Gibson

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220728075348.174412-4-david@gibson.dropbear.id.au \
    --to=david-xt8fgy+axnrb3ne2bgzf6laj5h9x9tb+@public.gmane.org \
    --cc=devicetree-compiler-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
    --cc=loeliger-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org \
    --cc=u.kleine-koenig-bIcnvbaLZ9MEGnE8C9+IrQ@public.gmane.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).