source: gnome/platform/rest.xml@ 815f8eff

10.0 10.1 11.0 9.0 9.1 ken/refactor-virt lazarus qt5new trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 815f8eff was 815f8eff, checked in by Douglas R. Reno <renodr@…>, 2 years ago

Update test suite documentation for pygobject3 and rest
Couple more tags

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@22007 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 5.5 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY rest-download-http "&gnome-download-http;/rest/0.8/rest-&rest-version;.tar.xz">
8 <!ENTITY rest-download-ftp "&gnome-download-ftp;/rest/0.8/rest-&rest-version;.tar.xz">
9 <!ENTITY rest-md5sum "ece4547298a81105f307369d73c21b9d">
10 <!ENTITY rest-size "332 KB">
11 <!ENTITY rest-buildsize "12.5 MB (with tests)">
12 <!ENTITY rest-time "0.2 SBU (with tests)">
13]>
14
15<sect1 id="rest" xreflabel="rest-&rest-version;">
16 <?dbhtml filename="rest.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>rest-&rest-version;</title>
24
25 <indexterm zone="rest">
26 <primary sortas="a-rest">rest</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to rest</title>
31
32 <para>
33 The <application>rest</application> package contains a library
34 that was designed to make it easier to access web services that
35 claim to be "RESTful". It includes convenience wrappers for
36 libsoup and libxml to ease remote use of the RESTful API.
37 </para>
38
39 &lfs90_checked;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing="compact">
43 <listitem>
44 <para>
45 Download (HTTP): <ulink url="&rest-download-http;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download (FTP): <ulink url="&rest-download-ftp;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download MD5 sum: &rest-md5sum;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download size: &rest-size;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated disk space required: &rest-buildsize;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Estimated build time: &rest-time;
71 </para>
72 </listitem>
73 </itemizedlist>
74
75 <bridgehead renderas="sect3">rest Dependencies</bridgehead>
76
77 <bridgehead renderas="sect4">Required</bridgehead>
78 <para role="required">
79 <xref linkend="make-ca"/> and
80 <xref linkend="libsoup"/>
81 </para>
82
83 <bridgehead renderas="sect4">Recommended</bridgehead>
84 <para role="recommended">
85 <xref linkend="gobject-introspection"/>
86 </para>
87
88 <bridgehead renderas="sect4">Optional</bridgehead>
89 <para role="optional">
90 <xref linkend="gtk-doc"/> and
91 <ulink url="http://ltp.sourceforge.net/coverage/lcov.php">LCOV</ulink>
92 </para>
93
94 <para condition="html" role="usernotes">User Notes:
95 <ulink url="&blfs-wiki;/rest"/>
96 </para>
97 </sect2>
98
99 <sect2 role="installation">
100 <title>Installation of rest</title>
101
102 <para>
103 Install <application>rest</application> by running the following
104 commands:
105 </para>
106
107<screen><userinput>./configure --prefix=/usr \
108 --with-ca-certificates=/etc/pki/tls/certs/ca-bundle.crt &amp;&amp;
109make</userinput></screen>
110
111 <para>
112 To test the results, issue: <command>make check</command>.
113 The flickr test will fail due to Public API changes on their site.
114 The OAuth tests will fail because the website that it uses to test
115 connectivity via OAuth no longer exists.
116 </para>
117
118 <para>
119 Now, as the <systemitem class="username">root</systemitem> user:
120 </para>
121
122<screen role="root"><userinput>make install</userinput></screen>
123
124 </sect2>
125
126 <sect2 role="commands">
127 <title>Command Explanations</title>
128
129 <para>
130 <parameter>--with-ca-certificates=/etc/pki/tls/certs/ca-bundle.crt</parameter>:
131 This switch sets the location of the BLFS certificate authority bundle.
132 </para>
133
134 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
135 href="../../xincludes/gtk-doc-rebuild.xml"/>
136
137 </sect2>
138
139 <sect2 role="content">
140 <title>Contents</title>
141
142 <segmentedlist>
143 <segtitle>Installed Programs</segtitle>
144 <segtitle>Installed Libraries</segtitle>
145 <segtitle>Installed Directories</segtitle>
146
147 <seglistitem>
148 <seg>
149 None
150 </seg>
151 <seg>
152 librest-0.7.so and librest-extras-0.7.so
153 </seg>
154 <seg>
155 /usr/include/rest-0.7 and
156 /usr/share/gtk-doc/html/rest-0.7
157 </seg>
158 </seglistitem>
159 </segmentedlist>
160
161 <variablelist>
162 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
163 <?dbfo list-presentation="list"?>
164 <?dbhtml list-presentation="table"?>
165
166 <varlistentry id="librest-0.7">
167 <term><filename class="libraryfile">librest-0.7.so</filename></term>
168 <listitem>
169 <para>
170 contains the RESTful Web API Query functions.
171 </para>
172 <indexterm zone="rest librest-0.7">
173 <primary sortas="c-librest-0.7">librest-0.7.so</primary>
174 </indexterm>
175 </listitem>
176 </varlistentry>
177
178 <varlistentry id="librest-extras-0.7">
179 <term><filename class="libraryfile">librest-extras-0.7.so</filename></term>
180 <listitem>
181 <para>
182 contains extra RESTful Web API Query functions.
183 </para>
184 <indexterm zone="rest librest-extras-0.7">
185 <primary sortas="c-librest-extras-0.7">librest-extras-0.7.so</primary>
186 </indexterm>
187 </listitem>
188 </varlistentry>
189
190 </variablelist>
191
192 </sect2>
193
194</sect1>
Note: See TracBrowser for help on using the repository browser.