function-reference/message-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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

<?xml version="1.0" encoding="UTF-8"?>
<guide self="function-reference/message-functions/">
<chapter>
<title>Message functions reference</title>
<body>

<p>
The following functions, which are provided by <c>functions.sh</c>, can be used for
displaying informational messages.
</p>

<table>
  <tr>
    <th>
      Function
    </th>
    <th>
      Details
    </th>
  </tr>
  <tr>
    <ti>
      <c>einfo</c>
    </ti>
    <ti>
      Display an informational message.
    </ti>
  </tr>
  <tr>
    <ti>
      <c>einfon</c>
    </ti>
    <ti>
      Display an informational message with no trailing newline.
    </ti>
  </tr>
  <tr>
    <ti>
      <c>elog</c>
    </ti>
    <ti>
      Display an informational message, to be logged if logging is enabled.
    </ti>
  </tr>
  <tr>
    <ti>
      <c>ewarn</c>
    </ti>
    <ti>
      Display a warning message.
    </ti>
  </tr>
  <tr>
    <ti>
      <c>eerror</c>
    </ti>
    <ti>
      Display an error message.
    </ti>
  </tr>
  <tr>
    <ti>
      <c>ebegin</c>
    </ti>
    <ti>
      Display the message for the start of an action block.
    </ti>
  </tr>
  <tr>
    <ti>
      <c>eend</c>
    </ti>
    <ti>
      Display the end of an action block.
    </ti>
  </tr>
  <tr>
    <ti>
      <c>eqawarn</c>
    </ti>
    <ti>
      Used by eclass authors to notify ebuild writers that they are using
      deprecated functionality.
    </ti>
  </tr>
</table>

<p>
See <uri link="::ebuild-writing/messages/"/> for a detailed discussion.
</p>

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