Rename sip into sip-tqt in order to be conflict free with upstream.
#2
Merged
SlavekB
merged 1 commits from feat/rename_sip
into master
3 years ago
Loading…
Reference in New Issue
There is no content yet.
Delete Branch 'feat/rename_sip'
Deleting a branch is permanent. It CANNOT be undone. Continue?
The install location for the sip modules has been moved to tdesip as the default location, former location (sip4_tqt) could still be requested through the commande options.
If you guys agree to move to that location, then the configure scripts from python-tqt and python-trinity modules should be be adjusted accordingly since those expect the sipconfig Python module in a subdirectory of the Python package-site named sip4_tqt at the moment.
see:
https://mirror.git.trinitydesktop.org/gitea/TDE/python-tqt/src/branch/master/configure.py#L31
https://mirror.git.trinitydesktop.org/gitea/TDE/python-trinity/src/branch/master/configure.py#L33
These scripts also expect sip as a tool not tdesip.
@SlavekB I've added a qmake.conf file for FreeBSD but I dunno if that one works.
It would make sense to rename the module from sip4-tqt into tdesip.
I'll see to fix the doc later...
These Python things have two parts. The first concerning TQt – sip, tqscintilla, python-tqt. The second concerning TDE – python-trinity, pytdeextensions. It seems to me as a good idea to keep in the names resolution whether a particular part is dependent on TQt or depends on TDE.
Therefore, it seem to me to be more appropriate
tqtsip
(orsip-tqt
) rather thantdesip
. What is your opinion?Yes, agree on this point. tqt for tqt dependant things, tde for tde dependant things.
sip-tqt is more similar to other packages, compared to tqt-sip or tqtsip
I agree when you say that the name of the module should reflect which part belongs to whom between the tqt library or tdelibs, but that is not the point here.
Sip is not related to either one or the other, It's the other way around. python-tqt and python-trinity relate to sip since these two need sip to work.
Anyhow the goal here is too make the sip module (from TDE) out of the way from mainstream sip by renaming the executable, the library and the installed header.
As suggested by Michele, tdesip ,as a name, has a nice ring to me. I kept tdesip for the name's location of the module in the Python package-site for consistency only, should this location be kept as sip4_tqt is not important so is not the name of the module too.
You are right Greg, sligh oversight from me here. sip is used to create the python-tqt and python-trinity bindings. How about we call it sip-trinity like many other packages?
Also I think the name python-tqt and python-trinity is a bit misleading. How about we rename those packages as well? Like for example python-bindings-tqt and python-bindings-trinity?
Yes, SIP provides work for both TQt and TDE, but it is only dependent on TQt. Therefore, there is now used "tqt" – similar to avahi-tqt, dbus-1-tqt, etc.
Au, that sounds like disgustingly long names that depart from the habits used for all others – you can see PyQt, PyKDE, PyGTK. You can notice that naming with prefix
python-
/python3-
are rules for binary DEB packages, while names of python modules are short. The names of PyTQt and the PyTDE would be significantly shorter 😉So should we settle on simply sip-tqt?
Sounds good for me.
PyTQt and PyTDE have a nice ring to me too, but as I already said It's not the point.
SlavekB Please tell me what names, you want, EG:
350def581c
to71f61cc96f
3 years agoFollowing on previous comments, sip is not related to tqt or TDE specifically, insteaad it is used by both. So I think tdesip is misleasing because it gives the idea it is related to TDE API, like PyTDE.
Instead I would settle on sip-trinity, where the -trinity suffix indicates that it is a sip version maintained by the Trinity group, like many other packages,
Same idea can be applied to the sip.h file, which could be renamed to sip-trinity.h for example.
What do you think?
yeah make sense. What would be the rest?
When we make changes (again), so we could also rename
sipconfig.py
=>sip-trinity-config.py
andsipdistutils.py
=>sip-trinity-distutils.py
that the module directory can be canceled.ok, so let's sum this up would we?
Names look good to me too.
71f61cc96f
tod8b830ce79
3 years agowe can't name a Python module with an "-" as It seems, so I went for siptrinityconfig.py and siptrinitydistutils.py instead.
so here is the installed files with this configure options:
How about using underscore? is it allowed? Like sip_trinity_config.py and similar? Would be easier to read IMO.
no-one is going to read this, their sole purpose is to provide data for building python-tqt with python. Once the cmake conversion is done, those two modules can go.
d8b830ce79
tof7ee272605
3 years agoLooks quite clean now. I will let @SlavekB make the final call, but namings looks ok to me.
Although we found a consensus in the use of the name
sip-trinity
, there is one who veto us – Mr. Python because it makes it impossible to use hyphen.Note: There are places in
sipgen/gencode.c
where the name of the module must correspond to the renamed module – see lines 2224, 2228, 2242, 2248 and 2252.@ -166,3 +166,3 @@
default_sipbindir = plat_bin_dir
default_sipmoddir = os.path.join(plat_py_site_dir, 'sip4_tqt')
default_sipmoddir = os.path.join(plat_py_site_dir, 'sip-trinity')
Here, the intention was to avoid the module directory. This is to use:
default_sipmoddir = plat_py_site_dir
, as it was in the code earlier.@ -258,3 +258,3 @@
sipconfig.inform("Creating top level Makefile...")
siptrinityconfig.inform("Creating top level Makefile...")
open('__init__.py', 'a').close()
If a separate module directory is not used, this is unnecessary – unwanted.
@ -1506,3 +1506,3 @@
ext = self.optional_string("EXTENSION_SHLIB", "so")
mfile.write("TARGET = %s\n" % (self._target + "." + ext))
mfile.write("TARGET = %s\n" % (self._target + "-trinity." + ext))
This is not a good solution for many reasons:
qt-trinity
, which is wrong because the module name should betqt
. For the PyTDE, it generates module names astdecore-trinity
, which is not the desired result.t
instead of suffix, it would be generated modules calledtqt.so
, which looks good, but alsottdecore
, which is not what we want.so are we going to use underscore (_) instead of hyphen? as in sip_trinity?
This work won't go anywhere, PR is closed.
f7ee272605
to0e87496718
3 years agoI made a move forward and together with this few decisions:
Because the main essence of our modification in SIP is building together with TQt, it makes sense to use the name sip-tqt, as intended originally. This is consistent for all similar cases - avahi-tqt, dbus-1-tqt, polkit-tqt.
We must accept that Python makes it impossible to use a hyphen in the names of the modules, and therefore the underscore will be used for the necessary cases. For example,
sip_tqt.so
for the name of the Python module.The intention was not to install the module to the subdirectory, but really rename the appropriate Python module – patch now performs it.
sipconfig.py
andsipdistutil.py
are renamed tosip_tqt_config.py
andsip_tqt_distutil.py
to correspond to the name of the module => python-tqt and python-trinity will require edit. It is now sufficient for testing purposes to replacefrom sip_tqt import sipconfig
toimport sip_tqt_config as sipconfig
.Unintentionally renamed PyQt4 reverted back. In some next round, all Qt4 parts could be removed.
WIP:Rename sip into tdesip in order to be conflict free with upstream.to Rename sip into sip-tqt in order to be conflict free with upstream. 3 years agoLooks good. The name of packages and modules are also good.
We should also consider renaming the repository sip-tqt instead of sip4-tqt.
All mentioned problems are resolved in the last version of patch.
Yes, renaming the git repository seems like a logical step.
Another question is whether to backport this PR to stable branch r14.0.x? Although it seems a fundamental change, SIP-TQt is an API whose use is hidden inside in PyTQt and PyTDE, so the change should not affect users. What is your opinion?
0e87496718
to976b20e043
3 years agoI think we can keep it in master only. It does not really add new functionality and we could always introduce an unwanted mistake by backporting such big change. Considering we want to release R14.1.0 this year, I think we can avoid the backport.
976b20e043
into master 3 years agoReviewers
976b20e043
.