From: Simon Glass <sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
To: Devicetree Compiler
<devicetree-compiler-u79uwXL29TY76Z2rM5mHXA@public.gmane.org>
Cc: Benjamin Bimmermann <b.bimmermann-LWAfsSFWpa4@public.gmane.org>,
Ulrich Langenbach
<ulrich.langenbach-srmvecZYGfHobmly5n/iKBvVK+yQ3ZXh@public.gmane.org>,
David Gibson
<david-xT8FGy+AXnRB3Ne2BGzF6laj5H9X9Tb+@public.gmane.org>,
Simon Glass <sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
Subject: [PATCH v4 3/5] Mention pylibfdt in the documentation
Date: Sun, 5 Feb 2017 13:13:21 -0700 [thread overview]
Message-ID: <20170205201323.15411-4-sjg@chromium.org> (raw)
In-Reply-To: <20170205201323.15411-1-sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
Add a note about pylibfdt in the README.
Signed-off-by: Simon Glass <sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
---
Changes in v4: None
Changes in v3: None
Changes in v2:
- Add details on how to obtain full help and code coverage
README | 33 +++++++++++++++++++++++++++++++++
1 file changed, 33 insertions(+)
diff --git a/README b/README
index f92008f..7191d1b 100644
--- a/README
+++ b/README
@@ -7,6 +7,39 @@ DTC and LIBFDT are maintained by:
David Gibson <david-xT8FGy+AXnRB3Ne2BGzF6laj5H9X9Tb+@public.gmane.org>
Jon Loeliger <jdl-CYoMK+44s/E@public.gmane.org>
+
+Python library
+--------------
+
+A Python library is also available. To build this you will need to install
+swig and Python development files. On Debian distributions:
+
+ sudo apt-get install swig python-dev
+
+The library provides an Fdt class which you can use like this:
+
+ fdt = _ReadFdt('test_tree1.dtb')
+ node = fdt.path_offset('/test-node')
+ prop = fdt.first_property_offset(node)
+ print 'Property name: %s' % fdt.string(prop.nameoff)
+ print 'Property data: %s' % fdt.data(prop.nameoff)
+
+You will find tests in tests/pylibfdt_tests.py showing how to use each
+method. Help is available using the Python help command, e.g.:
+
+ $ cd pylibfdt
+ $ python -c "import libfdt; help(libfdt)"
+
+If you add new features, please check code coverage:
+
+ $ sudo apt-get install python-pip python-pytest
+ $ sudo pip install coverage
+ $ cd tests
+ $ coverage run pylibfdt_tests.py
+ $ coverage html
+ # Open 'htmlcov/index.html' in your browser
+
+
Mailing list
------------
The following list is for discussion about dtc and libfdt implementation
--
2.11.0.483.g087da7b7c-goog
next prev parent reply other threads:[~2017-02-05 20:13 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-02-05 20:13 [PATCH v4 0/5] Introduce Python bindings for libfdt Simon Glass
[not found] ` <20170205201323.15411-1-sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
2017-02-05 20:13 ` [PATCH v4 1/5] Add an initial Python library " Simon Glass
[not found] ` <20170205201323.15411-2-sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
2017-02-10 4:37 ` David Gibson
2017-02-10 18:39 ` Simon Glass
[not found] ` <CAPnjgZ31rZqoYTg4m=3yAFuT2UuL9i4qc4+w-G34Aq75sdfrfA-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2017-02-13 5:20 ` David Gibson
2017-02-15 18:55 ` Ulrich Langenbach
2017-02-16 2:11 ` David Gibson
[not found] ` <20170216021123.GO12369-K0bRW+63XPQe6aEkudXLsA@public.gmane.org>
2017-02-27 7:21 ` Ulrich Langenbach
2017-02-10 5:04 ` David Gibson
2017-02-05 20:13 ` [PATCH v4 2/5] Add tests for pylibfdt Simon Glass
[not found] ` <20170205201323.15411-3-sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
2017-02-10 4:56 ` David Gibson
2017-02-10 18:39 ` Simon Glass
2017-02-05 20:13 ` Simon Glass [this message]
[not found] ` <20170205201323.15411-4-sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
2017-02-10 4:58 ` [PATCH v4 3/5] Mention pylibfdt in the documentation David Gibson
2017-02-10 18:39 ` Simon Glass
2017-02-05 20:13 ` [PATCH v4 4/5] Adjust libfdt.h to work with swig Simon Glass
[not found] ` <20170205201323.15411-5-sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org>
2017-02-10 5:01 ` David Gibson
2017-02-10 18:39 ` Simon Glass
2017-02-05 20:13 ` [PATCH v4 5/5] Build pylibfdt as part of the normal build process Simon Glass
2017-02-10 5:05 ` [PATCH v4 0/5] Introduce Python bindings for libfdt David Gibson
2017-02-10 18:39 ` Simon Glass
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=20170205201323.15411-4-sjg@chromium.org \
--to=sjg-f7+t8e8rja9g9huczpvpmw@public.gmane.org \
--cc=b.bimmermann-LWAfsSFWpa4@public.gmane.org \
--cc=david-xT8FGy+AXnRB3Ne2BGzF6laj5H9X9Tb+@public.gmane.org \
--cc=devicetree-compiler-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
--cc=ulrich.langenbach-srmvecZYGfHobmly5n/iKBvVK+yQ3ZXh@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).