Bug 455112

Summary:	Improve documentation for compiling on Ubuntu
Product:	[Applications] okular	Reporter:	Albert Zeyer <albzey>
Component:	general	Assignee:	Okular developers <okular-devel>
Status:	RESOLVED NOT A BUG
Severity:	normal	CC:	aacid
Priority:	NOR
Version:	unspecified
Target Milestone:	---
Platform:	Other
OS:	Linux
Latest Commit:		Version Fixed In:
Sentry Crash Report:

Description Albert Zeyer 2022-06-10 09:02:32 UTC

I'm not really sure where to report this. This is a request to improve the documentation, to make it simpler for Ubuntu users to compile it from source and to set up a development environment to work on Okular.

Here is a list of packages I needed to install to be able to compile (but I already had build-essential and many others, so this is maybe incomplete):

cmake build-essential libqt5svg5-dev libkf5activities-dev libphonon4qt5-dev
libtiff-dev libkf5purpose-dev libqt5texttospeech5-dev libpoppler-dev libpoppler-cpp-dev libpoppler-qt5-dev
libfreetype-dev libspectre-dev
libkf5kexiv2-dev
libzip-dev libdjvulibre-dev libqmobipocket-dev
libmarkdown2-dev
libepub-dev libchm-dev

However, now I'm still stuck at this (although I have installed them, see above):

-- Checking for module 'libspectre'
--   No package 'libspectre' found
-- Could NOT find LibSpectre (missing: LIBSPECTRE_LIBRARY LIBSPECTRE_INTERNAL_FOUND) (Required is at least version "0.2")
-- Found CHM: /usr/include/  
-- Checking for module 'libmarkdown'
--   No package 'libmarkdown' found
-- Could NOT find Discount (missing: Discount_LIBRARIES) 
-- Checking for module 'libmarkdown'
--   No package 'libmarkdown' found
-- Could NOT find Discount (missing: Discount_LIBRARIES) 

-- The following REQUIRED packages have not been found:

 * LibSpectre (required version >= 0.2), A PostScript rendering library, <https://libspectre.freedesktop.org>
   Support for PS files in okular. You can make the dependency optional adding LibSpectre to the FORCE_NOT_REQUIRED_DEPENDENCIES cmake option
 * Discount, A library that gives you formatting functions suitable for marking down entire documents or lines of text, <https://www.pell.portland.or.us/~orc/Code/discount/>
   Support for Markdown documents in Okular. You can make the dependency optional adding Discount to the FORCE_NOT_REQUIRED_DEPENDENCIES cmake option

Comment 1 Albert Astals Cid 2022-06-10 09:24:52 UTC

What do you mean you are stuck?

Doesn't reading the error tell you exactly what to do?

Comment 2 Albert Zeyer 2022-06-10 09:33:20 UTC

(In reply to Albert Astals Cid from comment #1)
> What do you mean you are stuck?
> 
> Doesn't reading the error tell you exactly what to do?

It tells me to install it, which I did. So what should I do now?

But also, this is a report to improve the documentation specifically about installing on Ubuntu. Or is your statement that you don't want to have such information in your documentation?

Comment 3 Albert Astals Cid 2022-06-10 10:25:32 UTC

Yes, i do not want to have any distro specific installation instructions, they just break over time.

> It tells me to install it, which I did. So what should I do now?

So you have installed spectre and discount development packages, then run cmake again?

Comment 4 Albert Zeyer 2022-06-10 10:36:33 UTC

(In reply to Albert Astals Cid from comment #3)
> Yes, i do not want to have any distro specific installation instructions,
> they just break over time.
> 
> > It tells me to install it, which I did. So what should I do now?
> 
> So you have installed spectre and discount development packages, then run
> cmake again?

Exactly.

Btw, why do you mark it as resolved? I did not see that you improved the documentation?

Comment 5 Albert Zeyer 2022-06-10 10:55:56 UTC

> Btw, why do you mark it as resolved? I did not see that you improved the
> documentation?

Whoops, sorry, I did not see your comment above.

Maybe allow some user Wiki page to put such information? I think this would be valuable to some people, so it feels bad to know that I cannot pass on this information to others.

Comment 6 Albert Zeyer 2022-06-10 10:58:42 UTC

Note: Now I added them to FORCE_NOT_REQUIRED_DEPENDENCIES. I did not expect that this would work (why is it required if I can mark it as not required?) but at least the compilation succeeded successfully now.

However, now I'm not exactly sure how to run it. See: https://bugs.kde.org/show_bug.cgi?id=455118