Hey. I though rather than just being around here and complaining all the time about documentation I might help to improve the same a bit. the btrfs-mount manpage could be a good start and I'd propose a more structurised format as I've did it for the first few options: *alloc_start='bytes'*:: (default: *1M*) + Sets the start of block allocations on each of the filesystem’s devices to happen above 'bytes' bytes (optionally followed by one of the case insensitive suffixes *K* (for Ki), *M* (for Mi) and *G* (for Gi). + + Mainly used for debugging purposes. *autodefrag*:: *noautodefrag*:: (default: *noautodefrag*; since: 3.0) + Control whether auto-defragmentation is enabled (with *autodefrag*) or disabled (with *noautodefrag*). + + Auto-defragmentation detects small random writes into files and queues them up for defragmentation. Works best for small files and is not well suited for large database or virtual machine image workloads. *check_int*:: *check_int_data*:: *check_int_print_mask='bitmask'*:: (default: unset; since: 3.0) + Control whether integrity checking module (which requires the kernel option *BTRFS_FS_CHECK_INTEGRITY* to be enabled) is enabled (with *check_int*, *check_int_data* or *check_int_print_mask*) or disabled (when unset) as well as its operation mode. + + With *check_int* the integrity checking module examines all block write requests in order to ensure on-disk consistency, at a large memory and CPU cost. + With *check_int_data*, which implies the option *check_int*, it further includes extent data in the integrity checks. With *check_int_print_mask*, its operation mode can be controlled by a bitmask 'bitmask' of *BTRFSIC_PRINT_MASK_** values as defined in `fs/btrfs/check-integrity.c`. + + See the comments at the top of `fs/btrfs/check-integrity.c` for more information. *commit='seconds'*:: (default: *30*; since: 3.12) + Set periodic commit interval to 'seconds' seconds. + + This is the interval at which data is synchronised to the block device. Higher values may improve performance but at the expense of loosing data from a longer period in case of system crashes, et cetera. + A warning is give for values of 'seconds' greater than *300*. *compress[='type']*:: *compress-force[='type']*:: (default: unset) + Control whether data compression is enabled (with *compress* or *compress-force*) or or disabled (when unset). + + With *compress* only data that compresses well is going to be compressed, while with *compress-force* data is compressed whether it compresses well or not. + The compression type can be set via 'type', with valid values being: + *no* (disables compression, useful when re-mounting), *zlib* (the default if no 'type' is set), *lzo* + Enabling compression implies the options *datacow* and *datasum*. That would also include these changes: commit 88a0ba7065e09497806ffc2a493ab72d0940e1af Author: Christoph Anton Mitterer <mail@xxxxxxxxxxxxxxxxxxxxxxxxxxxxx> Date: Wed Nov 25 02:51:25 2015 +0100 btrfs-progs: minor documentation improvements Overhauled the formatting of symbols: - Options, terminal-values or parts thereof are marked with *…*. - Non-terminal-values are marked with '…'. - Commands, pathnames are marked with `…`. - Added missing marks and manpage references. - Used the correct spelling of option names (lower-case). Signed-off-by: Christoph Anton Mitterer <mail@xxxxxxxxxxxxxxxxxxxxxxxxxxxxx> commit 830f71df85232e12c3795bc5c0335c1c1150c2f4 Author: Christoph Anton Mitterer <mail@xxxxxxxxxxxxxxxxxxxxxxxxxxxxx> Date: Wed Nov 25 02:09:10 2015 +0100 btrfs-progs: minor documentation improvements Swapt the order of the default value and the availability. The former seems much more important for daily use, while no one will care about the version in which something was introduced in 10 years, as everyone has far newer versions. Signed-off-by: Christoph Anton Mitterer <mail@xxxxxxxxxxxxxxxxxxxxxxxxxxxxx> commit a1f913c9dd678fba10d134a651f67d01e8c8ae38 Author: Christoph Anton Mitterer <mail@xxxxxxxxxxxxxxxxxxxxxxxxxxxxx> Date: Wed Nov 25 02:02:17 2015 +0100 btrfs-progs: minor documentation improvements - Moved the documentation of all default values to the top of each option’s section. - Added missing default values. - Added missing line breaks. Signed-off-by: Christoph Anton Mitterer <mail@xxxxxxxxxxxxxxxxxxxxxxxxxxxxx> If the responsible maintainer likes that style, I would continue to refurbish the remainder of the manpage in it. But since it's quite some work I rather asked first... Cheers, Chris.
Attachment:
smime.p7s
Description: S/MIME cryptographic signature
