eec57945c0
NOTE: This commit does not touch the ant build system at all, only gradle. There are currently 23 gradle projects which require configuration, let alone building, in order to build F-Droid. This takes a non-trivial amount of time/memory/cpu. Additionally, it also provides difficulties when importing the project into Android Studio - which is the IDE that many potential contributors will be using. Finally, I have over 100mb of data in the extern/ folder, and the support libraries require almost every single Android SDK to be installed, which is several GB. This is not a friendly environment to encourage people to submit merge requests. However, I'm very mindful of the need for an open source project such as F-Droid to be able to be built from source. So to make sure we have the best of both worlds, I've ensured that building all dependencies from source is still possible. The F-Droid/libs/README.md file explains in greater detail how to do this (i.e. "gradle -PsourceDeps build"). As much as possible, I've tried to make the binary dependencies fetched from jcenter. However there are still libraries which either haven't integrated required changes for F-Droid back upstream, or don't have mavenCentral/jcenter binaries available. Android preference fragment has been changed to the original upstream repository. The one we had before was because upstream hadn't merged a MR for gradfle support yet. However, that has now been merged. This version still doesn't exist in jcenter though. In order for libsuperuser to build from upstream, using `gradle -PsourceDeps`, we need to include a few gradle plugins from jcenter which are never actually used (used by upstream to release to jcenter). Even though support-v4 is included through jcenter, it is kept in the libs directory, so that ./ant-prepare.sh can use it. Update support preference fragment to newer version. There has been bugfixes commited, so lets include them in the version we are using.
2.9 KiB
Licenses
To see which license any one of these libraries is under, consult the extern/ directory.
If you have checked out the source for all dependencies (git submodule update --init from the root directory),
then you should be able to find the relevant LICENSE file for each, or else you can consult upstream.
Building libraries from source
As a matter of principle, and also to comply with the GPLv3+, F-Droid should always be able to be built from source, including all of its dependencies.
For practical reasons, developers often don't want the overhead of having to fetch the source of each dependency though. Also, they may not want their build script to have to take the time to configure and check that each subproject is up-to-date. Building from binary dependencies is much faster, requires less downloading of external source, and should import into Android Studio and other IDE's more easily.
To deal with these two goals (building dependencies from source, and relying on prebuilt binaries), the build script can be run in two modes.
Gradle commands
gradle build will build F-Droid from source, but not the depenencies from source. It will instead depend
on binaries from jcenter where possible, and .jar and .aar files in F-Droid/libs/ elsewhere.
gradle -PsourceDeps build will include all dependencies and build the entire F-Droid binary
and all of its dependencies from source.
gradle -PsourceDeps binaryDeps will build all dependencies from source, and then copy the ones which
are not found in jcenter to F-Droid/libs/, making sure that the latest versions of the libraries are available
for developers wishing to build F-Droid from binary dependencies.
gradle -PsourceDeps cleanBinaryDeps will remove all binary dependencies. It shouldn't be neccesary,
because the binaryDeps will copy fresh .jar and .aar files to the F-Droid/libs/ directory when they change.
It may be handy if you are updating the build script though, as a nice way to empty the F-Droid/libs/ directory.
Adding new dependencies
When adding a new dependency, DON'T copy the .jar or .aar file into F-Droid/libs/. This will get deleted
when somebody runs gradle -PsourceDeps cleanBinaryDeps. Also, the version of F-Droid built for distribution
on https://f-droid.org will be build from source depednencies, so adding a binary is not enough.
Instead, you should add the source repo as a submodule in the extern/ diretory. You will also need to modify
the F-Droid/build.gradle file, adding both the source dependency on the project in the extern/ directory, and
a dependency on its jcenter/mavenCentral artifact. If that artifact is not available, then you should add
the library to those to be copied using gradler -PsourceDeps binaryDeps. Then, you can commit that binary so that
anyone who clones the F-Droid repo will have all of the dependencies ready in either jcetner or the
F-Droid/libs/ directory.