diff --git a/docs/fdroid.html b/docs/fdroid.html index bc672005..b65217df 100644 --- a/docs/fdroid.html +++ b/docs/fdroid.html @@ -43,6 +43,9 @@ Copyright (C) 2011 Henrik Tunedal, Michael Haas, John Sullivan
When run without any parameters, build.py will build any and all versions of
+applications that you don't already have in the repo directory (or more
+accurately, the unsigned directory. There are various other things you
+can do. As with all the tools, the --help option is your friend, but a
+few annotated examples and discussion of the more common usage modes follows:
+
To build a single version of a single application, you could run the following: -
./build.py -p org.fdroid.fdroid -c 16 +./build.py --package=org.fdroid.fdroid --vercode 16This attempts to build version code 16 (which is version 0.25) of the F-Droid -client. If the build was succesful, two files will have been placed in the +client. Many of the tools recognise this
--packageparameter, allowing +their activity to be limited to just a single package. + +If the build above was succesful, two files will have been placed in the
unsigneddirectory:org.fdroid.fdroid_16.apk @@ -312,6 +326,16 @@ directory you would push to your web server). A signed and zip-aligned version of the APK would also appear there, and both files would be removed from theunsigneddirectory. +If you're building purely for the purposes of testing, and not intending to +push the results to a repository, at least yet, the
--testoption can be +used to direct output to thetmpdirectory instead ofunsigned. +A similar effect could by achieved by simply deleting the output files from +unsignedafter the build, but with the risk of forgetting to do so! + +Along similar lines (and only in conjunction with
--test, you can use +--forceto force a build of a Disabled application for test purposes, +where normally it would be completely ignored. +
@@ -325,12 +349,28 @@ Up: TopInformation used by update.py to compile the public index comes from two -sources, 1) the APK files in the repo directory, and 2) the metadata files -in the metadata directory. +sources: + +
+
- the APK files in the repo directory, and +
- the metadata files in the metadata directory. +
The metadata files are simple, easy to edit text files, always named as the -application's package ID with '.txt' appended. The following sections describe -the fields recognised within the file. +application's package ID with '.txt' appended. + +
Note that although the metadata files are designed to be easily read and +writable by humans, they are also processed and written by various scripts. +They are capable of rewriting the entire file when necessary. Even so, +the structure and comments will be preserved correctly, although the order +of fields will be standardised. (In the event that the original file was +in a different order, comments are considered as being attached to the field +following them). In fact, you can standardise all the metadata in a single +command, without changing the functional content, by running: + +
./rewritemetadata.py ++The following sections describe the fields recognised within the file.