rewritemeta only applies to the original .txt metadata format

This commit is contained in:
Hans-Christoph Steiner 2015-08-05 14:03:24 +02:00
parent 6c44bff78b
commit 19ac44c189
2 changed files with 24 additions and 10 deletions

View file

@ -450,19 +450,26 @@ always named as the application's package ID with '.txt' appended.
Additionally, you can use JSON, XML, or YAML for app metadata, using
the same fields as the original '.txt' format.
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:
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. The original '.txt' format can be automatically cleaned up
when necessary. 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 '.txt' metadata in a single command,
without changing the functional content, by running:
@example
fdroid rewritemeta
@end example
Or just run it on a specific app:
@example
fdroid rewritemeta org.adaway
@end example
The following sections describe the fields recognised within the file.
@menu