summaryrefslogtreecommitdiff
path: root/Documentation
Commit message (Collapse)AuthorAge
* btrfs-progs: docs: update document about option -R of btrfs-scrubSu Yue2018-10-23
| | | | | | | | | | | | | The option '-R' of btrfs-scrub was documented by mistake as 'print raw statistics per-device instead of a summary'. Here change it to 'raw print mode, print full data instead of summary' which it works actually. Fixes: 162257574a56 ("btrfs-progs: docs: update btrfs-scrub") Reported-by: Chris Murphy <chris@colorremedies.com> Signed-off-by: Su Yue <suy.fnst@cn.fujitsu.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: doc: Update man 5 btrfs for 4.18Misono Tomohiro2018-08-06
| | | | | | | | | | | | | | | Update the information to reflect the status of 4.18 Main Updates: - Add explanation of improved compression heuristic algorithm - Add explanation that norecovery == nologreplay - Add explanation of nossd_spread mount option - Add explanation of rmdir_subovl feature Signed-off-by: Misono Tomohiro <misono.tomohiro@jp.fujitsu.com> [ minor updates ] Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: Remove deprecated btrfs-show-superNikolay Borisov2018-04-24
| | | | | | | | | | | Its function has been superseded by btrfs inspect-internal show-super. Furthermore the tools is currently not built by default. Just remove it. Deprecated since 4.8. Issue: #97 Signed-off-by: Nikolay Borisov <nborisov@suse.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: Remove deprecated btrfs-zero-log standalone toolNikolay Borisov2018-04-24
| | | | | | | | | | | Its function has been subsumed by "btrfs rescue zero-log". Remove its source file and adjust make/tests soruces accordingly. Deprecated since 4.0. Issue: #97 Signed-off-by: Nikolay Borisov <nborisov@suse.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: Remove btrfs-debug-tree commandNikolay Borisov2018-04-24
| | | | | | | | | | | | | There is already a replacement in the face of btrfs inspect-internal dump-tree. And this command is just a simple wrapper around it. Just remove it and adjust the show-blocks script to call the main btrfs binary to achieve the same effect. Informally deprecated since 4.4. Issue: #97 Signed-off-by: Nikolay Borisov <nborisov@suse.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: fix typosDavid Sterba2018-03-31
| | | | | | | | A few more typo fixes, merged with the pull request. Pull-request: #120 Signed-off-by: Gu Jinxiang <gujx@cn.fujitsu.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: dump-tree: add option to print children nodes of a given blockQu Wenruo2018-03-30
| | | | | | | | | | | | | | | | When debuging with "btrfs inspect dump-tree", it's not that handy if we want to iterate all child tree blocks starting from a specified block. -b can only print a single block, while without -b "btrfs inspect dump-tree" will need extra tree roots fulfilled to continue, which is not possible for a damaged filesystem. Add a new option --follow to iterate a sub-tree starting from block specified by --block. Signed-off-by: Qu Wenruo <wqu@suse.com> [ remove the short option for now ] Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: Fix typos in docs and user-facing stringsNicholas D Steeves2018-03-30
| | | | | Signed-off-by: Nicholas D Steeves <nsteeves@gmail.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: add section about filesystem limits to btrfs(5)David Sterba2018-03-30
| | | | Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: build: add support for asciidoctor doc generatorDavid Sterba2018-02-02
| | | | | | | | | | | | | | | | | | | | | We've been using asciidoc that's written in python2, which is going to be phased out and deprecated next year. There's a replacement, asciidoctor. Add a configure-time detection which tool is available, update Documentation/Makefile.in. The original asciidoc tool is still preferred as it produces slightly better output. The file asciidoc.conf does not have a direct equivalten in asciidoct and would need to be replaced by extension written in ruby. The differences: - the <literal> are not automatically underlined and are less visible in the generated manual page, but it's still acceptable - the inline CSS for the html output looks subjectively worse, is less compact and colourful Issue: #89 Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: fix manual page title formatDavid Sterba2018-02-02
| | | | | | | Asciidoctor is more strict about the formatting for the manual pages and needs exact number of =. Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: fix typo in btrfs-filesystem manual pageWilliam Giokas2018-01-31
| | | | | | Pull-request: #86 Signed-off-by: William Giokas <1007380@gmail.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: clean all generated filesDavid Sterba2018-01-31
| | | | | | The section 3 manual page btrfs-ioctl was not deleted. Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: update manual for mkfs --shrinkDavid Sterba2018-01-08
| | | | Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: mkfs: Separate shrink from rootdirQu Wenruo2018-01-08
| | | | | | | | | | | | | Make --shrink a separate option for --rootdir, and change the default to off. The shrinking behaviour is not a commonly used feature but can be useful for creating minimal pre-filled images, in one step, without requiring to mount. Signed-off-by: Qu Wenruo <wqu@suse.com> [ update changelog and error messages ] Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: annual typo, clarity, & grammar review & fixupsNicholas D Steeves2018-01-03
| | | | | Signed-off-by: Nicholas D Steeves <nsteeves@gmail.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: fix typo in btrfs-man5Faalagorn2018-01-03
| | | | | | Pull-request: #81 Author: Faalagorn <faalagorn@gmail.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: make option -A of mkfs less visibleDavid Sterba2018-01-03
| | | | | | | The option will be removed in the future, move it to the end of the list. Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: update btrfs-subvolume manual pageHoward2018-01-03
| | | | | | | | | To simplify, I suggest moving the 'writable/readonly' issue only to the -r line, instead of having it introduced in two places. Pull-request: #80 Author: Howard <hwj@BridgeportContractor.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: move the rescue fix-device-size command and updateDavid Sterba2017-11-14
| | | | | | | The subcommands are supposed to be in alphabetical order, move it to the right spot and reword. Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: add note about mount option applicabilityDavid Sterba2017-11-14
| | | | | | Copied from https://btrfs.wiki.kernel.org/index.php/Mount_options . Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: add impact of atime/noatimeDavid Sterba2017-11-14
| | | | | | | Copy from wiki https://btrfs.wiki.kernel.org/index.php?title=Mount_options Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: update mount optionsDavid Sterba2017-11-14
| | | | | | Enhance the text, update for 4.14, sync with existing wiki page. Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: correct grammarBenjamin Peterson2017-11-14
| | | | | Signed-off-by: Benjamin Peterson <bp@benjamin.pe> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: rescue: Introduce fix-device-sizeQu Wenruo2017-11-14
| | | | | | | | | | | | | Introduce new subcommand 'fix-device-size' to the rescue group, to fix device size alignment-related problems. Especially for people unable to mount their fs with super::total_bytes mismatch, this tool will fix the problems and let the mount continue. Reported-by: Asif Youssuff <yoasif@gmail.com> Reported-by: Rich Rauenzahn <rrauenza@gmail.com> Reviewed-by: Nikolay Borisov <nborisov@suse.com> Signed-off-by: Qu Wenruo <wqu@suse.com>
* btrfs-progs: doc: add description of missing and example, of device removeMisono, Tomohiro2017-11-14
| | | | | | | | | | | | | | | | | This patch updates help/document of "btrfs device remove" in two points: 1. Add explanation of 'missing' for 'device remove'. This is only written in wikipage currently. (https://btrfs.wiki.kernel.org/index.php/Using_Btrfs_with_Multiple_Devices) 2. Add example of device removal in the man document. This is because that explanation of "remove" says "See the example section below", but there is no example of removal currently. Signed-off-by: Tomohiro Misono <misono.tomohiro@jp.fujitsu.com> Reviewed-by: Satoru Takeuchi <satoru.takeuchi@gmail.com> [ move "" from the macro to help strings ] Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: update btrfs-propertiesDavid Sterba2017-11-14
| | | | Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: prop: also allow "none" to disable compressionDavid Sterba2017-11-14
| | | | | | | | Some people were asking why disabling compression via properties is not set by "none" instead. As this is purely userspace conversion to "" that kernel accepts, let's add "none" as well for convenience. Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: allow "no" to disable compression for convenienceSatoru Takeuchi2017-11-14
| | | | | | | | | It's messy to use "" to disable compression. Introduce the new value "no" which can also be used for this purpose. Signed-off-by: Satoru Takeuchi <satoru.takeuchi@gmail.com> [ coding style fixes ] Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: subvol: change set-default to also accept pathMisono, Tomohiro2017-11-14
| | | | | | | | | | | | | | | | | | This patch changes "subvol set-default" to also accept the subvolume path for convenience. If there are two args, they are assumed as subvol id and path to the fs (the same as current behavior), and if there is only one arg, it is assumed as the path to the subvolume. subvol id is resolved by test_issubvolume() + lookup_path_rootid(). The empty subvol (ino == 2) will get error on test_issubvolume() which checks whether inode num is 256 or not. Issue: #35 Signed-off-by: Tomohiro Misono <misono.tomohiro@jp.fujitsu.com> [ update documentation, use the new multi-line command scheme ] Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: update btrfs-balanceDavid Sterba2017-10-06
| | | | | | | | Copy unexpected edits from wiki so they do not get lost at next git->wiki sync. Author: Bill S. Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: docs: start ioctl documentation manual pageDavid Sterba2017-09-25
| | | | | | | | | | | | Start documenting the ioctl interface to btrfs. The overall structure should be settled, the formatting of the ioctl description may change in the future, newly added ioctl descriptions should follow the examples of BTRFS_IOC_SUBVOL_CREATE. The document is not finished yet and will not be installed until most of ioctls' details are filled in. Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: Add zstd supportNick Terrell2017-09-25
| | | | | | | | | | | | | | | | Adds zstd support to the btrfs program. An optional dependency on libzstd >= 1.0.0 is added. Autoconf accepts `--enable-zstd' or `--disable-zstd' and defaults to detecting if libzstd is present using `pkg-config'. The patch is also available in my fork of btrfs-progs [1], which passes Travis-CI with the new tests. The prebuilt binary is available there. I haven't updated Android.mk. [1] https://github.com/terrelln/btrfs-progs/tree/devel Signed-off-by: Nick Terrell <terrelln@fb.com> Signed-off-by: David Sterba <dsterba@suse.com>
* btrfs-progs: check: add option to skip mount checksDavid Sterba2017-09-08
| | | | | | | | | | | Sometimes it's needed to do a check on a mounted filesystem. This should work fine on a quiescent filesystem or a read-only mount. Changes on the block device done by kernel might confuse the userspace checker and it might crash when it reads some stale data. Repair without mount checks is not supported right now. Signed-off-by: David Sterba <dsterba@suse.cz>
* 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>