chiark / gitweb /
Add ndk r11c
[fdroidserver.git] / docs / fdroid.texi
index f158147c6a3fc06096023f28cc6e808e9ca9c507..4c7fb0fbeb8bb76018ff08bb560b24f0b6e57353 100644 (file)
@@ -401,19 +401,32 @@ the signed output directory were modified, you won't be notified.
 @node Importing Applications
 @chapter Importing Applications
 
-To help with starting work on including a new application, @code{fdroid import}
-will take a URL and optionally some other parameters, and attempt to construct
-as much information as possible by analysing the source code. Basic usage is:
+To help with starting work on including a new application, use
+@code{fdroid import} to set up a new template project.  It has two
+modes of operation, starting with a cloned git repo:
+
+@example
+git clone https://gitlab.com/fdroid/fdroidclient
+cd fdroidclient
+fdroid import
+@end example
+
+Or starting with a URL to a project page:
 
 @example
 fdroid import --url=http://address.of.project
 @end example
 
-For this to work, the URL must point to a project format that the script
+When a URL is specified using the @code{--url=} flag, @code{fdroid
+import} will use that URL to find out information about the project,
+and if it finds a git repo, it will also clone that.  For this to
+work, the URL must point to a project format that the script
 understands. Currently this is limited to one of the following:
 
 @enumerate
 @item
+GitLab - @code{https://gitlab.com/PROJECTNAME/REPONAME}
+@item
 Gitorious - @code{https://gitorious.org/PROJECTNAME/REPONAME}
 @item
 Github - @code{https://github.com/USER/PROJECT}
@@ -1112,9 +1125,9 @@ Version of the NDK to use in this build. Defaults to the latest NDK release
 that included legacy toolchains, so as to not break builds that require
 toolchains no longer included in current versions of the NDK.
 
-The buildserver supports r9b with its legacy toolchains and the latest release
-as of writing this document, r10e. You may add support for more versions by
-adding them to 'ndk_paths' in your config file.
+The buildserver supports r9b with its legacy toolchains, r10e, r11c and the
+latest release as of writing this document, r12b. You may add support
+for more versions by adding them to 'ndk_paths' in your config file.
 
 @item gradle=<flavour1>[,<flavour2>,...]
 Build with Gradle instead of Ant, specifying what flavours to use. Flavours
@@ -1247,7 +1260,7 @@ of versions kept in the main repo, after which older ones are moved to the
 archive. This app-specific policy setting can override that.
 
 Currently the only supported format is "n versions", where n is the number
-of versions to keep.
+of versions to keep. Defaults to "3 versions".
 
 @node Update Check Mode
 @section Update Check Mode
@@ -1264,7 +1277,7 @@ Valid modes are:
 @item
 @code{None} - No checking is done because there's no appropriate automated way
 of doing so. Updates should be checked for manually. Use this, for example,
-when deploying betas or patched versions; when builds are done in a directory
+when deploying unstable or patched versions; when builds are done in a directory
 different to where the AndroidManifest.xml is; if the developers use the
 Gradle build system and store version info in a separate file; if the
 developers make a new branch for each release and don't make tags; or if you've
@@ -1307,10 +1320,10 @@ that number.
 source repository is checked, looking for the highest version code. The
 appropriateness of this method depends on the development process used by the
 application's developers. You should not specify this method unless you're sure
-it's appropriate. It shouldn't be used if the developers like to tag betas or
-are known to forget to tag releases. Like RepoManifest, it will not return the
-correct value if the directory containing the AndroidManifest.xml has moved.
-Despite these caveats, it is the often the favourite update check mode.
+it's appropriate. It shouldn't be used if the developers like to tag unstable
+versions or are known to forget to tag releases. Like RepoManifest, it will not
+return the correct value if the directory containing the AndroidManifest.xml has
+moved. Despite these caveats, it is the often the favourite update check mode.
 
 It currently only works for git, hg, bzr and git-svn repositories. In the case
 of the latter, the repo URL must contain the path to the trunk and tags or
@@ -1419,8 +1432,8 @@ above, you would specify that as "Version +-fdroid %v" - "-fdroid" is the suffix
 @cindex Current Version
 
 The name of the version that is current. There may be newer versions of the
-application than this (e.g. betas), and there will almost certainly be older
-ones. This should be the one that is recommended for general use.
+application than this (e.g. unstable versions), and there will almost certainly
+be older ones. This should be the one that is recommended for general use.
 In the event that there is no source code for the current version, or that
 non-free libraries are being used, this would ideally be the latest
 version that is still free, though it may still be expedient to
@@ -1548,9 +1561,7 @@ applications.
 @section Setting up a build server
 
 In addition to the basic setup previously described, you will also need
-a Vagrant-compatible Debian Testing base box called 'jessie32' (or jessie64
-for a 64-bit VM, if you want it to be much slower, and require more disk
-space).
+a Vagrant-compatible Debian Testing base box called 'jessie64'.
 
 You can use a different version or distro for the base box, so long as you
 don't expect any help making it work. One thing to be aware of is that