This file is indexed.

/usr/share/gtk-doc/html/PackageKit/introduction-ideas-status.html is in packagekit-docs 0.8.17-4ubuntu6~gcc5.4ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

 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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PackageKit Reference Manual: Status Values</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="PackageKit Reference Manual">
<link rel="up" href="concepts.html" title="Important Concepts">
<link rel="prev" href="introduction-ideas-transactionid.html" title="Transaction IDs">
<link rel="next" href="backend-compiled.html" title="Compiled Backends">
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts"></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="concepts.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="introduction-ideas-transactionid.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="backend-compiled.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="sect1">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="introduction-ideas-status"></a>Status Values</h2></div></div></div>
<p>
      A transaction will have different status values as it it queued, prepared
      and executed.
      The <code class="literal">::StatusChanged</code> signal from PkClient allow you
      to design user interfaces that tell the user what is happening with the
      transaction.
    </p>
<p>
      A typical transaction will have the following states:
    </p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>
          Queued in the active queue (<code class="literal">PK_STATUS_ENUM_WAIT</code>)
        </p></li>
<li class="listitem"><p>
          Transaction started, and is being prepared (<code class="literal">PK_STATUS_ENUM_SETUP</code>)
        </p></li>
<li class="listitem"><p>
          The transaction is running (<code class="literal">PK_STATUS_ENUM_RUNNING</code>)
        </p></li>
<li class="listitem"><p>
          (optional) Data is downloading (<code class="literal">PK_STATUS_ENUM_DOWNLOADING</code>)
        </p></li>
<li class="listitem"><p>
          (optional) Data is installing (<code class="literal">PK_STATUS_ENUM_INSTALLING</code>)
        </p></li>
<li class="listitem"><p>
          The transaction is finished (<code class="literal">PK_STATUS_ENUM_FINISHED</code>)
        </p></li>
</ul></div>
<p>
      If the transaction is waiting for other jobs to finish (in the active queue)
      then the status will be stuck at <code class="literal">PK_STATUS_ENUM_WAIT</code>
      and the UI should show a message to this effect.
    </p>
<p>
      If the transaction is waiting for a package lock (when a legacy tool like
      <code class="literal">pirut</code> is loaded and has the <code class="literal">yum</code> lock)
      then the transaction will be stuck at <code class="literal">PK_STATUS_ENUM_WAITING_FOR_LOCK</code>.
    </p>
<p>
      As a backend writer, you do not have to set <code class="literal">PK_STATUS_ENUM_RUNNING</code>
      manually, as this will be set for you if you set any other value such as
      <code class="literal">PK_STATUS_ENUM_DOWNLOADING</code> or <code class="literal">PK_STATUS_ENUM_INFO</code>.
      However, you will need to avoid setting any status values until a package
      lock is available and the transaction has started.
    </p>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.20</div>
</body>
</html>