search

reticulatedpines / magiclantern_simplified

A Git based version of Magic Lantern, for those unwilling or unable to work using Mercurial. The vast majority of branches have been removed, with those thought to be important brought in individually and merged.
GNU General Public License v2.0
142 stars 50 forks source link

Pull request - add comment to modules build #87

Closed Xhyub closed 1 year ago

Xhyub commented 1 year ago

Pull request to add comment in the modules relevant Makefile. It is an issue when copy_modules_with_satisfied_deps.py expects a complete list in "ML_MODULES" and user has not set their module names accordingly.

reticulatedpines commented 1 year ago

Hi - I don't understand the comment in the commit. Are you saying that you tried to make a new module, and didn't add it to ML_MODULES via modules/Makefile.platform.default?

In that case, yes, the module will not be built. But will a comment in a Makefile help people understand the problem? I wouldn't expect it to, they won't see it.

Xhyub commented 1 year ago

That was my suggestion, there is no documented rules for building modules in the repository. Where should we direct users to if they wanted to build their own modules and don't know how?

reticulatedpines commented 1 year ago

We could definitely do with better documentation. This is always tricky. You need someone with good understanding of the whole project to write good docs.

For this PR, I think an experienced C dev wouldn't need the comment, and an inexperienced one wouldn't find it (and would probably have a lot of other problems anyway as they learn the source).