Page MenuHome

make deps documentation
Closed, ResolvedPublicTO DO


We need to document (online or in the repo/cmake/...) the dependencies of make deps.

For instance, at the moment in Ubuntu if you try to build without tclsh it fails due to sqlite3. But you only get the proper warning in the first time you run it.

This is regardless of whether we should integrate and make deps in the future.

Event Timeline

Dalai Felinto (dfelinto) lowered the priority of this task from 90 to Normal.Aug 29 2019, 3:28 PM
Dalai Felinto (dfelinto) created this task.

There are a bunch of build time deps that 'make deps' has, like tclsh , nasm,yasm etc, if they are missing when the build starts, it's very hard for the average user to get 'unstuck' after it breaks and dies, and they install the missing deps since you have to remove the build folder for sqllite for instance for it to look for tclsh again.

Also since we do multi threaded builds, the actual error is generally long scrolled out of the screen when cmake decides to call it quits confusing even more users.

It's probably best if we implement a pre-flight check in cmake that checks for the required dependencies and errors out preemptively

Indeed in the CMake files it says: "# Install compiler cmake autoconf automake libtool yasm nasm tcl"
So technically yes the issue here is not documentation per-se.

Maybe a simple solution would be to suggest "users" to look at the CMakeLists.txt file for instructions if CMake exists with error.