python: README.md: adjust recursive dep text, misc
authorEneas U de Queiroz <cote2004-github@yahoo.com>
Mon, 20 May 2019 16:49:31 +0000 (13:49 -0300)
committerEneas U de Queiroz <cote2004-github@yahoo.com>
Mon, 20 May 2019 19:17:30 +0000 (16:17 -0300)
Adding the conditionals to DEPENDS should not cause circular
dependencies any more.  This adjusts the text to point out that it used
to be a problem, and if it happens again, one should open an issue.

Also, some spotted trivial errors were fixed.

Signed-off-by: Eneas U de Queiroz <cote2004-github@yahoo.com>
lang/python/README.md

index 698c09e0187cc8aa231ff411e1aa1566a7caaa4c..bde643e82f7d27f0891e017d9fe270bcc06f472b 100644 (file)
@@ -228,9 +228,9 @@ endef
 Some considerations here (based on the example above):
 * be sure to make sure that `DEPENDS` are correct for both variants; as seen in the example above, `python-codecs` is needed only for `python-lxml` (see **[note-encodings](#note-encodings)**)
 * consider adding conditional DEPENDS for each variant ; so for each Python[3] package add `+PACKAGE_python-lxml:<dep>` as seen in the above example ; the reason for this is build-time reduction ; if you want to build Python3 only packages, this won't build Python & Python packages + dependencies ; this is a known functionality of OpenWrt build deps
-  * there is an exception to the above consideration: if adding `+PACKAGE_python-lxml` conditional deps creates circular dependencies [for some weird reason], then this can be omitted
+  * this should not happen anymore, but if adding `+PACKAGE_python-lxml` conditional deps creates circular dependencies, then open an issue so this can be resolved again.
 * `VARIANT=python` or `VARIANT=python3` must be added
-* typically each variant package is named `Package/python3-<something>` & `Package/python3-<something>` ; this convention makes things easier to follow, though it could work without naming things this this
+* typically each variant package is named `Package/python-<something>` & `Package/python3-<something>` ; this convention makes things easier to follow, though it could work without naming things this way
 * `TITLE` can be something a bit more verbose/neat ; typically the name is short as seen above
 
 <a name="note-encodings">**note-encodings**</a>: That's because some character encodings are needed, which are present in `python3-base` but not in `python-light` (but are present in `python-codecs`) ; this is because Python3 is designed to be more Unicode friendly than Python2 (it's one of the fundamental differences between the 2), and Python3 won't start without those encodings being present.
@@ -272,12 +272,12 @@ These packages will contain byte-codes and binaries (shared libs & other stuff).
 If a user wishes to ship source code, adding 2 more lines creates 2 more packages that ship Python source code:
 ```
 $(eval $(call PyPackage,python-lxml))
-$(eval $(call PyPackage,python-lxml-src))
 $(eval $(call BuildPackage,python-lxml))
+$(eval $(call BuildPackage,python-lxml-src))
 
 $(eval $(call Py3Package,python3-lxml))
-$(eval $(call Py3Package,python3-lxml-src))
 $(eval $(call BuildPackage,python3-lxml))
+$(eval $(call BuildPackage,python3-lxml-src))
 ```
 
 The name `*-src` must be the Python package name; so for `python-lxml-src` a equivalent `python-lxml` name must exist.