[sword-devel] I implore you...

Mon Jun 10 12:34:28 MST 2013

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Attached is a patch for this. Please apply.

SHA1SUM: 9a99e34ce419ea3288a32148d431ec971fb0e675

Blessings,
Jaak

On 10.06.2013 19:38, Jaak Ristioja wrote:
> I'm working on the patch but here's a short overview of the
> problem, in case discussion is required. The problem is that source
> code using Sword can't do stuff like:
> 
> #include <sword/versekey.h>
> 
> This is VERY BAD, because we must do
> 
> #include <versekey.h>
> 
> and provide -I/path/to/sword/includes/ to the compiler every time.
> The problem with this approach is that versekey.h might also exist
> in /usr/include or in other -I/include/paths. Additionally, this
> makes the #include list rather incomprehensible, especially when we
> want to sort it alphabetically. There's no telling what
> <versekey.h> refers to - is it part of Sword, part of something
> else, or a typo (e.g. maybe this needs to be "versekey.h").
> 
> Why #includes like <sword/versekey.h> don't work is that the Sword 
> headers themselves use includes like <versekey.h> instead of 
> "versekey.h" which is correct. If I don't include
> -I/usr/include/sword in my compiler arguments, but #include
> <sword/versekey.h>, the versekey.h file tries to #include <swkey.h>
> which fails because it can't find the file in in the include path.
> 
> The *.cpp files in Sword also need to use "" instead of <> to 
> distinguish between header system and local header files.
> 
> Afaik this is just best practice. Existing code using #include 
> <versekey.h> etc will continue to work as long as the 
> -I/path/to/sword/includes exists.
> 
> 
> Blessings, Jaak
> 
> On 10.06.2013 19:21, Jaak Ristioja wrote:
>> Actually I just remembered another serious flaw which causes a 
>> headache for developers using Sword. I'll write a patch ASAP.
> 
>> Blessings, Jaak
> 
>> On 10.06.2013 09:43, Troy A. Griffitts wrote:
>>> Jaak,
>>> 
>>> I accepted and applied your header file patch nearly 5 months 
>>> ago.  Are you telling me that you still have 549 warnings from 
>>> SWORD headers?
>>> 
>>> Troy
>>> 
>>> 
>>> 
>>> On 06/09/2013 11:55 PM, Jaak Ristioja wrote: On 09.06.2013
>>> 23:21, Troy A. Griffitts wrote:
>>>>>> I don't think other developers are getting ignored.
>>>>>> Please be specific.  Just because I don't accept a patch
>>>>>> doesn't mean a developer is getting ignored.
>>>>>> 
>>>>>> In fact, many times trying to make this release, when 
>>>>>> people complain that we need something fixed for this 
>>>>>> release, I ask for a simple testsuite addition to show
>>>>>> the problem and desired result, and don't get a
>>>>>> response.
>>>>>> 
>>>>>> I don't believe the problem is as you think it is Jaak. 
>>>>>> Many people whine about this or that. Not all whine for 
>>>>>> things to go in the same direction.
>>>>>> 
>>>>>> Everyone whines for a release but not everyone is
>>>>>> willing to help submit tests and then fixes for those
>>>>>> tests.
>>>>>> 
>>>>>> You stated that you would get involved to help, but you 
>>>>>> only submit things for which I previously told you I
>>>>>> wasn't interested in accepting (worrying about pedantic
>>>>>> warnings whose changes often make the code less readable
>>>>>> and do nothing to improve any of the real problems for
>>>>>> the end user.  Though I do appreciate a few of the
>>>>>> warning fixes you submitted, a few being actual bug fixed
>>>>>> too (thank you)-- I'm just ranting right now.)
>>> As a BibleTime developer, I want to available tools (-Wall, 
>>> -Wextra, cppcheck, etc) to fix any errors in my code. Due to
>>> the Sword header files which generate a lot of warnings this
>>> task is VERY inconvenient. For example, when I compile the
>>> whole of BibleTime with GCC, I get 549 warnings from Sword
>>> headers (mostly for unused arguments) - how am I supposed to
>>> find the warnings relevant for BibleTime? This alone often
>>> makes it a pain to develop BibleTime and gives me enough reason
>>> to want to fork Sword.
>>> 
>>> Turning on and fixing pedantic warnings will help find real 
>>> bugs. FACT! Forcing developers to work blindfolded will not
>>> help anyone.
>>> 
>>> The same tools can be used to find bugs in Sword code, and 
>>> SHOULD regularly be used for this purpose to ensure code
>>> quality. As is obvious these are currently NOT BEING USED by
>>> Sword developers. However, when things eventually break, users
>>> complain to the BibleTime project. Hence, it is also in the
>>> interests of front-ends to ensure that the code of Sword is of
>>> good quality. Again - if Sword won't work to ensure this and
>>> wont let us in to fix things, we have another reason to fork.
>>> 
>>> This again leads us to the issue of attracting new developers
>>> to Sword. I don't want to write on this more than necessary to 
>>> provide a small argument for my conclusion. Afaik the current 
>>> situation isn't working well. Biggest obstacles for me
>>> personally include working blindfolded, submitting patches by
>>> e-mail and not getting enough feedback for (ignored) patches
>>> and other emails.
>>> 
>>> To conclude - maybe its just me, but altogether I really feel
>>> it were easier to maintain a parallel fork (at minimal to
>>> provide set of patches) than to waste my time writing long
>>> letters trying to make this relationship work in its current
>>> form. I accept whatever path the Sword project takes, but if
>>> it's not enough for the needs of BibleTime and our devs, we
>>> will make our own choices as well.
>>> 
>>> 
>>> Blessings, Jaak The BibleTime team
>>> 
>>> 
>>> PS: I apologize if this late-night response is
>>> incomprehensible.
>>>> 
>>>> _______________________________________________ sword-devel 
>>>> mailing list: sword-devel at crosswire.org 
>>>> http://www.crosswire.org/mailman/listinfo/sword-devel 
>>>> Instructions to unsubscribe/change your settings at above
>>>> page
>>> 
>>> 
>>> _______________________________________________ sword-devel 
>>> mailing list: sword-devel at crosswire.org 
>>> http://www.crosswire.org/mailman/listinfo/sword-devel 
>>> Instructions to unsubscribe/change your settings at above page
> 
> 
> 
> 
>> _______________________________________________ sword-devel
>> mailing list: sword-devel at crosswire.org 
>> http://www.crosswire.org/mailman/listinfo/sword-devel
>> Instructions to unsubscribe/change your settings at above page
> 
> 
> 
> _______________________________________________ sword-devel mailing
> list: sword-devel at crosswire.org 
> http://www.crosswire.org/mailman/listinfo/sword-devel Instructions
> to unsubscribe/change your settings at above page
> 

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.19 (GNU/Linux)

iQgcBAEBAgAGBQJRtio8AAoJEEqsYmEt1rCO1NBAAJgFoc5YxJPhCMmE+LK3C1g3
gWoZbKqj0+KyGj1NlkbCPvesc4UjYclX1V1nnkkdhz44M+A0RiUYdykGcqnL/HDV
GVS36FIkyWL7/hBPXcPMzydUB0dkjZtWZD2OaGp4ODwgsDmXBu8noP0CcWbgcGkQ
qu6Osmd8rwUPKVgztIlYnYVIYE9ri/Dj8p/l+2LYL6rQKFNd0bjwlJ2fK9C5OzHo
uebwu4jt9xQQYvDpr6+qiplI12vQy1g/Jd3buQhA9v/Y2BsxRQkI/hED2+TDvAEp
aVG6oZdEGXkXzmcoPEm2hDLpx4JkcWmbxcQ+TjPgSk4oVfZe/Wxgkk/oPKI5cUrj
E+W7VXa9m32dgEodobcptrESQntB7RFywRwqKCLclZv5PIqRruTGVnQ2GxCemDmc
FB1QVXucYze1jmL7KLGxN1mkRaA27AWv0v7Ainej34Z2ax44HaOuIDotqxPE0+C8
x7qqKuTRiN4c1S3jER97uopP29nS53bNyeLPb3bNnnh8AF1KuusBkYPmtW244Ouj
5wOnbou5btWNMq8eEwWlq/YEE5UThKieN56pTU1KeWF0uIe4f1ME1KHQT2ED8bI+
p46/kEGtcHNdQrZG+VMGgglDq8MFlBu8VBgoQo3lpJwrtyYbOBZPXpXFigaArJZb
h90Y/wYQfHmODb8uA/RJ+DBGaYAdaAP4CEx3o32NbgGvHmhvfpVqi39ilidDr7sp
ZrBqjm2RxX0xDo7yVyR9kqAeBI96e/WfQB2wImiY09G48s6RC+XE5w3MjIZPTXvq
0Lgx6sFkKSKAti59vbKRv+1nG8wc1Neur1IiOhdUy+GCksfPHMfcxoF4GE7gwLm6
X0chZTjMY7tbcnwx9fvdeYkSr62WwW3pY2mB2R5pHaLucsL2p+7wrzjL/HLOG6BG
NCVm3e2RVJuRf7pcTmNo78u6hU2gz0077TgnTfjYf8kGKWJkNB0H1zYnBV2O9uon
dt+3yPbkXvxS0bxyTUm1RCw8Ca68RGz4JkYqdYUjoqhUL94t5HBxV78YHc3cfI3D
z9is4Pgj3qMVwH/qhNVXCq2zWiPojIZDOdv7ZgYb4Vnh3+YOwbyhHOrJHCavUted
tRrwRPVNzVbTQLzkBWI9Xrq77llxGRzo3n4MzT/kV5kZ4+mOEtz6ibDQDnpgtGXm
hwIPCGfBMMFUK88X/k+k2LWE5e65zrL0i2fh8KN8aUemPKr+yD1O4YtH+xKxEu4j
xkjT5GtKzdRzhW27RspgVHmcmoFahT1fGhUksNWLma+286KkcI4awbYz9/Qtp4WC
6jb2dd6byMO+qurUI0xN2h84HDESuQ9pTeasGIQDAj9g79MID1yw4bp6xg10cozP
NpFikjdMKT85BM4kqTrl9Y1Z+eCALDHQT+3aqrMdWfcOsVOI4ioAguiSg6VhiFLC
LtUqiFfsn/Gd/6xD6kc8EQAErZ/1B659tRurACxsnfyIKKrme6SDzMKyr/mg+8bj
nu+xchZTX+L0hJsOBHDMTgAWWPM/srlv8Cv5yFBeSORl/8fVp21hcdAQdPWlIFtl
PbG/hlJH0y1lKCk585wkxesJwxNAaand6UFQNKGmxlwyHoxe5PH28x1jLWBrWFRk
H6ef26FAAkzJuoakKBWaasIUDWRYKp63YnnTU9a8HuoKufWpZ4mW+H6IaO5u8DmP
9OdSPXAQMqa9hNGwmUMorbh7mbD96dwH73MyctwIbyhqk38p4gPT+5tXKGhnkDHb
rJsDhiPofWBLKx8XejkOiiPokphTytbVVjj2aJiopy78LBWrHFkMVVpI1s9A60Ub
ExtEtb2EKoTmjn+VihHrLGI/6tlKC9aLPDhH6rvegRYOz9tWeCpkzzDZRaTLJLLG
GVYfG5PU3AZeMAwXK/6Der6ElOjnhc2Nnh1d8eMZCUULvHA/f8sYwYm/nQSmSloK
YndbSJZdQK01UXhZ6SSOfHp0pRJFHEFphWAesJmeotYronUgNaqNG8Vp3+pa1re1
3Ri4kXLu1C7umDgS02YG/RFzlbJfMTndFLE8iqTWXT0/x2fT5mRdJ4jpEnc7Fz1j
anJ9Sbn3Vf+bKb+oY4xVbrSfLXVvUqj9cwWyOP8cITTEtTtbEVmrNfkNK4CzaUMm
4xE8CGvtdgpY87cRYV8yKLzboM+B4PHPpA72yx7Fb+8CHtYpBRIn2ZC6jAyubDoe
6QKUy4HHByFV3ywW0gV9p+7/+qm+dbrBKcn/gaC6+xu1r+taTmUXyf5hpR7CTT+j
EOTrjGoZLsHl67xkwlhBHPrGQXhTo77lpNulDYpjWeNXXSnmqQEgqIfCXLZqRYWt
NqnIWDOubZBGdVuXL5DHkH3I+Bs/EUH6zzMKXLcozcThkjGtFvswsJgwdlIirTwc
4ShPgtBTpKJ2iJ5qF+Ar8K855XB7Pijm75hHy8Ll7K0XVq2w/55CfrAlTjdZzMc4
lLRGEfEmPyoSy39MZT8zkThM/eLcf9TlerJKvA3EEe2Ai0RRgMZJ/cqPwpf7BDAJ
2z7k7MsauhGoAIlbbgdL+lf4c9af/VVU9PP8c/UrBvB/SZNFBz9MlM4gYIKe7xAd
DIhDq/IKvWseS0KO0+zPPJ4eztEfzO1x+KBRIUhrcaakw7Lz1OsUP/YL0MZyejlg
emSSQyISONzfYXCW9gj2NaIn5/6dlVAtjkKJq39Kj/ebfc3prkdjPw3o920RMdt8
/EmELq5rz4uXLO8zmWWH
=sBBq
-----END PGP SIGNATURE-----
-------------- next part --------------
A non-text attachment was scrubbed...
Name: sword-includes.patch.bz2
Type: application/x-bzip
Size: 14780 bytes
Desc: not available
URL: <http://www.crosswire.org/pipermail/sword-devel/attachments/20130610/8fcaaae9/attachment-0001.bin>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: sword-includes.patch.bz2.sig
Type: application/pgp-signature
Size: 2079 bytes
Desc: not available
URL: <http://www.crosswire.org/pipermail/sword-devel/attachments/20130610/8fcaaae9/attachment-0001.sig>