[packagekit] packagekit: Branch 'master'

Richard Hughes hughsient at kemper.freedesktop.org
Sat Oct 13 17:12:11 PDT 2007


 TODO                  |    1 
 docs/backends.xml     |   17 +++++++++
 docs/introduction.xml |   94 ++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 111 insertions(+), 1 deletion(-)

New commits:
commit ee6b9dbd59752cd356fd5cdce3a8d27447ca9c44
Author: Richard Hughes <richard at hughsie.com>
Date:   Sun Oct 14 01:10:48 2007 +0100

    Add details to the help file for the new repo stuff

diff --git a/TODO b/TODO
index d8f3ef7..aba873c 100644
--- a/TODO
+++ b/TODO
@@ -5,7 +5,6 @@ TimeRemaining()
 
 *** the backends will have repo controls ***
 Add the callback and methods in PkBackend
-Add details to the help file
 Add methods and signals to the client library
 
 *** Prepare download to refresh system ***
diff --git a/docs/backends.xml b/docs/backends.xml
index a0d4b01..da849c6 100644
--- a/docs/backends.xml
+++ b/docs/backends.xml
@@ -106,6 +106,18 @@
             <entry>Refresh Cache</entry>
             <entry><literal>refresh-cache.*</literal></entry>
           </row>
+          <row>
+            <entry>Get Repo List</entry>
+            <entry><literal>get-repo-list.*</literal></entry>
+          </row>
+          <row>
+            <entry>Repo Enable</entry>
+            <entry><literal>repo-enable.*</literal></entry>
+          </row>
+          <row>
+            <entry>Repo Set Data</entry>
+            <entry><literal>repo-set-data.*</literal></entry>
+          </row>
         </tbody>
       </tgroup>
     </informaltable>
@@ -184,6 +196,11 @@
             <entry><literal>repository_name[tab]key_url[tab]key_userid[tab]key_id[tab]key_fingerprint[tab]key_timestamp[tab]type</literal></entry>
             <entry><literal>stdout</literal></entry>
           </row>
+          <row>
+            <entry>RepoDetail</entry>
+            <entry><literal>repo-detail[tab]repo_id[tab]description[tab]enabled</literal></entry>
+            <entry><literal>stdout</literal></entry>
+          </row>
         </tbody>
       </tgroup>
     </informaltable>
diff --git a/docs/introduction.xml b/docs/introduction.xml
index 7c42090..4676fd2 100644
--- a/docs/introduction.xml
+++ b/docs/introduction.xml
@@ -1150,6 +1150,100 @@
         <literal>Package</literal>.
       </para>
     </sect2>
+
+    <sect2 id="api-get-repo-list">
+      <title>Get Repo List</title>
+      <para>
+        Return the list of repositories used in the system.
+      </para>
+      <para>
+        There are no arguments.
+      </para>
+      <para>
+        This method typically emits
+        <literal>RepoDetail</literal>.
+      </para>
+    </sect2>
+
+    <sect2 id="api-repo-enable">
+      <title>Repo Enable</title>
+      <para>
+        This enables the repository specified.
+      </para>
+      <para>
+        The arguments are:
+      </para>
+      <informaltable>
+        <tgroup cols="2">
+          <thead>
+            <row>
+              <entry>Option</entry>
+              <entry>Description</entry>
+            </row>
+          </thead>
+          <tbody>
+            <row>
+              <entry><literal>repo_id</literal></entry>
+              <entry>
+                A repository identifier, e.g.
+                <literal>fedora-development-debuginfo</literal>
+              </entry>
+            </row>
+            <row>
+              <entry><literal>enabled</literal></entry>
+              <entry>
+                <literal>true</literal> if enabled,
+                <literal>false</literal> if disabled.
+              </entry>
+            </row>
+          </tbody>
+        </tgroup>
+      </informaltable>
+    </sect2>
+
+    <sect2 id="api-repo-set-data">
+      <title>Repo Set Data</title>
+      <para>
+        This sets a parameter for the repository specified.
+      </para>
+      <para>
+        The arguments are:
+      </para>
+      <informaltable>
+        <tgroup cols="2">
+          <thead>
+            <row>
+              <entry>Option</entry>
+              <entry>Description</entry>
+            </row>
+          </thead>
+          <tbody>
+            <row>
+              <entry><literal>repo_id</literal></entry>
+              <entry>
+                A repository identifier, e.g.
+                <literal>fedora-development-debuginfo</literal>
+              </entry>
+            </row>
+            <row>
+              <entry><literal>parameter</literal></entry>
+              <entry>
+                The backend specific value, e.g.
+                <literal>set-download-url</literal>.
+              </entry>
+            </row>
+            <row>
+              <entry><literal>value</literal></entry>
+              <entry>
+                The backend specific value, e.g.
+                <literal>http://foo.bar.org/baz</literal>.
+              </entry>
+            </row>
+          </tbody>
+        </tgroup>
+      </informaltable>
+    </sect2>
+
   </sect1>
 
   <sect1 id="api-signal-reference">



More information about the PackageKit mailing list