← Back to branch summary

~ubuntu-branches/ubuntu/quantal/aufs/quantal

« back to all changes in this revision

Viewing changes to README

  • Committer: Bazaar Package Importer
  • Author(s): Julian Andres Klode
  • Date: 2008-04-01 18:26:37 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20080401182637-ujuqq47eiggw4y5w
Tags: 0+20080401-1
http://bugs.debian.org/471288
http://bugs.debian.org/473767
http://bugs.debian.org/473430
* New upstream snapshot
  - Remove bashisms in script (Closes: #471288)
* debian/conf.mk, linux-patch-aufs.kpatches.sysfs_get_dentry:
  - Remove support for this patch, no longer used
* debian/conf.mk:
  - Add hacks for arm to armel (Closes: #473767)
* debian/control:
  - Add Dm-Upload-Allowed
* debian/copyright:
  - Use http://wiki.debian.org/Proposals/CopyrightFormat
* debian/linux-patch-aufs.kpatches.{splice,put_filp}:
  - Add support for Kernel 2.6.24 (and 2.6.25)
* debian/patches:
  - 01_vserver_apparmor: Update patch
  - 06_rt: Add patch for realtime kernel
  - 07_splice_hack: Add hack to support splice operations (Closes: #473430)

Show diffs side-by-side

added added

removed removed

Lines of Context:
README
2
2
Aufs -- Another Unionfs
3
3
Junjiro Okajima
4
4
 
5
 
# $Id: README,v 1.69 2008/01/28 05:02:33 sfjro Exp $
 
5
# $Id: README,v 1.74 2008/03/31 07:40:12 sfjro Exp $
6
6
 
7
7
 
8
8
0. Introduction
75
75
- permanent xino files
76
76
 
77
77
(next work)
78
 
- a race condition between udba and aufs.
79
78
- an option for refreshing the opened files after add/del branches
80
79
- 'move' policy for copy-up between two writable branches, after
81
80
  checking free space.
107
106
In order to update files after the first checkout,
108
107
        $ cd aufs.wcvs/aufs
109
108
        $ cvs update
 
109
Do not forget -A option for 'cvs update' if you ever 'cvs update' with
 
110
specifying a file version.
110
111
 
111
112
In order to see what the difference between two versions (two dates) is,
112
113
        $ cd aufs.wcvs/aufs
130
131
 
131
132
Currently aufs configuration is written in ./Kconfig.in. You can
132
133
generate the real ./fs/aufs/Kconfig file by make(1). And follow the
133
 
instructions which will be produced. The built ./fs/aufs/Kconfig
134
 
depends upon the kernel version.
 
134
instructions which will be produced by make(1). The built
 
135
./fs/aufs/Kconfig depends upon the kernel version.
135
136
Before you build ./fs/aufs/Kconfig, you need to configure your kernel,
136
137
since this build refers to linux/include/version.h.
137
138
        $ make -f local.mk kconfig
157
158
leave it blank/unset when you disable an aufs configuration, instead
158
159
of setting 'n.'
159
160
 
 
161
The aufs build system may refer some kernel source files for some
 
162
macros or internal functions which are not declared in their header
 
163
files. It depends upon the configuration whether these files will be
 
164
referred or not.
 
165
Even if you don't have these source files in your build environment,
 
166
aufs can be built safely, but works less efficiently in some cases.
 
167
 
160
168
There is a contributed Makefile for aufs users. You might want to try
161
169
it. Check
162
170
http://sourceforge.net/mailarchive/forum.php?thread_name=9c4865a10707241831r189f9646n5f2c4a9c303797d1%40mail.gmail.com&forum_name=aufs-users
203
211
  patch is required.
204
212
- splice-2.6.23.patch
205
213
  For linux-2.6.23 and later.
206
 
  When you use splice(2) or loopback-mount an fs-image file in aufs,
207
 
  this patch is required. Aufs doesn't support splice(2) in
208
 
  linux-2.6.22 and earlier.
209
 
- sysfs_get_dentry.patch
210
 
  For linux-2.6.23 and later.
211
 
  If you want to see the file size under /sys/fs/aufs, apply this
212
 
  patch. I am afraid most people never care the size of such file.
213
 
  The size shows the size of a memory allocated in kernel space.
214
 
  If you write something to the file under /sys/fs/aufs, the file size
215
 
  will be zero and the memory will be freed.
 
214
  When you use splice(2) (sendfile(2) in linux-2.6.23 and later), or
 
215
  loopback-mount an fs-image file in aufs, this patch is
 
216
  required. Aufs doesn't support splice(2) in linux-2.6.22 and
 
217
  earlier.
216
218
- put_filp.patch
217
219
  For linux-2.6.19 and later.
218
220
  When you compile aufs as a module and use NFS as an aufs branch
223
225
  required.
224
226
- lhash-2.6.22.patch
225
227
  Same above, but this patch is for linux-2.6.22 only.
 
228
- fsync_super-2.6.16.patch
 
229
  For linux-2.6.16 and later.
 
230
  When you compile aufs as a module, apply this patch and enable a
 
231
  configuration, aufs tries flushing everything for branch filesystems
 
232
  which are not marked as 'rr' or 'rr+wh' at umount or remount time.
 
233
- fsync_super-2.6.19.patch
 
234
  Same above, but this patch is for linux-2.6.19 and later.
226
235
- deny_write_access.patch
227
236
  For linux-2.6.17 and later.
228
237
  When you compile aufs as a module, applied this patch and enabled a
247
256
  (http://archive.ubuntu.com/ubuntu/pool/main/l/linux-source-2.6.22/
248
257
  linux-source-2.6.22_2.6.22-14.46_all.deb) which is modified a lot by
249
258
  ubuntu people.
 
259
- ubuntu-2.6.24-5.8.patch
 
260
  For http://archive.ubuntu.com/ubuntu/pool/main/l/linux/
 
261
  linux-source-2.6.24_2.6.24-5.8_all.deb.
250
262
- ubuntu-edgy.patch
251
263
  For Ubuntu Edgy kernel which calls itself as 2.6.17, while its
252
264
  umount_begin() interface has arguments of 2.6.18.
289
301
you modify a file under /tmp/aufs, the one on your home directory is
290
302
not affected, instead the same named file will be newly created under
291
303
/tmp/rw. And all of your modification to the file will be applied to
292
 
the one under /tmp/rw. This is called Copy on Write (COW) method.
 
304
the one under /tmp/rw. This is called the file based Copy on Write
 
305
(COW) method.
293
306
Aufs mount options are described in the generated ./aufs.5.
294
307
 
295
308
Additionally, there are some sample usages of aufs which are a
303
316
know with:
304
317
- /proc/mounts (instead of the output of mount(8))
305
318
- /sys/fs/aufs/* (if you have them)
 
319
- /sys/module/aufs/*
306
320
- linux kernel version
307
321
  if your kernel is not plain, for example modified by distributor,
308
322
  the url where i can download its source is necessary too.
324
338
Thanks to everyone who have tried and are using aufs, especially who
325
339
have reported a bug or any feedback.
326
340
 
327
 
Tomas Matejicek(slax.org) made a donation (2007/7).
 
341
Tomas Matejicek(slax.org) made a donation (much more than once).
328
342
Dai Itasaka made a donation (2007/8).
329
 
Tomas Matejicek(slax.org) made a donation (2007/10).
330
343
 
331
344
Thank you very much.
332
345
Donations are always, including future donations, very important and
333
346
helpful for me to keep on developing aufs.
 
347
If you have a plan to develop or customize linux, feel free to ask me
 
348
a job with some donations or payments.
334
349
 
335
350
 
336
351
7.