← Back to branch summary

~jocave/checkbox/hybrid-amd-gpu-mods

« back to all changes in this revision

Viewing changes to plainbox/docs/manpages/plainbox-file-units.rst

  • Committer: Sylvain Pineau
  • Date: 2014-07-29 16:05:54 UTC
  • mto: This revision was merged to the branch mainline in revision 3149.
  • Revision ID: sylvain.pineau@canonical.com-20140729160554-qev8887xbunn9tmi
checkbox-ng:launchers:checkbox-cli: The checkbox-cli launcher

Running the default whitelist (with the suite selection screen skipped)

Show diffs side-by-side

added added

removed removed

Lines of Context:
plainbox/docs/manpages/plainbox-file-units.rst
1
 
=======================
2
 
plainbox-file-units (7)
3
 
=======================
4
 
 
5
 
Synopsis
6
 
========
7
 
 
8
 
This page documents the Plainbox file units syntax and runtime behavior
9
 
 
10
 
Description
11
 
===========
12
 
 
13
 
The file unit is a internal implementation detail at this time.
14
 
It is technically a Unit but it currently cannot be defined in a unit definition
15
 
file as the 'unit: file' association is not exposed.
16
 
 
17
 
File units are useful as an abstraction that everything is an unit. It allows
18
 
the core to validate file properties (name, role, permissions) in context.
19
 
Currently the unit is very fresh and relatively under-used but it is expected
20
 
to replace many internal ad-hoc enumeration systems that deal with files.
21
 
 
22
 
File Fields
23
 
-----------
24
 
 
25
 
There are two fields that are used by the file unit:
26
 
 
27
 
``path``:
28
 
    This field defines the full, absolute path of the file that the unit is
29
 
    describing. Note that this is not an identifier as it is more natural to
30
 
    discuss files in terms of filenames rather than some abstract identifiers.
31
 
 
32
 
``role``:
33
 
    This field defines the purpose of the file in a given provider. This field
34
 
    may hold one of several supported values:
35
 
    
36
 
    'unit-source':
37
 
        The file is a source of unit definitions. Currently this is the only
38
 
        actually implemented value.
39
 
 
40
 
    'legacy-whitelist':
41
 
        This file is a legacy whitelist.
42
 
    
43
 
    'script':
44
 
        This file is an architecture independent executable.
45
 
        
46
 
    'binary':
47
 
        This file is an architecture-specific executable.
48
 
        
49
 
    'data':
50
 
        This file is a binary blob (a data file).
51
 
        
52
 
    'i18n':
53
 
        This file is a part of the internationalization subststem. Typically
54
 
        this would apply to the translation catalogues.
55
 
    
56
 
    'manage_py':
57
 
        This file is the provider management script, manage.py.
58
 
        
59
 
    'legal':
60
 
        This file contains copyright and licensing information.
61
 
 
62
 
    'docs':
63
 
        This file contains documentation.
 
 
b'\\ No newline at end of file'