Zeal: Update macOS build instructions

[dakira]

Hey,

I tried the build instructions in the wiki but it seems Zeal moved to using cmake instead of qmake/make since those instructions were written.

Do you have any updated hints on building Zeal on a Mac?

[trollixx]

I don't use macOS, so somebody else needs to update the wiki. Generally the process should be pretty similar to building on Linux.

[dakira]

@trollixx thanks, I'll try to figure it out. Which version of Qt5 would you recommend?

[trollixx]

Always aim for the latest version, current you need at least 5.6.

[dakira]

Looks like the problem is the dependency on qtwebkit instead of qtwebengine because the former is not shipped anymore with all Qt versions since 5.6. So it's not that easy to get the dependencies together.

[markwu]

I have a homebrew formula if you want to try it.

https://github.com/markwu/homebrew-personal/blob/master/Formula/zeal.rb

Please keep cmake in version 3.12.x and qt in version 5.5 (Already removed from homebrew-core), it will build zeal successfully.

But, It will failed to build zeal in newest cmake version 3.13.x and qt 5.11.1.

[markwu]

it is error messages came from cmake 3.13.0 and qt 5.11.1.

Last 15 lines from /Users/markwu/Library/Logs/Homebrew/zeal/01.cmake:
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Detecting C compile features
-- Detecting C compile features - done
-- Check for working CXX compiler: /usr/local/Homebrew/Library/Homebrew/shims/mac/super/clang++
-- Check for working CXX compiler: /usr/local/Homebrew/Library/Homebrew/shims/mac/super/clang++ -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Found LibArchive: /usr/local/opt/libarchive/lib/libarchive.dylib (found version "3.3.3")
-- Found SQLite: /usr/lib/libsqlite3.dylib (found version "3.24.0")
-- Configuring done
CMake Error: AutoUic (Registry): The uic executable "" does not exist

[trollixx]

Seems like you don't have uic installed. It should be part of the Qt installation.

[markwu]

The uic executable is there, I fixed that problem after downgrade cmake to 3.12.x. I guess it is the bug of cmake 3.13.0.

But new error messages comes, I still trying to figure it out:

==> Downloading https://github.com/zealdocs/zeal/archive/v0.6.1.tar.gz
Already downloaded: /Users/markwu/Library/Caches/Homebrew/downloads/317934405fce17c9a1ce09ff56d59254224b67e098b2d531d0fe801f88d34796--zeal-0.6.1.tar.gz
==> Patching
patching file src/libs/core/CMakeLists.txt
==> cmake ..
Last 15 lines from /Users/markwu/Library/Logs/Homebrew/zeal/01.cmake:
  any of the following names:

    Qt5WebKitConfig.cmake
    qt5webkit-config.cmake

  Add the installation prefix of "Qt5WebKit" to CMAKE_PREFIX_PATH or set
  "Qt5WebKit_DIR" to a directory containing one of the above files.  If
  "Qt5WebKit" provides a separate development package or SDK, be sure it has
  been installed.
Call Stack (most recent call first):
  src/libs/core/CMakeLists.txt:13 (find_package)

[trollixx]

It just tells you that Qt WebKit is missing. It's not part of the standard Qt distribution.

[markwu]

Then, I need to figure out how to add it back, I got qt 5.11.1 from homebrew bottle.

[markwu]

The last qtwebkit submodule for qt is verion5.9.1, there is no submodule for 5.11.x.

[dakira]

@markwu that's exactly the problem I had. :)

[markwu]

I try to build qt 5.9.2 inside mojave, no lucky. it seems xcode 10 break the compilation of old qt.

[markwu]

Okay, I can build zeal in MacOS mojave now, but I don't like this solution.

1. Use brew extract [email protected] YOURTAP/PATH to restore [email protected] formula to your tap. And move it to homebrew/core tap path, and rename it to [email protected].
2. Use brew extract cmake --version=3.12.4 YOURTAP/PATH to restore cmake 3.12.4 formula to your tap. And move it to homebrew/core tap path, and rename it to replace cmake.rb.
3. Install qt 5.5 with brew install [email protected] and cmake 3.12.4 with brew install cmake. It should install [email protected] and cmake from bottle. If not, just add --force-bottle.
4. Then, you can use my formula above to build zeal.

I try this one https://github.com/OSGeo/homebrew-osgeo4mac/blob/master/Formula/qt5-webkit.rb, it can install qt5webkit with qt 5.11.1, but there are A LOT OF ERRORS.

[markwu]

Maybe port to qtwebengine is the way to go, seems qtwebkit does not maintain for 1 years.

[markwu]

cmake 3.13.1 already fixed the uic excutable bug, you can use it instead of 3.12.4 now ...

[markwu]

Finally, I can build zeal with Qt 5.11.1 and QtWebKit 5.212. I will write a formula for it later today.

[markwu]

Here comes with my personal Tap https://github.com/markwu/homebrew-personal

You can follow this instructions to install zeal with qt 5.11.x and qt-webkit 5.212

brew tap markwu/personal
brew install qt
brew install qt5-webkit
brew install zeal

If you want to install zeal with [email protected], you have to extract it first. Please follow the instructions to install it:

Use brew extract [email protected] YOURTAP/PATH to restore [email protected] formula to your tap. And move it to homebrew/core tap path, and rename the file to [email protected], and remember open it and change the class name to QtAt55.

brew tap markwu/personal
brew install [email protected]
brew install [email protected]

[markwu]

But, there some different between qt 5.5 and qt 5.11.1, It looks better in qt 5.5.

qt 5.5

qt 5.11.1 (Seems some html get the wrong css style)

@trollixx Do you kown any issues about this, should I create a new one for this?

[markwu]

I try to build zeal master branch with --HEAD, it works.

You can build master branch with the following instructions

brew tap markwu/personal
brew install qt
brew install qt5-webkit
brew install --HEAD zeal

[markwu]

Qt 5.12 just relased, you have reinstall qt5-webkit again, it will compiled against Qt 5.12.x.

brew reinstall qt5-webkit

[trollixx]

Any volunteers to update the wiki? :)

[markwu]

Sorry, English is not my native language. I will leave my formula here, and if someone can update the document, I'll be appreciated.

If you want to host and maintain the brew formula, you are okay to go.

[dakira]

I'll try to replicate this in the next couple of days and update the wiki.

[pryorda]

I'm testing this now will update in a few.

[pryorda]

To finish it up I had to do:

cp -Rp /usr/local/Cellar/zeal/HEAD-a64dadc/Zeal.app ~/Applications/Zeal.app

[razzfox]

I needed to run

brew install libjpeg libpng

before qt5-webkit would install successfully.

[markwu]

@razzfox I can add these two libraries to formula dependency.

[sunjie21]

Any volunteers to update the wiki? :)

are there any plans to port from Qt WebKit to Qt WebEngine?

[markwu]

I just update my formula for recent code change. It can compile zeal stable version 0.6.1 and HEAD with Qt 5.11.2. For Qt5.5, It only support zeal stable version 0.6.1

[dakira]

I finally updated the build instructions in the wiki. :)

[frankli0324]

https://github.com/zealdocs/zeal/commit/090f5270545c24c7840fb199b994b382b5606323

On MacOS, you need to enable loopback aliases other than 127.0.0.1 manually:

sudo ifconfig lo0 alias 127.0.0.22 up

[markwu]

090f527

On MacOS, you need to enable loopback aliases other than 127.0.0.1 manually:

sudo ifconfig lo0 alias 127.0.0.22 up

What will happened if I don't enable loopback aliases?

[markwu]

Okay, now I know what's going on.

[markwu]

Maybe I should create a daemon for this https://medium.com/@david.limkys/permanently-create-an-ifconfig-loopback-alias-macos-b7c93a8b0db ?

[frankli0324]

sure yes

[markwu]

I just add a zeal-loopbackalias daemon support, maybe you want to try it.

After install zeal with head version, you can enable the daemon with

sudo brew services start markwu/personal/zeal

Than, the lookpback should be installed without problem. You can verify it with:

$ ifconfig lo0 | grep 127.0.0.22, the result will be

    inet 127.0.0.22 netmask 0xff000000

[trollixx]

I don't use macOS much, it doesn't route all 127.*.*.* addresses by default? I picked 127.0.0.22 to reduce possibility of conflicts.

[markwu]

I don't use macOS much, it doesn't route all 127.*.*.* addresses by default? I picked 127.0.0.22 to reduce possibility of conflicts.

Mac doesn't route all 127.*.*.* by default I guess, therefore I need to add alias for it.

Does linux and windows route all 127.*.*.* by default?

[frankli0324]

Does linux and windows route all 127.*.*.* by default?

yes

[trollixx]

I have just pushed a change that replaces 127.0.0.22 with 127.0.0.1. Hopefully that will make it work out of the box.

[markwu]

@trollixx

Do you use different port when change it to use 127.0.0.1?

For many developers, they installed local http server, it use 127.0.0.1 and localhost.

There might have some problems if you use the default 80 port.

[markwu]

@trollixx I saw you use port other than 80. Thanks!

I also removed the loopback alias daemon from this formula.

[trollixx]

@trollixx I saw you use port other than 80.

Yes, a random non-priviliged port is selected on every run.

[markwu]

I already update the wiki documents about building zeal on macOS. Since there is no need for qt5-webkit, I already removed it and related patches from my formula.

It is so good that zeal adapt WebEngine, the life become easier.

[sikmir]

Zeal can be installed from macports: https://github.com/macports/macports-ports/pull/7444.

[RakibFiha]

I try to build zeal master branch with --HEAD, it works.

You can build master branch with the following instructions

brew tap markwu/personal
brew install qt
brew install qt5-webkit
brew install --HEAD zeal

Is working as of 27th of August 2020

[markwu]

@RakibFiha Just following the wiki, it should be work.

https://github.com/zealdocs/zeal/wiki/Build-Instructions-for-macOS