summaryrefslogtreecommitdiff
path: root/Documentation
Commit message (Collapse)AuthorAge
...
* btrfs-progs: docs: update formatting and wording for btrfs(5)David Sterba2017-04-20
| | | | | | | - emphasize features in the list - minor whitespace fixes Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: Fix newlines for man btrfstuneHans van Kranenburg2017-04-19
| | | | | | | | | | | | A bunch of newlines were missing, which resulted in only -S and -r to show as option after xmlto is used to convert the documentation to a man page. The rest of the options would end up being appended to the explanation of -r. Signed-off-by: Hans van Kranenburg <hans.van.kranenburg@mendix.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: Fix missing newline in man 5 btrfsHans van Kranenburg2017-04-19
| | | | | | | | The text compress_lzo:: would show up directly after 'bigger than the page size' on the same line. Signed-off-by: Hans van Kranenburg <hans.van.kranenburg@mendix.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: btrfs-replace, fix typoDavid Sterba2017-04-07
| | | | | | | Github pull request #39, from gabo77. Author: 3psus <gabo77@me.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: mount options, enhance ssd/nossdDavid Sterba2017-03-31
| | | | | Reported-by: Hans van Kranenburg <hans.van.kranenburg@mendix.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: fix many typos, plus three edits for clarityNicholas D Steeves2017-03-08
| | | | | Signed-off-by: Nicholas D Steeves <nsteeves@gmail.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: fix typo in btrfs-quotaJoey Sabey2017-03-08
| | | | | | qgruops -> qgroups Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: fix typo in btrfs-quotaJoey Sabey2017-03-08
| | | | | | reinstall ation -> reinstallation Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: fix typo in btrfs-scrub manual pageErik Logtenberg2017-03-08
| | | | | | | Changed "An" to "A". Signed-off-by: Erik Logtenberg <erik@logtenberg.eu> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: better document btrfs receive securityAustin S. Hemmelgarn2017-03-08
| | | | | | | | | | | | This adds some extra documentation to the btrfs-receive manpage that explains some of the security related aspects of btrfs-receive. The first part covers the fact that the subvolume being received is writable until the receive finishes, and the second covers the current lack of sanity checking of the send stream. Signed-off-by: Austin S. Hemmelgarn <ahferroin7@gmail.com> Suggested-by: Graham Cobb <g.btrfs@cobb.uk.net> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: fix typo in receive man pageJonathan Boulle2017-03-08
| | | | Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: build: remove unused variables from docs makefileDavid Sterba2017-03-08
| | | | Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: qgroup: add sync option to 'qgroup show'Tsutomu Itoh2017-01-25
| | | | | | | | | | | | The 'qgroup show' command does not synchronize filesystem. Therefore, 'qgroup show' may not display the correct value unless synchronized with 'filesystem sync' command etc. So add the '--sync' option so that we can choose whether or not to synchronize when executing the command. Signed-off-by: Tsutomu Itoh <t-itoh@jp.fujitsu.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: fix typo in btrfs-subvolumeEsteve Fernandez2017-01-25
| | | | Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: defrag: force using v2 defrag ioctl and make default 32M ↵David Sterba2017-01-25
| | | | | | | | | | | | threshold actually work A user reported on IRC that the new 32M default for target extent size does not work. This happens because if there are no commandline options, the v1 ioctl is used that does not do any fine grained defrag. As the v2 ioctl has been introduced 6 years ago (2010, kernel 2.6.33) we won't keep backward compatibility anymore. Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: Fix spelling/typos in user-facing stringsNicholas D Steeves2017-01-25
| | | | | Signed-off-by: Nicholas D Steeves <nsteeves@gmail.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: dev stats: update option name for checking non-zero statusDavid Sterba2016-12-14
| | | | | | Rename the option to -c|--check and update documentation. Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: update dev stats help and manual pageDavid Sterba2016-12-14
| | | | Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: dev stats: add long option for -zDavid Sterba2016-12-14
| | | | Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: dev stats: add dev stats returncode optionAustin S. Hemmelgarn2016-12-14
| | | | | | | | | | | | | | | | | | | Currently, `btrfs device stats` returns non-zero only when there was an error getting the counter values. This is fine for when it gets run by a user directly, but is a serious pain when trying to use it in a script or for monitoring since you need to parse the (not at all machine friendly) output to check the counter values. This patch adds an option ('-s') which causes `btrfs device stats` to set bit 6 in the return code if any of the counters are non-zero. This greatly simplifies checking from a script or monitoring software if any errors have been recorded. In the event that this switch is passed and an error occurs reading the stats, the return code will have bit 0 set (so if there are errors reading counters, and the counters which were read were non-zero, the return value will be 65). Signed-off-by: Austin S. Hemmelgarn <ahferroin7@gmail.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: fix typo in mkfs manual pageNoah Massey2016-12-14
| | | | | Signed-off-by: Noah Massey <noah.massey@gmail.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: man mkfs: warn about RAID5/6 being experimentalAdam Borowski2016-12-14
| | | | | Signed-off-by: Adam Borowski <kilobyte@angband.pl> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: clarify trim after mkfs -KDavid Sterba2016-12-14
| | | | | | A user question on IRC about mkfs -K and mount with discard. Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: update receive help and manual pageDavid Sterba2016-12-14
| | | | | | | | | | | Reword several option descriptions, add missing short option -E, formatting adjustments. Visual bug fix: the first line is printed in short help, the second line is long description, thus alternative calling syntax must be printed on one line. Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: receive: introduce option to dump send streamQu Wenruo2016-12-14
| | | | | | | | | | Introduce new option, '--dump' for receive subcommand. With this command, user can dump the metadata of a send stream. Which is quite useful for education purpose or bug reporting. Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: fix typo in btrfs-man5David Sterba2016-11-30
| | | | | | Reported via IRC. Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: Update README and other docsDavid Sterba2016-11-23
| | | | Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: document space_cache=v2 more thoroughlyOmar Sandoval2016-11-23
| | | | | Signed-off-by: Omar Sandoval <osandov@fb.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: implement btrfs check --clear-space-cache v2Omar Sandoval2016-11-23
| | | | | | | Reviewed-by: Qu Wenruo <quwenruo@cn.fujitsu.com> Signed-off-by: Omar Sandoval <osandov@fb.com> [ adjusted error messages ] Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: fix typo in btrfs-scrub manual pageDavid Sterba2016-11-23
| | | | | | Reported on IRC. Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: update mkfs help string and manual pageDavid Sterba2016-11-09
| | | | Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: check: add support to clear v1 free space cacheQu Wenruo2016-11-09
| | | | | | | | | | | | | | | | Kernel clear_cache mount option will only rebuild free space cache if the used space of that chunk has changed. So it won't ensure any corrupted free space cache get cleared. So add a new option "--clear-space-cache v1|v2" to btrfsck, to completely wipe out free space cache. So kernel won't complain again. Reported-by: Ivan P <chrnosphered@gmail.com> Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com> [ adjusted error messages, doc wording changes ] Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: fix user-facing typos in docs and help stringsNicholas D Steeves2016-10-03
| | | | | Signed-off-by: Nicholas D Steeves <nsteeves@gmail.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: document exit codes from scrubAdam Borowski2016-10-03
| | | | | Signed-off-by: Adam Borowski <kilobyte@angband.pl> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: convert: check source file system stateLakshmipathi.G2016-10-03
| | | | | | Signed-off-by: Lakshmipathi.G <Lakshmipathi.G@giis.co.in> [ add doc note ] Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: fix typos in btrfs-subvolumeadduxa2016-09-21
| | | | | [ Documentation fix, github pull request 16 ] Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: update flushoncommit default valueDavid Sterba2016-09-21
| | | | Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: Add warning for build RAID btrfs on partions from the ↵Qu Wenruo2016-09-21
| | | | | | | | | same device Quite a common sense for any RAID-like multi-device setup, just in case. Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: mkfs: Warn user for minimal RAID5/6 devices setupQu Wenruo2016-09-21
| | | | | | | | | | | For RAID5, 2 devices setup is just RAID1 with more overhead. For RAID6, 3 devices setup is RAID1 with 3 copies, not what most user want. So warn user at mkfs time for such case, and add explain in man pages. Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: dump-super: changes in options to specify superblocksDavid Sterba2016-09-21
| | | | | | | | | | | | Some tools (check, select-super, dump-super) can use the alternate superblocks, but the options are not consistent. To make it less confusing, change the meaning of option -s in 'dump-super' to specify the superblock copy, instead of taking the offset. Though this is a change in UI, the old usage is detected and the result would be the same, no breakage in existing scripts. Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: describe filesystem featuresDavid Sterba2016-09-05
| | | | Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: refer to btrfs(5) from btrfs(8)David Sterba2016-08-18
| | | | Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: update btrfs-quota manual page, more sectionsDavid Sterba2016-08-18
| | | | | | Add more overall sections. Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: update btrfs-quota manual pageDavid Sterba2016-08-18
| | | | | | | | | | Copy the intoductory and usecases from the text written by Arne Jansen, https://git.kernel.org/cgit/linux/kernel/git/arne/qgroups-doc.git/ The graphics missing for now. Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: check: adjust command line options for the low-memory modeDavid Sterba2016-08-17
| | | | | | | | Change the single-purpose option --low-memory to a generic option that takes the mode. Currently supported are the original mode and the low-memory in the same way. Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: check: introduce low memory modeLu Fengqi2016-08-17
| | | | | | | | | | | | | | | | | | | | | | | Introduce a new fsck mode: low memory mode. Old btrfsck is working efficiently but uses some memory for each extent item. This method will ensure extents are only iterated once at extent/chunk tree check process. But since it uses some memory for each extent item, for a large fs with several TB metadata, this can easily eat up memory and cause OOM. To handle such limitation and improve scalability, the new low-memory mode will not use any heap memory to record which extent is checked. Instead it will use extent backref to avoid most of uneeded checks on shared fs/subvolume tree blocks. And with the use forward and backward reference cross check, we can also ensure every tree block is at least checked once. Signed-off-by: Lu Fengqi <lufq.fnst@cn.fujitsu.com> Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com> Reviewed-by: Josef Bacik <jbacik@fb.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: fi defrag: change default extent target size to 32 MiBDavid Sterba2016-07-28
| | | | | | | The kernel default is too low, 32 MiB is recommended and should give better results. Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: Doc: Fix format error in btrfs-sendQu Wenruo2016-07-28
| | | | | Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: update btrfs-balance manual pageDavid Sterba2016-07-28
| | | | | | Update the new options. Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: add option to run balance as daemonAustin S. Hemmelgarn2016-07-26
| | | | | | | | | | | | | | | | | | | | Currently, balance operations are run synchronously in the foreground. This is nice for interactive management, but is kind of crappy when you start looking at automation and similar things. This patch adds an option to `btrfs balance start` to tell it to daemonize prior to running the balance operation, thus allowing us to preform balances asynchronously. The two biggest use cases I have for this are starting a balance on a remote server without establishing a full shell session, and being able to background the balance in a recovery shell (which usually has no job control) so I can still get progress information. Because it simply daemonizes prior to calling the balance ioctl, this doesn't actually need any kernel support. Signed-off-by: Austin S. Hemmelgarn <ahferroin7@gmail.com> Signed-off-by: David Sterba <dsterba@suse.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-16 07:23:59 +0000