chiark / gitweb /
Merge branch 'update-vagrantfile' into 'master'
[fdroidserver.git] / docs / fdroid.texi
index c08af01b465cea523d4e305303d854f37807a1d8..c57689c7e0903f62f485347dd34b40aa8857895f 100644 (file)
@@ -113,8 +113,7 @@ VirtualBox (debian package virtualbox)
 @item
 Ruby (debian packages ruby and rubygems)
 @item
-Vagrant (unpackaged) Be sure to use 1.3.x because 1.4.x is completely broken
-(at the time of writing, the forthcoming 1.4.3 might work)
+Vagrant (unpackaged, tested on v1.4.3)
 @item
 Paramiko (debian package python-paramiko)
 @item
@@ -486,6 +485,7 @@ The following sections describe the fields recognised within the file.
 * Update Check Mode::
 * Update Check Ignore::
 * Vercode Operation::
+* Update Check Name::
 * Update Check Data::
 * Auto Update Mode::
 * Current Version::
@@ -885,7 +885,7 @@ which architecture or platform the apk is designed to run on.
 If specified, the package version code in the AndroidManifest.xml is
 replaced with the version code for the build. See also forceversion.
 
-@item rm=relpath1,relpath2,...
+@item rm=<path1>[,<path2>,...]
 Specifies the relative paths of files or directories to delete before
 the build is done. The paths are relative to the base of the build
 directory - i.e. the root of the directory structure checked out from
@@ -895,7 +895,7 @@ AndroidManifest.xml.
 Multiple files/directories can be specified by separating them with ','.
 Directories will be recursively deleted.
 
-@item extlibs=a,b,...
+@item extlibs=<lib1>[,<lib2>,...]
 Comma-separated list of external libraries (jar files) from the
 @code{build/extlib} library, which will be placed in the @code{libs} directory
 of the project.
@@ -948,7 +948,7 @@ You can use $$SDK$$, $$NDK$$ and $$MVN3$$ to substitute the paths to the
 android SDK and NDK directories, and Maven 3 executable respectively e.g.
 for when you need to run @code{android update project} explicitly.
 
-@item scanignore=path1,path2,...
+@item scanignore=<path1>[,<path2>,...]
 Enables one or more files/paths to be excluded from the scan process.
 This should only be used where there is a very good reason, and
 probably accompanied by a comment explaining why it is necessary.
@@ -956,7 +956,7 @@ probably accompanied by a comment explaining why it is necessary.
 When scanning the source tree for problems, matching files whose relative
 paths start with any of the paths given here are ignored.
 
-@item scandelete=path1,path2,...
+@item scandelete=<path1>[,<path2>,...]
 Similar to scanignore=, but instead of ignoring files under the given paths,
 it tells f-droid to delete the matching files directly.
 
@@ -988,23 +988,25 @@ actually not required or used, remove the directory instead (using
 isn't used nor built will result in an error saying that native
 libraries were expected in the resulting package.
 
-@item gradle=<flavour>
-Build with Gradle instead of Ant, specifying what flavour to assemble.
-If <flavour> is 'yes' or 'main', no flavour will be used. Note
-that this will not work on projects with flavours, since it will build
-all flavours and there will be no 'main' build.
+@item gradle=<flavour1>[,<flavour2>,...]
+Build with Gradle instead of Ant, specifying what flavours to use. Flavours
+are case sensitive since the path to the output apk is as well.
+
+If only one flavour is given and it is 'yes' or 'main', no flavour will be
+used. Note that for projects with flavours, you must specify at least one
+valid flavour since 'yes' or 'main' will build all of them separately.
 
 @item maven=yes[@@<dir>]
 Build with Maven instead of Ant. An extra @@<dir> tells f-droid to run Maven
 inside that relative subdirectory. Sometimes it is needed to use @@.. so that
 builds happen correctly.
 
-@item preassemble=<task1> <task2>
-Space-separated list of Gradle tasks to be run before the assemble task
-in a Gradle project build.
+@item preassemble=<task1>[,<task2>,...]
+List of Gradle tasks to be run before the assemble task in a Gradle project
+build.
 
-@item antcommand=xxx
-Specify an alternate Ant command (target) instead of the default
+@item antcommands=<target1>[,<target2>,...]
+Specify an alternate set of Ant commands (target) instead of the default
 'release'. It can't be given any flags, such as the path to a build.xml.
 
 @item output=path/to/output.apk
@@ -1205,11 +1207,23 @@ upstream version.
 @node Update Check Ignore
 @section Update Check Ignore
 
+@cindex Update Check Ignore
+
 When checking for updates (via @code{Update Check Mode}) this can be used to
 specify a regex which, if matched against the version name, causes that version
 to be ignored. For example, 'beta' could be specified to ignore version names
 that include that text.
 
+@node Update Check Name
+@section Update Check Name
+
+@cindex Update Check Name
+
+When checking for updates (via @code{Update Check Mode}) this can be used to
+specify the package name to search for. Useful when apps have a static package
+name but change it programmatically in some app flavors, by e.g. appending
+".open" or ".free" at the end of the package name.
+
 @node Update Check Data
 @section Update Check Data