Docs and debian packaging
I have made the 0.4.1~pre20061221 debian packaging of the latest snapshot. This includes the wiki docs and the current source and debs are available at: http://wookware.org/files/therion/ However I have a problem with the packaging. Debian packages normally include the original source tarball plus a debian diff for the changes. However the changes now include all the wiki html and images. The images are not representable in a diff so it doesn't work. The above package has been done without an upstream tarball for the source. I am not sure what to do about this. I see these options: 1) uuencode all the images Pro: farily simple - packagin needs to uudecode them all before normal packaging - no other changes. Cons: Makes source 35% bigger - not totally crazy but still 1Mb extra. Makes packaging more fiddly due to need to convert to/from uuencode whenever there is a wiki export update 2) Make therion a debian native package Pro: can then just use standard mechanisms No wasted space or extra faff Con: therion isn't a debian native package, and it means I can't do a debian update without there being abump in the therion version. This has caused problems with survex so I'm not too keen. This is effectively what has been done with the debs I've currently built. 3) Include wiki export in upstream tarball Pro: Makes things trivial from my POV Con: You may not want to do this as you already have the wiki - do you want docs in source as well? Makes source much bigger: dump is ~3.5MB 4) Split therion source docs and code upstream Pro: has the same effect as 3, but code download is still small. Con: You need to do a bit of work to move thbook sources into docs tarball So, the question for therion authors/admins (who shouldn't really have to worry about debian packaging), is do you think including the wiki docs in either the main source tarball or a different docs one (and move the thbook into that too) is a good idea or not? If you do then I suggest this is the best way to go. If not I will probably go the uuencode route for now, unless/until someone has a better idea. Sorry to bother you with this - I had never realised that debian diffs cannot introduce binary files not in upstream - it's a bit cack really in a situation like this. Wookey -- Aleph One Ltd, Bottisham, CAMBRIDGE, CB5 9BA, UK Tel +44 (0) 1223 811679 work: http://www.aleph1.co.uk/ play: http://wookware.org/
On 2006-12-27 13:53 +0000, Wookey wrote:
I have made the 0.4.1~pre20061221 debian packaging of the latest snapshot. This includes the wiki docs and the current source and debs are available at: http://wookware.org/files/therion/
However I have a problem with the packaging.
hmm, and I just found another answer 'dbs' (Debian build system). That solves exactly this problem. If you prefer not to put all of wiki in therion tarball(s) then I will us that. Wookey -- Aleph One Ltd, Bottisham, CAMBRIDGE, CB5 9BA, UK Tel +44 (0) 1223 811679 work: http://www.aleph1.co.uk/ play: http://wookware.org/
On Wed, Dec 27, 2006 at 03:38:18PM +0000, Wookey wrote:
hmm, and I just found another answer 'dbs' (Debian build system). That solves exactly this problem.
If you prefer not to put all of wiki in therion tarball(s) then I will us that.
You can also just put the new images under the debian directory (probably in a subdirectory for neatness). Then either copy them into the installed tree after "make install", or list them in the ".install" file for the appropriate binary package. Cheers, Olly
On 2006-12-27 15:51 +0000, Olly Betts wrote:
On Wed, Dec 27, 2006 at 03:38:18PM +0000, Wookey wrote:
hmm, and I just found another answer 'dbs' (Debian build system). That solves exactly this problem.
If you prefer not to put all of wiki in therion tarball(s) then I will us that.
You can also just put the new images under the debian directory (probably in a subdirectory for neatness). Then either copy them into the installed tree after "make install", or list them in the ".install" file for the appropriate binary package.
I don't see how this helps (or even works). The debian dir gets created by the debian diff, and the diff can't store the images. Were you thinking there was a debian dir in the upstream tarball and 'you' here was stacho? Wookey -- Aleph One Ltd, Bottisham, CAMBRIDGE, CB5 9BA, UK Tel +44 (0) 1223 811679 work: http://www.aleph1.co.uk/ play: http://wookware.org/
On 12/27/06, Wookey <wookey@aleph1.co.uk> wrote:
I have made the 0.4.1~pre20061221 debian packaging of the latest snapshot. This includes the wiki docs and the current source and debs are available at: http://wookware.org/files/therion/
However I have a problem with the packaging.
[...]
So, the question for therion authors/admins (who shouldn't really have to worry about debian packaging), is do you think including the wiki docs in either the main source tarball or a different docs one (and move the thbook into that too) is a good idea or not?
We see only one possibility (not mentioned by you) -- to make a separate therion-wikidocs package and leave the therion package as is, including the thbook sources. The reason is that we cannot guarantee the correctness of wiki pages and there _should_ be some official documentation in the main package. The split we suggest is between author- and user-contributed files, not between source and documentation. Martin
Martin Budaj napsal(a):
On 12/27/06, Wookey <wookey@aleph1.co.uk> wrote:
I have made the 0.4.1~pre20061221 debian packaging of the latest snapshot. This includes the wiki docs and the current source and debs are available at: http://wookware.org/files/therion/
However I have a problem with the packaging.
[...]
So, the question for therion authors/admins (who shouldn't really have to worry about debian packaging), is do you think including the wiki docs in either the main source tarball or a different docs one (and move the thbook into that too) is a good idea or not?
We see only one possibility (not mentioned by you) -- to make a separate therion-wikidocs package and leave the therion package as is, including the thbook sources. The reason is that we cannot guarantee the correctness of wiki pages and there _should_ be some official documentation in the main package. The split we suggest is between author- and user-contributed files, not between source and documentation.
I completely agree with Martin - wiki should be optional package. I think it is too big (and will be even bigger) for inclusion in therion package. I will prepare some script for generating wiki tarball nightly. Ladislav
On 2007-01-04 14:16 +0100, Ladislav Blazek wrote:
Martin Budaj napsal(a):
On 12/27/06, Wookey <wookey@aleph1.co.uk> wrote:
I have made the 0.4.1~pre20061221 debian packaging of the latest snapshot. This includes the wiki docs and the current source and debs are available at: http://wookware.org/files/therion/
However I have a problem with the packaging.
[...]
So, the question for therion authors/admins (who shouldn't really have to worry about debian packaging), is do you think including the wiki docs in either the main source tarball or a different docs one (and move the thbook into that too) is a good idea or not?
We see only one possibility (not mentioned by you) -- to make a separate therion-wikidocs package and leave the therion package as is, including the thbook sources. The reason is that we cannot guarantee the correctness of wiki pages and there _should_ be some official documentation in the main package. The split we suggest is between author- and user-contributed files, not between source and documentation.
OK, thanx for getting back to me. I'm afraid I do not really agree with you: I think users would prefer to see 'tools' and 'docs' packages - they don't really care who wrote the docs, or expect some docs to be in docs package but others to be in tools package. They either already know the package and do not need docs, or they do need docs, in which case the wiki ones are definately the most useful. For new users the wiki docs are the ones they should be reading first, not the thbook. Lack of synchronisation between docs and code is an issue, but a manageable one. But even though I do not entirely agree, I can work with your split. It is is simple for me, just not ideal for users (IMHO).
I completely agree with Martin - wiki should be optional package. I think it is too big (and will be even bigger) for inclusion in therion package.
Exactly - that is why it should be in a separate docs package, and once you have one of those it seems to me that the thbook should ideally be in it too.
I will prepare some script for generating wiki tarball nightly.
OK. That would be great. Wookey -- Aleph One Ltd, Bottisham, CAMBRIDGE, CB5 9BA, UK Tel +44 (0) 1223 811679 work: http://www.aleph1.co.uk/ play: http://wookware.org/
participants (4)
-
Ladislav Blazek -
Martin Budaj -
Olly Betts -
Wookey