source: postlfs/filesystems/btrfs-progs.xml@ 758ae3c2

10.0 10.1 11.0 11.1 11.2 lazarus plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 758ae3c2 was 758ae3c2, checked in by Bruce Dubbs <bdubbs@…>, 3 years ago

Update to btrfs-progs-v5.7.

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

  • Property mode set to 100644
File size: 10.3 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 btrfs-progs-download-http "&kernel-dl;/linux/kernel/people/kdave/btrfs-progs/btrfs-progs-v&btrfs-progs-version;.tar.xz">
8 <!ENTITY btrfs-progs-download-ftp " ">
9 <!ENTITY btrfs-progs-md5sum "86402bb64e2021e6f0eb7d0cacd31fbb">
10 <!ENTITY btrfs-progs-size "2.1 MB">
11 <!ENTITY btrfs-progs-buildsize "62 MB (add 39 MB for tests)">
12 <!ENTITY btrfs-progs-time "0.3 SBU (add 16 SBU for tests)">
13]>
14
15<sect1 id="btrfs-progs" xreflabel="btrfs-progs-&btrfs-progs-version;">
16 <?dbhtml filename="btrfs-progs.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>btrfs-progs-&btrfs-progs-version;</title>
24
25 <indexterm zone="btrfs-progs">
26 <primary sortas="a-btrfs-progs">btrfs-progs</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to btrfs-progs</title>
31
32 <para>
33 The <application>btrfs-progs</application> package contains
34 administration and debugging tools for the B-tree file system (btrfs).
35 </para>
36
37 &lfs91_checked;
38
39 <bridgehead renderas="sect3">Package Information</bridgehead>
40 <itemizedlist spacing="compact">
41 <listitem>
42 <para>
43 Download (HTTP): <ulink url="&btrfs-progs-download-http;"/>
44 </para>
45 </listitem>
46 <listitem>
47 <para>
48 Download (FTP): <ulink url="&btrfs-progs-download-ftp;"/>
49 </para>
50 </listitem>
51 <listitem>
52 <para>
53 Download MD5 sum: &btrfs-progs-md5sum;
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 Download size: &btrfs-progs-size;
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Estimated disk space required: &btrfs-progs-buildsize;
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 Estimated build time: &btrfs-progs-time;
69 </para>
70 </listitem>
71 </itemizedlist>
72
73 <bridgehead renderas="sect3">Btrfs-progs Dependencies</bridgehead>
74
75 <bridgehead renderas="sect4">Required</bridgehead>
76 <para role="required">
77 <xref linkend="lzo"/>
78 </para>
79
80 <bridgehead renderas="sect4">Recommended</bridgehead>
81 <para role="recommended">
82 <xref linkend="asciidoc"/> and
83 <xref linkend="xmlto"/> (both required to generate man pages)
84 </para>
85
86 <bridgehead renderas="sect4">Optional</bridgehead>
87 <para role="optional">
88 <xref linkend="lvm2"/> (<command>dmsetup</command> is used in tests),
89 <xref linkend="python2"/> (python bindings), and
90 <xref linkend="reiserfs"/> (for tests)
91 </para>
92
93 <para condition="html" role="usernotes">User Notes:
94 <ulink url="&blfs-wiki;/btrfs-progs"/></para>
95
96 </sect2>
97
98 <sect2 role="kernel" id="btrfs-progs-kernel">
99 <title>Kernel Configuration</title>
100
101 <para>
102 Enable the following option in the kernel configuration
103 and recompile the kernel:
104 </para>
105
106<screen><literal>File systems ---&gt;
107 &lt;*/M&gt; Btrfs filesystem support [CONFIG_BTRFS_FS]</literal></screen>
108
109 <note>
110 <para>
111 CONFIG_BTRFS_FS_POSIX_ACL and
112 CONFIG_REISERFS_FS_XATTR are required for some tests.
113 Other Btrfs options in the kernel are optional.
114 </para>
115 </note>
116
117 <indexterm zone="btrfs-progs btrfs-progs-kernel">
118 <primary sortas="d-btrfs-progs">BTRFS Programs</primary>
119 </indexterm>
120
121 </sect2>
122
123 <sect2 role="installation">
124 <title>Installation of btrfs-progs</title>
125
126 <para>
127 Install <application>btrfs-progs</application> by running the following
128 commands:
129 </para>
130
131<screen><userinput>./configure --prefix=/usr \
132 --bindir=/bin \
133 --libdir=/lib &amp;&amp;
134make</userinput></screen>
135
136 <note>
137 <para>
138 Some tests require grep built with perl regular expressions. To
139 obtain this, rebuild grep with the LFS Chapter 6 instructions after
140 installing <xref linkend="pcre"/>.
141 </para>
142 </note>
143
144 <para>
145 Before running tests, build a support program and
146 disable several that fail:
147 </para>
148
149<screen remap="test"><userinput>make fssum &amp;&amp;
150
151sed -i '/found/s/^/: #/' tests/convert-tests.sh &amp;&amp;
152
153mv tests/convert-tests/010-reiserfs-basic/test.sh{,.broken} &amp;&amp;
154mv tests/convert-tests/011-reiserfs-delete-all-rollback/test.sh{,.broken} &amp;&amp;
155mv tests/convert-tests/012-reiserfs-large-hole-extent/test.sh{,.broken} &amp;&amp;
156mv tests/convert-tests/013-reiserfs-common-inode-flags/test.sh{,.broken} &amp;&amp;
157mv tests/convert-tests/014-reiserfs-tail-handling/test.sh{,.broken}</userinput></screen>
158
159 <para>
160 To test the results, issue (as the <systemitem
161 class="username">root</systemitem> user):
162 </para>
163
164<screen role="root" remap="test"><userinput>pushd tests
165 ./fsck-tests.sh <!-- 43 tests 6m14s -->
166 ./mkfs-tests.sh <!-- 20 tests 2m48s -->
167 ./cli-tests.sh <!-- 12 tests 0m51s -->
168 ./convert-tests.sh <!-- 16 tests 13m36s -->
169 ./misc-tests.sh <!-- 38 tests 3m18s -->
170 ./fuzz-tests.sh <!-- 8 tests 1m11s -->
171popd</userinput></screen>
172
173 <para>
174 Install the package as the <systemitem
175 class="username">root</systemitem> user:
176 </para>
177
178<screen role="root"><userinput>make install &amp;&amp;
179
180ln -sfv ../../lib/$(readlink /lib/libbtrfs.so) /usr/lib/libbtrfs.so &amp;&amp;
181ln -sfv ../../lib/$(readlink /lib/libbtrfsutil.so) /usr/lib/libbtrfsutil.so &amp;&amp;
182rm -fv /lib/libbtrfs.{a,so} /lib/libbtrfsutil.{a,so} &amp;&amp;
183mv -v /bin/{mkfs,fsck}.btrfs /sbin</userinput></screen>
184
185 </sect2>
186
187 <sect2 role="commands">
188 <title>Command Explanations</title>
189
190 <para>
191 <option>--disable-documentation</option>: This option
192 is needed if the recommended dependencies are not installed.
193 </para>
194
195 <para>
196 <command>mv tests/{cli,convert,misc,fuzz}-tests/ ...</command>: Disables
197 tests that fail and prevent tests from completing.
198 </para>
199
200 <para>
201 <command>ln -s ... /usr/lib/libbtrfs.so</command>: Creates a
202 symbolic link in the directory where it is expected.
203 </para>
204
205 <para>
206 <command>rm /lib/libbtrfs.{a,so}</command>: Removes unneeded
207 library entries.
208 </para>
209
210 </sect2>
211
212 <sect2 role="content">
213 <title>Contents</title>
214
215 <segmentedlist>
216 <segtitle>Installed Programs</segtitle>
217 <segtitle>Installed Libraries</segtitle>
218 <segtitle>Installed Directories</segtitle>
219
220 <seglistitem>
221 <seg>
222 btrfs,
223 btrfs-convert,
224 btrfs-find-root,
225 btrfs-image,
226 btrfs-map-logical,
227 btrfs-select-super,
228 btrfsck (link to btrfs),
229 btrfstune,
230 fsck.btrfs, and
231 mkfs.btrfs
232 </seg>
233
234 <seg>
235 libbtrfs.so and
236 libbtrfsutil.so
237 </seg>
238
239 <seg>/usr/include/btrfs</seg>
240 </seglistitem>
241 </segmentedlist>
242
243 <variablelist>
244 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
245 <?dbfo list-presentation="list"?>
246 <?dbhtml list-presentation="table"?>
247
248 <varlistentry id="btrfs-prog">
249 <term><command>btrfs</command></term>
250 <listitem>
251 <para>
252 is the main interface into btrfs filesystem operations.
253 </para>
254 <indexterm zone="btrfs-progs btrfs-prog">
255 <primary sortas="b-btrfs">btrfs</primary>
256 </indexterm>
257 </listitem>
258 </varlistentry>
259
260 <varlistentry id="btrfs-convert">
261 <term><command>btrfs-convert</command></term>
262 <listitem>
263 <para>
264 converts from an ext2/3/4 filesystem to btrfs.
265 </para>
266 <indexterm zone="btrfs-progs btrfs-convert">
267 <primary sortas="b-btrfs-convert">btrfs-convert</primary>
268 </indexterm>
269 </listitem>
270 </varlistentry>
271
272 <varlistentry id="btrfs-find-root">
273 <term><command>btrfs-find-root</command></term>
274 <listitem>
275 <para>
276 is a filter to find btrfs root.
277 </para>
278 <indexterm zone="btrfs-progs btrfs-find-root">
279 <primary sortas="b-btrfs-find-root">btrfs-find-root</primary>
280 </indexterm>
281 </listitem>
282 </varlistentry>
283
284 <varlistentry id="btrfs-map-logical">
285 <term><command>btrfs-map-logical</command></term>
286 <listitem>
287 <para>
288 maps btrfs logical extent to physical extent.
289 </para>
290 <indexterm zone="btrfs-progs btrfs-map-logical">
291 <primary sortas="b-btrfs-map-logical">btrfs-map-logical</primary>
292 </indexterm>
293 </listitem>
294 </varlistentry>
295
296 <varlistentry id="btrfs-select-super">
297 <term><command>btrfs-select-super</command></term>
298 <listitem>
299 <para>
300 overwrites the primary superblock with a backup copy.
301 </para>
302 <indexterm zone="btrfs-progs btrfs-select-super">
303 <primary sortas="b-btrfs-select-super">btrfs-select-super</primary>
304 </indexterm>
305 </listitem>
306 </varlistentry>
307
308 <varlistentry id="btrfstune">
309 <term><command>btrfstune</command></term>
310 <listitem>
311 <para>
312 tunes various filesystem parameters.
313 </para>
314 <indexterm zone="btrfs-progs btrfstune">
315 <primary sortas="b-btrfstune">btrfstune</primary>
316 </indexterm>
317 </listitem>
318 </varlistentry>
319
320 <varlistentry id="fsck.btrfs">
321 <term><command>fsck.btrfs</command></term>
322 <listitem>
323 <para>
324 does nothing, but is present for consistency with fstab.
325 </para>
326 <indexterm zone="btrfs-progs fsck.btrfs">
327 <primary sortas="b-fsck.btrfs">fsck.btrfs</primary>
328 </indexterm>
329 </listitem>
330 </varlistentry>
331
332 <varlistentry id="mkfs.btrfs">
333 <term><command>mkfs.btrfs</command></term>
334 <listitem>
335 <para>
336 creates a btrfs file system.
337 </para>
338 <indexterm zone="btrfs-progs mkfs.btrfs">
339 <primary sortas="b-mkfs.btrfs">mkfs.btrfs</primary>
340 </indexterm>
341 </listitem>
342 </varlistentry>
343
344 </variablelist>
345
346 </sect2>
347
348</sect1>
Note: See TracBrowser for help on using the repository browser.