source: devtools/metadata-generator/readme.md

Last change on this file was 7045, checked in by Juanma, 2 years ago

Update utils

File size: 1.5 KB
Line 
1# Metadata-Generator
2This script scans a repo and generates the appstream catalogue.
3
4## Usage
5
6
7Due to the unstable api of appstream this script works against a chrooted environment that must have the apps and versions showed above:
8
9- appstreeam=0.10.6-1~ubuntu16.04.2+lliurex1
10
11- appstram-generator=0.6.6 compiled from lliurex's svn (xenial/devtools/appstream-generator)
12
13If we've a chroot with the right versions and a repo accesible on the machine it's as simple as:
14
15./metadata-generator.sh -suite suite --chroot /path/to/chroot --repo /path/to/repo
16
17suite -> Suite to process (xenial, bionic...)
18chroot -> path to the chroot
19repo -> path to the repo
20 
21If we don't define any argument the shell will work with the default values defined in the shell's own code.
22
23When executed the shell will:
24
251. Check if the asgen-config.json exists at the repo's basedir
26
272. Copy the mtab of the host machine to the chroot
28
293. Mount proc, sys, dev and dev/pts on the chroot
30
314. Mount (bind) the repo on the chroot
32
335. Enter the chroot
34        * Clean the appstream database
35        * Remove all processed packages
36        * Process the whole suite
37
386. Exit the chroot and unmount all the mounts of the chroot
39
40
41When finished there'll be an "export" folder at the repo's basedir wich will contain:
42
43* a data folder with the generated metadata
44
45* a media folder with the generated media (icons)
46
47* a hints folder with the detected errors and warnings in json format
48
49* a html folder. At this folder there's an "index.html" with the result of the process.
50
Note: See TracBrowser for help on using the repository browser.