1.92 source download doesn't include submodule files

[Lone_Wolf]

I've started updating the archlinux AUR oolite stable package and noticed https://github.com/OoliteProject/oolite ... .92.tar.gz doesn't include files from submodules .

This causes build failure for the (linux) release target

Code: Select all

src/Core/Debug/OOJSConsole.h:33:10: fatal error: jsapi.h: No such file or directory
   33 | #include <jsapi.h>

The 1.90 source download did include the files from submodules.
Also there don't appear to be instructions for building the stable version from source in the README .

It's not hard to workaround this for me, but other downstream packagers may feel differently about this.

[mcarans]

I've started updating the archlinux AUR oolite stable package and noticed https://github.com/OoliteProject/oolite ... .92.tar.gz doesn't include files from submodules .

This causes build failure for the (linux) release target

Code: Select all

src/Core/Debug/OOJSConsole.h:33:10: fatal error: jsapi.h: No such file or directory
   33 | #include <jsapi.h>

The 1.90 source download did include the files from submodules.
Also there don't appear to be instructions for building the stable version from source in the README .

It's not hard to workaround this for me, but other downstream packagers may feel differently about this.

I guess the default source tar.gz created by GitHub only covers the Oolite repository. I hope we can move away from submodules in future since we no longer need to have large binaries stored in them with the modern builds. This would greatly simplify things. As it is, I guess the source tar.gz with submodules would need to be made manually.

[another_commander]

I didn't think that a separate source code upload would be necessary because mcarans' new instructions on building in README.md on github seemed to be pretty clear. We can add a full source code package to the release files if necessary, but is there a specific issue that distro maintainers are expected to encounter if they simply follow the build instructions in that file?

[Lone_Wolf]

Maintainers tend to prefer tarballs/*.zip archive , but it's may not be possible to combine that with git submodules .
(atleast i haven't been able to figure out how to do that).

The command listed

Code: Select all

git clone --filter=blob:none --recurse-submodules https://github.com/OoliteProject/oolite.git

will download the latest trunk + submodules.

maintainers could switch to tag 1.92 or branch 1.92-maintenance after download, but that requires in-depth knowledge of git commands like git reset --hard .

Using

Code: Select all

git clone --branch 1.92 --filter=blob:none --recurse-submodules https://github.com/OoliteProject/oolite.git

is simpler and works well .

Oolite devs should determine which is preferred (1.92 or 1.92-maintenance, currently there's no difference between them afaik ) and list the command needed for that.

Adding a note the source code archive is not suited for building would also be good.