diff mbox series

btrfs-progs: Improve default explanation in man page

Message ID 20210222152945.xt7w5ldajsv5ehlg@fiona (mailing list archive)
State New, archived
Headers show
Series btrfs-progs: Improve default explanation in man page | expand

Commit Message

Goldwyn Rodrigues Feb. 22, 2021, 3:29 p.m. UTC
The manpage mentions defaults as on or off. This does not explicitly
explain which setting is on, especially in tri-state or more settings.

Change defaults to explain which settings are chosen by default.

Signed-off-by: Goldwyn Rodrigues <rgoldwyn@suse.com>
diff mbox series


diff --git a/Documentation/btrfs-man5.asciidoc b/Documentation/btrfs-man5.asciidoc
index e5edbe53..e64c4f1c 100644
--- a/Documentation/btrfs-man5.asciidoc
+++ b/Documentation/btrfs-man5.asciidoc
@@ -42,7 +42,7 @@  have been applied.
-(default: on)
+(default: acl)
 Enable/disable support for Posix Access Control Lists (ACLs).  See the
 `acl`(5) manual page for more information about ACLs.
@@ -52,7 +52,7 @@  mount fails if 'acl' is requested but the feature is not compiled in.
-(since: 3.0, default: off)
+(since: 3.0, default: noautodefrag)
 Enable automatic file defragmentation.
 When enabled, small random writes into files (in a range of tens of kilobytes,
@@ -72,7 +72,7 @@  broken up reflinks.
-(default: on)
+(default: barrier)
 Ensure that all IO write operations make it through the device cache and are stored
 permanently when the filesystem is at its consistency checkpoint. This
@@ -131,7 +131,7 @@  seconds (5 minutes). Use with care.
-(default: off, level support since: 5.1)
+(default: compress=no, level support since: 5.1)
 Control BTRFS file data compression.  Type may be specified as 'zlib',
 'lzo', 'zstd' or 'no' (for no compression, used for remounting).  If no type
@@ -159,7 +159,7 @@  NOTE: If compression is enabled, 'nodatacow' and 'nodatasum' are disabled.
-(default: on)
+(default: datacow)
 Enable data copy-on-write for newly created files.
 'Nodatacow' implies 'nodatasum', and disables 'compression'. All files created
@@ -173,7 +173,7 @@  at the cost of potential partial writes, in case the write is interrupted
-(default: on)
+(default: datasum)
 Enable data checksumming for newly created files.
 'Datasum' implies 'datacow', ie. the normal mode of operation. All files created
@@ -221,7 +221,7 @@  system at that point.
-(default: off, async support since: 5.6)
+(default: nodiscard, async support since: 5.6)
 Enable discarding of freed file blocks.  This is useful for SSD devices, thinly
 provisioned LUNs, or virtual machine images; however, every storage layer must
@@ -246,7 +246,7 @@  of actually discarding the blocks.
-(default: off)
+(default: noenospc_debug)
 Enable verbose output for some ENOSPC conditions. It's safe to use but can
 be noisy if the system reaches near-full state.
@@ -267,7 +267,7 @@  parameters, eg. 'panic', 'oops' or 'crashkernel'.
-(default: off)
+(default: noflushoncommit)
 This option forces any data dirtied by a write in a prior transaction to commit
 as part of the current commit, effectively a full filesystem sync.
@@ -290,7 +290,7 @@  option 'BTRFS_DEBUG' is not enabled.
-(since: 3.0, default: off)
+(since: 3.0, default: noinode_cache)
 Enable free inode number caching. Not recommended to use unless files on your
 filesystem get assigned inode numbers that are approaching 2^64^. Normally, new
@@ -313,7 +313,7 @@  Alternatively, files with high inode numbers can be copied to a new subvolume
 which will effectively start the inode numbers from the beginning again.
-(default: off, even read-only)
+(default: logreplay, even read-only)
 The tree-log contains pending updates to the filesystem until the full commit.
 The log is replayed on next mount, this can be disabled by this option.  See