summaryrefslogtreecommitdiff
path: root/Documentation
Commit message (Collapse)AuthorAge
* btrfs-progs: docs: update btrfs-convert regarding reiserfsDavid Sterba2017-09-08
| | | | Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: add figure 1 to btrfs quota docMisono, Tomohiro2017-08-24
| | | | | | | | | | The document of btrfs quota is missing figure 1. I notice the body is copy of http://sensille.com/qgroups.pdf (which is linked from https://btrfs.wiki.kernel.org/index.php/Quota_support), and insert the figure. Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: add missing short option for qroup-reportMisono, Tomohiro2017-08-24
| | | | | | | | | | Usage info of "btrfs check" shows "-Q|--qgroup-report" (and first patch enables -Q), but the document only shows "--qgroup-report". Therefore add -Q to the doc. Signed-off-by: Tomohiro Misono <misono.tomohiro@jp.fujitsu.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: Doc: Fix asciidoc grammar of btrfs-rescueQu Wenruo2017-08-24
| | | | | | | | | | | | | | | | | | | | | | | | | | | Code block of kernel backtrace lacks leading change line, causing the following man page result: ------ One can determine whether zero-log is needed according to the kernel backtrace: ? replay_one_dir_item+0xb5/0xb5 [btrfs] ? walk_log_tree+0x9c/0x19d [btrfs] ? btrfs_read_fs_root_no_radix+0x169/0x1a1 [btrfs] ? btrfs_recover_log_trees+0x195/0x29c [btrfs] ? replay_one_dir_item+0xb5/0xb5 [btrfs] ? btree_read_extent_buffer_pages+0x76/0xbc [btrfs] ? open_ctree+0xff6/0x132c [btrfs] + If the errors are like above, then zero-log should be used to clear the log and the filesystem may be mounted normally again. The keywords ------ Not only "+" is rendered as is, but also wrong indent. Fix it by adding change line before code block. Signed-off-by: Qu Wenruo <quwenruo.btrfs@gmx.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: update wording for compression mount optionsDavid Sterba2017-07-24
| | | | Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: adjust wording for subvol deleteDavid Sterba2017-07-20
| | | | | | Slightly update the text about deletion after the discussion on IRC. Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: enhance documentation of 'btrfs device ready'David Sterba2017-07-20
| | | | | | | | There were questions raised about the purpose of the 'dev ready' command. Link: https://marc.info/?l=linux-btrfs&m=149944574207325 Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: move deprecated mount option to own sectionDavid Sterba2017-07-20
| | | | | | | | - alloc_start - recovery - subvolrootid Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: document conventionsDavid Sterba2017-07-03
| | | | Signed-off-by: David Sterba <dsterba@suse.com>
* Btrfs-progs: man: nodesize must be power of 2 nowLiu Bo2017-06-30
| | | | | | | | This updates mkfs.btrfs's man page with the new limitation that nodesize must be a power of 2 as well. Signed-off-by: Liu Bo <bo.li.liu@oracle.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: replace <dev> with <device>Kasijjuf2017-06-26
| | | | | | | | As discussed in #50, use 'device' everywhere a path do a device is expected. Pull request: #52 Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: Wrong section in ref to manpageKasijjuf2017-06-26
| | | | | Pull request: #51 Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: Expand confusing abbreviation in documentationKasijjuf2017-06-26
| | | | | | | | While the command interpreter may be able to disambiguate the meaning, the reader is not helped by being forced to do so. Pull request: #48 Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: update note about device deletionDavid Sterba2017-06-26
| | | | | | | | | User Kasijjuf points out the VFS initialism is not explained anywhere. While this could be fixed, the whole note about inability to delete the device by which the filesystem has been mounted, is wrong. Issue: #49 Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: send operates on ro snapshots onlyHans van Kranenburg2017-06-26
| | | | | | | | | | | | | | | While talking to another btrfs user on IRC today, it became clear that a major point of confusion in the btrfs send manual is that it's not telling the user soon enough that send/receive solely operates on subvolume snapshots instead of the original (read/write) subvolumes. So, change the first few lines to explicitly mention snapshots instead. Technically, snapshots are also just subvolumes, but requiring this level of technical detailed knowledge doesn't help the user who is just trying out things. Signed-off-by: Hans van Kranenburg <hans.van.kranenburg@mendix.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: fix sentence for no-dump file attributeDavid Sterba2017-06-26
| | | | | | | User Kasijjuf found a nonsensical sentence in the maunal page. Issue: #45 Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: update formatting of btrfs-propertyDavid Sterba2017-06-26
| | | | | | | | | | | | Reported by a wiki user, that there are formatting artifacts in the 'get' section: in html rendered as "The -t <em><type></em> option can be..." This is probably due to the nesting '' and <>. We don't need the <> in the explanation, as this is only to describe the command line syntax. Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: update formatting of btrfs-rescueDavid Sterba2017-06-26
| | | | | | | Reported by a wiki user, that the 'zero-log' section indentaion is wrong. Signed-off-by: David Sterba <dsterba@suse.com>
* 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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-19 13:13:29 +0000