function-reference/sandbox-functions/text.xml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

<?xml version="1.0"?>
<guide self="function-reference/sandbox-functions/">
<chapter>
<title>Sandbox Functions Reference</title>
<body>

<p>
The following functions, which are all provided by <c>ebuild.sh</c>, handle working
with the sandbox.
</p>

<table>
  <tr>
    <th>
      Function
    </th>
    <th>
      Details
    </th>
  </tr>
  <tr>
    <ti>
      <c>addread</c>
    </ti>
    <ti>
      Add one single additional item to the sandbox allowed read list.
    </ti>
  </tr>
  <tr>
    <ti>
      <c>addwrite</c>
    </ti>
    <ti>
      Add one single additional item to the sandbox allowed write list. <b>Note</b>:
      If at all possible, use <c>addpredict</c> instead. Using <c>addwrite</c> is <b>not</b> an
      appropriate alternative to making your package build sandbox-friendly.
    </ti>
  </tr>
  <tr>
    <ti>
      <c>adddeny</c>
    </ti>
    <ti>
      Add one single additional item to the sandbox deny write list.
    </ti>
  </tr>
  <tr>
    <ti>
      <c>addpredict</c>
    </ti>
    <ti>
      Add one single additional item to the sandbox predict (pretend to allow write) list.
    </ti>
  </tr>
</table>

<p>
None of these functions accept multiple arguments in one call. The sandbox is
recursive, so to allow predicted writes to <c>/foo/bar</c> and <c>/foo/baz</c>,
<c>addpredict /foo</c> would be sufficient.
</p>

<p>
See <uri link="::general-concepts/sandbox"/> for details on how the sandbox works.
See <uri link="::appendices/common-problems/#Handling Access Violations"/> for how
to handle sandbox-related build problems.
</p>

</body>
</chapter>
</guide>