Skip to contentSkip to conversation

pylibfdt: Add installation support

PATCH Applied Simon Glass 2 participants 5 messages Apr 7, 2017 – Apr 8, 2017 1 message not in the archive Kbuild

lore
Share & tools
lore
#0 lore raw

v4 cover pylibfdt: Add installation support

This series adds support for installation of the Pylib module. It adjusts the setup.py file to provide this functionality and the Makefile rules to call it correctly.

It also adds a way to disable building the Python module. This is useful since some build systems want to use setup.py to do both the build and the install step. In this case the correct build commands would be:

make NO_PYTHON=1
make install_pylibfdt SETUP_PREFIX=/path/to/install_prefix

Version 3 adds support for running setup.py stand-alone:

   ./pylibfdt/setup.py --install_path [--prefix=/path/to/install_dir]

Changes in v4:
- Fix dependencies to allow Python tests to run from a clean tree
- Install Python library in pylibfdt/ correctly

Changes in v3:
- Update README to suggest using setup.py for an easy install
- Allow setup.py to be run from the base directory
- Make setup.py executable
- Use define..endef instead of line continuations
- Add new patch to move to Makefile constructs for NO_PYTHON
- Update for new test dependency
- Add a new patch to use setup.py to build the swig file

Changes in v2:
- Add new patch to allow setup.py to operation stand-alone
- Rebase to master

Simon Glass (3):
pylibfdt: Allow setup.py to operate stand-alone
pylibfdt: Use Makefile constructs to implement NO_PYTHON
pylibfdt: Use setup.py to build the swig file

 Makefile                   | 16 ++++++--
 README                     | 14 +++++--
 pylibfdt/Makefile.pylibfdt | 30 ++++++--------
 pylibfdt/setup.py          | 98 +++++++++++++++++++++++++++++++++++++++++++---
 tests/Makefile.tests       |  6 +--
 5 files changed, 129 insertions(+), 35 deletions(-)
 mode change 100644 => 100755 pylibfdt/setup.py
Signature · 1 line
2.12.2.715.g7642488e1d-goog

A message that is not in the archive (sent off-list or not yet received): 20170407215134.2477-1-sjg-F7+t8E8rja9g9hUCZPvPmw@public.gmane.org

#2 lore raw

PATCH v4 1/3 pylibfdt: Allow setup.py to operate stand-alone

At present we require that setup.py is executed from the Makefile, which sets up various important things like the list of files to build and the version number.

However many installation systems expect to be able to change to the directory containing setup.py and run it. This allows them to support (for example) building/installing for multiple Python versions, varying installation paths, particular C flags, etc.

The problem in implementing this is that we don't want to duplicate the information in the Makefile. A common solution (so I am told) is to parse the Makefile to obtain the required information.

Update the setup.py script to read a few Makefiles when it does not see the required information in its environment. This allows installation using:

./pylibfdt/setup.py install

---

Changes in v4:
- Fix dependencies to allow Python tests to run from a clean tree
- Install Python library in pylibfdt/ correctly

Changes in v3:
- Update README to suggest using setup.py for an easy install
- Allow setup.py to be run from the base directory
- Make setup.py executable
- Use define..endef instead of line continuations

Changes in v2:
- Add new patch to allow setup.py to operation stand-alone
- Rebase to master

 Makefile                   |  1 +
 README                     | 14 +++++--
 pylibfdt/Makefile.pylibfdt |  9 +++--
 pylibfdt/setup.py          | 98 +++++++++++++++++++++++++++++++++++++++++++---
 tests/Makefile.tests       |  6 +--
 5 files changed, 112 insertions(+), 16 deletions(-)
 mode change 100644 => 100755 pylibfdt/setup.py
Makefile +1 -0
index 52ff72c..154f5bf 100644
@@ -267,6 +267,7 @@ TESTS_BIN += convert-dtsv0
 TESTS_BIN += fdtput
 TESTS_BIN += fdtget
 TESTS_BIN += fdtdump
+TESTS_PYLIBFDT += maybe_pylibfdt
 
 include tests/Makefile.tests
 
README +10 -4
index 5add557..17dc845 100644
@@ -50,12 +50,18 @@ If you add new features, please check code coverage:
     # Open 'htmlcov/index.html' in your browser
 
 
-To install the library use:
+To install the library via the normal setup.py method, use:
 
-    make install_pylibfdt SETUP_PREFIX=/path/to/install_dir
+    ./pylibfdt/setup.py [--prefix=/path/to/install_dir]
 
-If SETUP_PREFIX is not provided, the default prefix is used, typically '/usr'
-or '/usr/local'. See Python's distutils documentation for details.
+If --prefix is not provided, the default prefix is used, typically '/usr'
+or '/usr/local'. See Python's distutils documentation for details. You can
+also install via the Makefile if you like, but the above is more common.
+
+To install both libfdt and pylibfdt you can use:
+
+    make install [SETUP_PREFIX=/path/to/install_dir] \
+            [PREFIX=/path/to/install_dir]
 
 To disable building the python library, even if swig and Python are available,
 use:
pylibfdt/Makefile.pylibfdt +6 -3
index 06f9296..0e8ac5f 100644
@@ -5,13 +5,16 @@ PYLIBFDT_srcs = $(addprefix $(LIBFDT_srcdir)/,$(LIBFDT_SRCS))
 WRAP = $(PYLIBFDT_objdir)/libfdt_wrap.c
 PYMODULE = $(PYLIBFDT_objdir)/_libfdt.so
 
-run_setup = SOURCES="$(1)" CPPFLAGS="$(CPPFLAGS)" OBJDIR="$(PYLIBFDT_objdir)" \
-	VERSION="$(dtc_version)" \
-	python $(PYLIBFDT_objdir)/setup.py --quiet $(2)
+define run_setup
+	SOURCES="$(1)" CPPFLAGS="$(CPPFLAGS)" OBJDIR="$(PYLIBFDT_objdir)"
+	VERSION="$(dtc_version)"
+	$(PYLIBFDT_objdir)/setup.py --quiet $(2)
+endef
 
 $(PYMODULE): $(PYLIBFDT_srcs) $(WRAP)
 	@$(VECHO) PYMOD $@
 	$(call run_setup, $^, build_ext --inplace)
+	mv _libfdt.so $@
 
 $(WRAP): $(PYLIBFDT_srcdir)/libfdt.i
 	@$(VECHO) SWIG $@
pylibfdt/setup.py +92 -6

123 lines not on this page · raw message

tests/Makefile.tests +3 -3
index 3d7a4f8..2258135 100644
@@ -72,13 +72,13 @@ tests_clean:
 	rm -f $(STD_CLEANFILES:%=$(TESTS_PREFIX)%)
 	rm -f $(TESTS_CLEANFILES)
 
-check:	tests ${TESTS_BIN}
+check:	tests ${TESTS_BIN} $(TESTS_PYLIBFDT)
 	cd $(TESTS_PREFIX); ./run_tests.sh
 
-checkm: tests ${TESTS_BIN}
+checkm: tests ${TESTS_BIN} $(TESTS_PYLIBFDT)
 	cd $(TESTS_PREFIX); ./run_tests.sh -m 2>&1 | tee vglog.$$$$
 
-checkv:	tests ${TESTS_BIN}
+checkv:	tests ${TESTS_BIN} $(TESTS_PYLIBFDT)
 	cd $(TESTS_PREFIX); ./run_tests.sh -v
 
 ifneq ($(DEPTARGETS),)
Signature · 1 line
2.12.2.715.g7642488e1d-goog
#3 lore raw

PATCH v4 2/3 pylibfdt: Use Makefile constructs to implement NO_PYTHON

In reply to a message not in the archive

The current mechanism uses a shell construct, but it seems better to use a Makefile approach.

---

Changes in v4: None
Changes in v3:
- Add new patch to move to Makefile constructs for NO_PYTHON
- Update for new test dependency

Changes in v2: None

 Makefile                   | 15 ++++++++++++---
 pylibfdt/Makefile.pylibfdt |  7 -------
 2 files changed, 12 insertions(+), 10 deletions(-)
Makefile +12 -3
index 154f5bf..beca4a0 100644
@@ -117,10 +117,11 @@ BIN += fdtput
 
 SCRIPTS = dtdiff
 
+all: $(BIN) libfdt
+
 # We need both Python and swig to build pylibfdt.
 .PHONY: maybe_pylibfdt
 maybe_pylibfdt: FORCE
-	if [ -n "${NO_PYTHON}" ]; then exit; fi; \
 	if $(PKG_CONFIG) --cflags python >/dev/null 2>&1; then \
 		if which swig >/dev/null 2>&1; then \
 			can_build=yes; \
@@ -132,7 +133,9 @@ maybe_pylibfdt: FORCE
 		echo "## Skipping pylibfdt (install python dev and swig to build)"; \
 	fi
 
-all: $(BIN) libfdt maybe_pylibfdt
+ifeq ($(NO_PYTHON),)
+all: maybe_pylibfdt
+endif
 
 
 ifneq ($(DEPTARGETS),)
@@ -195,7 +198,11 @@ install-includes:
 	$(INSTALL) -d $(DESTDIR)$(INCLUDEDIR)
 	$(INSTALL) -m 644 $(LIBFDT_include) $(DESTDIR)$(INCLUDEDIR)
 
-install: install-bin install-lib install-includes maybe_install_pylibfdt
+install: install-bin install-lib install-includes
+
+ifeq ($(NO_PYTHON),)
+install: install_pylibfdt
+endif
 
 $(VERSION_FILE): Makefile FORCE
 	$(call filechk,version)
@@ -267,7 +274,9 @@ TESTS_BIN += convert-dtsv0
 TESTS_BIN += fdtput
 TESTS_BIN += fdtget
 TESTS_BIN += fdtdump
+ifeq ($(NO_PYTHON),)
 TESTS_PYLIBFDT += maybe_pylibfdt
+endif
 
 include tests/Makefile.tests
 
pylibfdt/Makefile.pylibfdt +0 -7
index 0e8ac5f..4036b1f 100644
@@ -25,11 +25,4 @@ install_pylibfdt: $(WRAP) $(PYMODULE)
 	$(call run_setup, $(PYLIBFDT_srcs) $(WRAP), \
 		install $(if $(SETUP_PREFIX),--prefix=$(SETUP_PREFIX)))
 
-maybe_install_pylibfdt:
-	if [ -e $(PYMODULE) ]; then \
-		if [ -z "$(NO_PYTHON)" ]; then \
-			$(MAKE) install_pylibfdt; \
-		fi; \
-	fi
-
 PYLIBFDT_cleanfiles = libfdt_wrap.c libfdt.py libfdt.pyc _libfdt.so
Signature · 1 line
2.12.2.715.g7642488e1d-goog
#4 lore raw

PATCH v4 3/3 pylibfdt: Use setup.py to build the swig file

In reply to a message not in the archive

Since we are using the standard .i extension for the swig file, we can use setup.py to build the wrapper. Drop the existing build code since it is not needed.

---

Changes in v4: None
Changes in v3:
- Add a new patch to use setup.py to build the swig file

Changes in v2: None

 pylibfdt/Makefile.pylibfdt | 14 +++++---------
 1 file changed, 5 insertions(+), 9 deletions(-)
pylibfdt/Makefile.pylibfdt +5 -9
index 4036b1f..9507d3d 100644
@@ -1,8 +1,8 @@
 # Makefile.pylibfdt
 #
 
-PYLIBFDT_srcs = $(addprefix $(LIBFDT_srcdir)/,$(LIBFDT_SRCS))
-WRAP = $(PYLIBFDT_objdir)/libfdt_wrap.c
+PYLIBFDT_srcs = $(addprefix $(LIBFDT_srcdir)/,$(LIBFDT_SRCS)) \
+		$(PYLIBFDT_srcdir)/libfdt.i
 PYMODULE = $(PYLIBFDT_objdir)/_libfdt.so
 
 define run_setup
@@ -11,18 +11,14 @@ define run_setup
 	$(PYLIBFDT_objdir)/setup.py --quiet $(2)
 endef
 
-$(PYMODULE): $(PYLIBFDT_srcs) $(WRAP)
+$(PYMODULE): $(PYLIBFDT_srcs)
 	@$(VECHO) PYMOD $@
 	$(call run_setup, $^, build_ext --inplace)
 	mv _libfdt.so $@
 
-$(WRAP): $(PYLIBFDT_srcdir)/libfdt.i
-	@$(VECHO) SWIG $@
-	$(SWIG) -python -o $@ $<
-
-install_pylibfdt: $(WRAP) $(PYMODULE)
+install_pylibfdt: $(PYMODULE)
 	$(VECHO) INSTALL-PYLIB; \
-	$(call run_setup, $(PYLIBFDT_srcs) $(WRAP), \
+	$(call run_setup, $(PYLIBFDT_srcs), \
 		install $(if $(SETUP_PREFIX),--prefix=$(SETUP_PREFIX)))
 
 PYLIBFDT_cleanfiles = libfdt_wrap.c libfdt.py libfdt.pyc _libfdt.so
Signature · 1 line
2.12.2.715.g7642488e1d-goog
Applied
#5 lore raw
In reply to a message not in the archive
Quoted 11 lines · Simon Glass

This series adds support for installation of the Pylib module. It adjusts the setup.py file to provide this functionality and the Makefile rules to call it correctly.

It also adds a way to disable building the Python module. This is useful since some build systems want to use setup.py to do both the build and the install step. In this case the correct build commands would be:

make NO_PYTHON=1
make install_pylibfdt SETUP_PREFIX=/path/to/install_prefix

Applied, thanks.

Signature · 4 lines
David Gibson			| I'll have my music baroque, and my code
david AT gibson.dropbear.id.au	| minimalist, thank you.  NOT _the_ _other_
				| _way_ _around_!
http://www.ozlabs.org/~dgibson