Evolinx/appstream-generator
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document WorkspaceDir config file option

Browse Source
This commit is contained in:
Matthias Klumpp 2018-04-06 07:06:22 +02:00
parent b0abd724bf
commit 029fda71ba
2 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/appstream-generator.1.xml
View File

@ -172,6 +172,10 @@
Explicitly set a generator configuration JSON file. If this flag is omitted, the <filename>asgen-config.json</filename> file
in the current workspace directory is used.
</para>
<para>
If no workspace directory is defined in the configuration file itself, the directory it is located in is used
as workspace. This can be overridden by defining a workspace explicitly with <option>-w</option>.
</para>
</listitem>
</varlistentry>

1
docs/asgen-config.md
View File

@ -57,6 +57,7 @@ Features | Disable or enable selected generator features. For a detailed descrip
CAInfo | Set the CA certificate bundle file to use for SSL peer verification. If this is not set, the generator will use the system default.
AllowedCustomKeys | Set which keys of the <custom/> tag are allowed to be propagated to the collection metadata output. This key takes a list of custom-key strings as value.
ExportDirs | Set where to export data. The dictionary requires full paths set for the "Media", "Data", "Hints" or "Html" key. In case a value is missing, the default locations are used.
WorkspaceDir | Explicitly set the location of a workspace. Only makes sense if the generator is mean to be used with a lot of configuration files and the configuration is passed to it via the `-c` flag.
Icons | Customize the icon policy. See below for more details.