Refine README about performing make-dist.py on workstation
authorAdrian Müller <adrian.mueller@intra2net.com>
Mon, 2 Mar 2026 09:39:37 +0000 (10:39 +0100)
committerChristian Herdtweck <christian.herdtweck@intra2net.com>
Tue, 3 Mar 2026 09:37:42 +0000 (10:37 +0100)
This should avoid confusion when trying to update pyi2ncommon.

README
doc/index.rst
make_dist.py

diff --git a/README b/README
index bd6eaa6..2effea8 100644 (file)
--- a/README
+++ b/README
@@ -11,3 +11,12 @@ API documentation: see doc/about_docu.rst
 To build an rpm package, run:
 
   make_dist.py
+
+This needs to be performed using the same python version as the
+one that the rpm will be installed to. Therefore, if you build
+for QA, you should run this on your workstation, not your
+intradev.
+
+Note, that this will create directories "dist" inside the
+pyi2ncommon dir, and "rpmbuild" in your home directory (if they
+do not exist, already).
\ No newline at end of file
index 0e42495..d470747 100644 (file)
@@ -7,7 +7,7 @@ Welcome to pyi2ncommon's documentation!
 =======================================
 
 This library has two main purposes:
-  (1) provide an interface to external python code (i.e., code not running
+  (1) provide an interface for external python code (i.e., code not running
       inside a Intra2net system, most notably QA tests) to some of the internal
       workings of Intra2net systems. This includes:
          - the configuration system (module :py:mod:`pyi2ncommon.cnfvar`)
index 17de73b..bf6c8a7 100755 (executable)
@@ -6,6 +6,11 @@ Create source tarball, create rpm from it together with spec file.
 Create a source tarball that is compatible with standard build pipelines. Then
 run rpmbuild on it to create an installable rpm.
 
+The python version, that was used to build the rpm, determines the target paths
+of the rpm (e.g. if building with version 3.13, then the rpm will install its
+files to /usr/lib/python3.13/site-packages). Therefore, rpm building must be
+executed on an appropriate platform.
+
 .. codeauthor:: Intra2net AG <info@intra2net.com>
 """