source: general/prog/ruby.xml@ b2d60651

lazarus trunk
Last change on this file since b2d60651 was 5b78d1c, checked in by Douglas R. Reno <renodr@…>, 4 weeks ago

Ruby: remove duplicated text
  • Property mode set to 100644
File size: 12.1 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
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 ruby-download-http "https://cache.ruby-lang.org/pub/ruby/&ruby-minor-version;/ruby-&ruby-version;.tar.xz">
8 <!ENTITY ruby-download-ftp " ">
9 <!ENTITY ruby-md5sum "0931370806081135e80f4be24d4b27ed">
10 <!ENTITY ruby-size "16 MB">
11 <!ENTITY ruby-buildsize "663 MB (with tests and C API docs)">
12 <!ENTITY ruby-time "3.4 SBU (using parallelism=4; with tests and C API docs)">
13]>
14
15<sect1 id="ruby" xreflabel="Ruby-&ruby-version;">
16 <?dbhtml filename="ruby.html"?>
17
18
19 <title>Ruby-&ruby-version;</title>
20
21 <indexterm zone="ruby">
22 <primary sortas="a-Ruby">Ruby</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to Ruby</title>
27
28 <para>
29 The <application>Ruby</application> package contains the
30 <application>Ruby</application> development environment. This
31 is useful for object-oriented scripting.
32 </para>
33
34 &lfs121_checked;
35
36 <bridgehead renderas="sect3">Package Information</bridgehead>
37 <itemizedlist spacing="compact">
38 <listitem>
39 <para>
40 Download (HTTP): <ulink url="&ruby-download-http;"/>
41 </para>
42 </listitem>
43 <listitem>
44 <para>
45 Download (FTP): <ulink url="&ruby-download-ftp;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download MD5 sum: &ruby-md5sum;
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download size: &ruby-size;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Estimated disk space required: &ruby-buildsize;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated build time: &ruby-time;
66 </para>
67 </listitem>
68 </itemizedlist>
69
70 <bridgehead renderas="sect3">Ruby Dependencies</bridgehead>
71
72 <bridgehead renderas="sect4">Required</bridgehead>
73 <para role="required">
74 <xref linkend="libyaml"/>
75 </para>
76
77 <bridgehead renderas="sect4">Optional</bridgehead>
78 <para role="optional">
79 <xref linkend="doxygen"/>,
80 <xref linkend="graphviz"/>,
81 <xref linkend="rust"/>,
82 <xref linkend="tk"/>,
83 <xref linkend="valgrind"/>,
84 &berkeley-db; and
85 <ulink url="https://dtrace.org/about/">DTrace</ulink>
86 </para>
87
88 </sect2>
89
90 <sect2 role="installation">
91 <title>Installation of Ruby</title>
92
93 <para>
94 Install <application>Ruby</application> by running the following
95 command:
96 </para>
97
98<screen><userinput>./configure --prefix=/usr \
99 --disable-rpath \
100 --enable-shared \
101 --without-valgrind \
102 --without-baseruby \
103 ac_cv_func_qsort_r=no \
104 --docdir=/usr/share/doc/ruby-&ruby-version; &amp;&amp;
105make</userinput></screen>
106
107 <para>
108 Optionally, build the CAPI documents by running the following
109 commands:
110 </para>
111
112<screen><userinput>make capi</userinput></screen>
113
114 <para>
115 To test the results, issue: <command>make -j1 -k check</command>.
116 Note that running the test suite with parallel jobs may cause test
117 failures outputted as cryptic <computeroutput>unknown
118 object</computeroutput> messages, resulting a summary falsely claiming
119 <quote>all tests passed</quote>. If the environment has variables
120 related to proxy settings (<envar>all_proxy</envar>,
121 <envar>ALL_PROXY</envar>, <envar>http_proxy</envar>, and etc.) set,
122 the test suite will bail out early with messages like
123 <computeroutput>net/ftp is not found</computeroutput>. Make sure that you
124 unset these variables for the test suite. There are over 26,000 tests.
125 <!-- https://bugs.ruby-lang.org/issues/20106 -->
126 12 tests are known to fail because of expired certificates in the
127 test data.
128 <!-- https://github.com/ruby/ruby/pull/10616
129 https://github.com/ruby/ruby/commit/dd5e625d7bcb -->
130 Three tests named
131 <literal>TestNetHTTPS#test_session_reuse_but_expire</literal>,
132 <literal>OpenSSL::TestASN1#test_utctime</literal>, and
133 <literal>OpenSSL::TestASN1#test_generalizedtime</literal> are known
134 to fail with OpenSSL-3.3.0 or later.
135 Some tests related to ipv6 may indicate errors. If the
136 tests are run in a directory that has a world writable component (e.g.
137 /tmp) then several additional tests may fail.
138 </para>
139
140 <para>
141 Now, as the <systemitem class="username">root</systemitem> user:
142 </para>
143
144<screen role="root"><userinput>make install</userinput></screen>
145
146 <note>
147 <para>
148 If you have Ruby-On-Rails applications installed and did an
149 upgrade of <application>Ruby</application> by installing this
150 package, you might need to run an update there, too
151 (as the &root; user):
152 </para>
153
154<screen role="nodump"><userinput>cd /path/to/web/app
155bundle update rake</userinput></screen>
156
157 <para>
158 and restart the webserver which serves the application.
159 </para>
160
161 </note>
162
163 </sect2>
164
165 <sect2 role="commands">
166 <title>Command Explanations</title>
167
168 <para>
169 <parameter>--disable-rpath</parameter>: This switch disables embedding
170 <filename class='directory'>/usr/lib</filename> as a library search
171 path into the <command>ruby</command> program. Doing so is not needed
172 (because <filename class='directory'>/usr/lib</filename> is a system
173 library path) and it may cause the test suite running with the system
174 <filename class='libraryfile'>libruby.so</filename> instead of the
175 just built one when Ruby has been installed.
176 </para>
177
178 <para>
179 <parameter>--enable-shared</parameter>: This switch enables building
180 the <filename class="libraryfile">libruby</filename> shared library.
181 </para>
182
183 <para>
184 <parameter>--without-baseruby</parameter>: This switch prevents using the
185 system <command>ruby</command> if it is already installed. The build
186 system will use the newly built version instead.
187 </para>
188
189 <para>
190 <parameter>ac_cv_func_qsort_r=no</parameter>: This switch prevents
191 using the <function>qsort_r</function> function from Glibc. Ruby
192 makes some aggressive optimization assuming some implementation
193 details of the sorting algorithm, but the assumption is not true with
194 the Glibc implementation. With this switch Ruby will use its own sort
195 implementation instead.
196 </para>
197
198 <para>
199 <option>--disable-install-doc</option>: This switch disables building and
200 installing rdoc indexes and C API documents.
201 </para>
202
203 <para>
204 <option>--disable-install-rdoc</option>: This switch disables building
205 and installing rdoc indexes.
206 </para>
207
208 <para>
209 <option>--disable-install-capi</option>: This switch disables building
210 and installing C API documents.
211 </para>
212
213 </sect2>
214
215 <sect2 role="content">
216 <title>Contents</title>
217
218 <segmentedlist>
219 <segtitle>Installed Programs</segtitle>
220 <segtitle>Installed Libraries</segtitle>
221 <segtitle>Installed Directories</segtitle>
222
223 <seglistitem>
224 <seg>
225 bundle,
226 bundler,
227 erb,
228 gem,
229 irb,
230 racc,
231 rake,
232 rbs,
233 rdbg,
234 rdoc,
235 ri,
236 ruby, and
237 typeprof
238 </seg>
239 <seg>
240 libruby.so
241 </seg>
242 <seg>
243 /usr/include/ruby-&ruby-minor-version;.0,
244 /usr/lib/ruby,
245 /usr/share/doc/ruby-&ruby-version; and
246 /usr/share/ri
247 </seg>
248 </seglistitem>
249 </segmentedlist>
250
251 <variablelist>
252 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
253 <?dbfo list-presentation="list"?>
254 <?dbhtml list-presentation="table"?>
255
256 <varlistentry id="bundle">
257 <term><command>bundle</command></term>
258 <listitem>
259 <para>
260 creates bundles of Ruby Gems
261 </para>
262 <indexterm zone="ruby bundle">
263 <primary sortas="b-bundle">bundle</primary>
264 </indexterm>
265 </listitem>
266 </varlistentry>
267
268 <varlistentry id="bundler">
269 <term><command>bundler</command></term>
270 <listitem>
271 <para>
272 manages an application's dependencies throughout it's lifecycle
273 </para>
274 <indexterm zone="ruby bundler">
275 <primary sortas="b-bundler">bundler</primary>
276 </indexterm>
277 </listitem>
278 </varlistentry>
279
280 <varlistentry id="erb">
281 <term><command>erb</command></term>
282 <listitem>
283 <para>
284 is a command line front-end for eRuby, which provides a templating
285 system for <application>Ruby</application>
286 </para>
287 <indexterm zone="ruby erb">
288 <primary sortas="b-erb">erb</primary>
289 </indexterm>
290 </listitem>
291 </varlistentry>
292
293 <varlistentry id="gem">
294 <term><command>gem</command></term>
295 <listitem>
296 <para>
297 is the command for RubyGems, which is a sophisticated package
298 manager for <application>Ruby</application>. This is similar
299 to Python's 'pip' command
300 </para>
301 <indexterm zone="ruby gem">
302 <primary sortas="b-gem">gem</primary>
303 </indexterm>
304 </listitem>
305 </varlistentry>
306
307 <varlistentry id="irb">
308 <term><command>irb</command></term>
309 <listitem>
310 <para>
311 is the interactive interface for
312 <application>Ruby</application>
313 </para>
314 <indexterm zone="ruby irb">
315 <primary sortas="b-irb">irb</primary>
316 </indexterm>
317 </listitem>
318 </varlistentry>
319
320 <varlistentry id="rake">
321 <term><command>rake</command></term>
322 <listitem>
323 <para>
324 is a make-like build utility for <application>Ruby</application>
325 </para>
326 <indexterm zone="ruby rake">
327 <primary sortas="b-rake">rake</primary>
328 </indexterm>
329 </listitem>
330 </varlistentry>
331
332 <varlistentry id="rdbg">
333 <term><command>rdbg</command></term>
334 <listitem>
335 <para>
336 is an interactive debugger for <application>Ruby</application>
337 </para>
338 <indexterm zone="ruby rdbg">
339 <primary sortas="b-rdbg">rdbg</primary>
340 </indexterm>
341 </listitem>
342 </varlistentry>
343
344 <varlistentry id="rdoc">
345 <term><command>rdoc</command></term>
346 <listitem>
347 <para>
348 generates <application>Ruby</application> documentation
349 </para>
350 <indexterm zone="ruby rdoc">
351 <primary sortas="b-rdoc">rdoc</primary>
352 </indexterm>
353 </listitem>
354 </varlistentry>
355
356 <varlistentry id="ri">
357 <term><command>ri</command></term>
358 <listitem>
359 <para>
360 displays documentation from a database on
361 <application>Ruby</application> classes, modules, and methods
362 </para>
363 <indexterm zone="ruby ri">
364 <primary sortas="b-ri">ri</primary>
365 </indexterm>
366 </listitem>
367 </varlistentry>
368
369 <varlistentry id="ruby-prog">
370 <term><command>ruby</command></term>
371 <listitem>
372 <para>
373 is an interpreted scripting language for quick
374 and easy object-oriented programming
375 </para>
376 <indexterm zone="ruby ruby-prog">
377 <primary sortas="b-ruby">ruby</primary>
378 </indexterm>
379 </listitem>
380 </varlistentry>
381
382 <varlistentry id="libruby">
383 <term><filename role="libraryfile">libruby.so</filename></term>
384 <listitem>
385 <para>
386 contains the API functions required by <application>Ruby</application>
387 </para>
388 <indexterm zone="ruby libruby">
389 <primary sortas="c-libruby">libruby.so</primary>
390 </indexterm>
391 </listitem>
392 </varlistentry>
393
394 </variablelist>
395
396 </sect2>
397
398</sect1>
Note: See TracBrowser for help on using the repository browser.