← Back to branch summary

~ubuntu-branches/ubuntu/raring/aufs/raring

« back to all changes in this revision

Viewing changes to util/aufs.in.5

  • Committer: Bazaar Package Importer
  • Author(s): Julian Andres Klode
  • Date: 2008-05-06 18:35:50 UTC
  • mfrom: (1.1.5 upstream)
  • Revision ID: james.westby@ubuntu.com-20080506183550-0b6c974kkgc46oeh
Tags: 0+20080506-1
http://bugs.debian.org/479717
http://bugs.debian.org/475042
* New upstream release, supports Kernel 2.6.25 (Closes: #479717)
* Fix building with older Kernels (Closes: #475042)
* Update the patches 01, 04 and 07 to also patch fs/aufs25

Show diffs side-by-side

added added

removed removed

Lines of Context:
util/aufs.in.5
26
26
many original ideas, approaches and improvements, it
27
27
becomes totally different from Unionfs while keeping the basic features.
28
28
See Unionfs Version 1.x series for the basic features.
 
29
Recently, Unionfs Version 2.x series begin taking some of same
 
30
approaches to aufs's.
29
31
 
30
32
.\" ----------------------------------------------------------------------
31
33
.SH MOUNT OPTIONS
365
367
<sysfs>/module/aufs/parameters/nwkq.
366
368
 
367
369
So how many threads is enough? You can check it by
368
 
<sysfs>/fs/aufs/stat, if you enable CONFIG_AUFS_SYSAUFS too.
 
370
<sysfs>/fs/aufs/stat, if you enable CONFIG_AUFS_SYSAUFS (for
 
371
linux\-2.6.24 and earlier) or CONFIG_AUFS_STAT (for linux\-2.6.25 and
 
372
later) too.
369
373
It shows the maximum number of the enqueued work
370
374
at a time per a thread. Usually they are all small numbers or
371
375
0. If your workload is heavy
387
391
 
388
392
If the number of your branches is large or their path is long
389
393
and you meet the limitation of mount(8) ro /etc/mtab, you need to
390
 
enable CONFIG_AUFS_SYSAUFS and set aufs module parameter brs=1.
 
394
enable CONFIG_SYSFS and set aufs module parameter brs=1.
 
395
If your linux version is linux\-2.6.24 and earlier, you need to enable
 
396
CONFIG_AUFS_SYSAUFS too.
391
397
 
392
398
When this parameter is set as 1, aufs does not show `br:' (or dirs=)
393
399
mount option through /proc/mounts, and /sbin/mount.aufs does not put it
400
406
The default is brs=0, which means <sysfs>/fs/aufs/sbi_XXX/brNNN does not exist
401
407
and `br:' option will appear in /proc/mounts, and /etc/mtab if you
402
408
install /sbin/mount.aufs.
403
 
If you did not enable CONFIG_AUFS_SYSAUFS, this parameter will be
 
409
If you did not enable CONFIG_AUFS_SYSAUFS (for
 
410
linux\-2.6.24 and earlier), this parameter will be
404
411
ignored.
405
412
.
406
413
.TP
407
414
.B sysrq=key
408
415
Specifies MagicSysRq key for debugging aufs.
409
 
You need to enable all of CONFIG_MAGIC_SYSRQ, CONFIG_AUFS_SYSAUFS and
410
 
CONFIG_AUFS_DEBUG.
 
416
You need to enable both of CONFIG_MAGIC_SYSRQ and CONFIG_AUFS_DEBUG.
 
417
If your linux version is linux\-2.6.24 and earlier, you need to enable
 
418
CONFIG_AUFS_SYSAUFS too.
411
419
Currently this is for developers only.
412
420
The default is `a'.
413
421
 
458
466
aufs. A readonly branch can be shared.
459
467
 
460
468
The maximum number of branches is configurable at compile time.
461
 
The current value is \*[AUFS_BRANCH_MAX].
 
469
The current value is \*[AUFS_BRANCH_MAX] which depends upon
 
470
configuration.
462
471
 
463
472
When an unknown permission or attribute is given, aufs sets ro to that
464
473
branch silently.
563
572
 
564
573
The xino files are always hidden, i.e. removed. So you cannot
565
574
do `ls \-l xino_file'.
566
 
If you enable CONFIG_AUFS_SYSAUFS, you can check these information through
567
 
<sysfs>/fs/aufs/<sbi_id>/xino.
 
575
If you enable CONFIG_SYSFS, you can check these information through
 
576
<sysfs>/fs/aufs/<sbi_id>/xino (for linux\-2.6.24 and earlier, you
 
577
need to enable CONFIG_AUFS_SYSAUFS too).
568
578
The first line in <sysfs>/fs/aufs/<sbi_id>/xino shows the information
569
579
of the bitmap file, in the format of,
570
580
 
1097
1107
Since aufs has no actual block device, you need to add NFS `fsid' option at
1098
1108
exporting. Refer to the manual of NFS about the detail of this option.
1099
1109
 
1100
 
It is recommended to export your branch filesystems once before
 
1110
In linux\-2.6.23 and earlier,
 
1111
it is recommended to export your branch filesystems once before
1101
1112
exporting aufs. By exporting once, the branch filesystem internal
1102
1113
pointer named find_exported_dentry is initialized. After this
1103
1114
initialization, you may unexport them.
1109
1120
value, and produce a
1110
1121
warning. While it will work correctly, I am afraid it will be unsafe
1111
1122
in the future.
 
1123
In linux\-2.6.24 and later, this exporting is unnecessary.
1112
1124
 
1113
1125
Additionally, there are several limitations or requirements.
1114
1126
.RS
1257
1269
 
1258
1270
The whiteout prefix (\*[AUFS_WH_PFX]) is reserved on all branches. Users should
1259
1271
not handle the filename begins with this prefix.
 
1272
In order to future whiteout, the maxmum filename length is limited by
 
1273
the longest value \- \*[AUFS_WH_PFX_LEN]. It may be a violation of POSIX.
1260
1274
 
1261
1275
If you dislike the difference between the aufs entries in /etc/mtab
1262
1276
and /proc/mounts, and if you are using mount(8) in util\-linux package,
1337
1351
children. It can be recursive copyup. Current aufs does not support
1338
1352
such huge copyup operation at one time in kernel space, instead
1339
1353
produces a warning and returns EXDEV.
1340
 
Generally, mv(1) detects this error and tries mkdir(2) and rename(2)
1341
 
repeatedly. So the result is harmless.
 
1354
Generally, mv(1) detects this error and tries mkdir(2) and
 
1355
rename(2) or copy/unlink recursively. So the result is harmless.
1342
1356
If your application which issues rename(2) for a directory does not
1343
1357
support EXDEV, it will not work on aufs.
 
1358
Also this specification is applied to the case when the src directroy
 
1359
exists on the lower readonly branch and it has child(ren).
1344
1360
 
1345
1361
.\" ----------------------------------------------------------------------
1346
1362
.SH EXAMPLES