summaryrefslogtreecommitdiff
path: root/Documentation
Commit message (Collapse)AuthorAge
* btrfs-progs: restore: add more long option variantsDavid Sterba2015-05-14
| | | | Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: optionally restore symlinks.Dan Merillat2015-05-14
| | | | | | | Restore symlinks, optionally with owner/times. Signed-off-by: Dan Merillat <dan.merillat@gmail.com> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: fix typos in restore help/docDavid Sterba2015-04-24
| | | | Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: restore: document metadata restore.Dan Merillat2015-04-24
| | | | | | | This was lost in the cleanup of 71a559 Signed-off-by: Dan Merillat <dan.merillat@gmail.com> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: optionally enforce chroot for btrfs receiveLauri Võsandi2015-04-24
| | | | | | | | | | | This patch forces btrfs receive to issue chroot before parsing the btrfs stream using command-line flag -C to confine the process and minimize damage that could be done via malicious btrfs stream. Signed-off-by: Lauri Võsandi <lauri.vosandi@gmail.com> [added long option variant, added docs] Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: fix typo in btrfs-device.txtAnand Jain2015-04-24
| | | | Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: add zero-log to rescue commandDavid Sterba2015-04-22
| | | | | | | | Copy the functionality of standalone btrfs-zero-log to the main tool. Delete man page for btrfs-zero-log and copy the relevant parts into btrfs-rescue(8). The standalone utility will be removed later. Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: fi resize: accept only directories as pathsDavid Sterba2015-04-22
| | | | | | | | Resize of a filesystem image does not work as expected. This has been confusing and can have bad consequences as people have reported, resizing the wrong filesystem. Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: Documentaion: rename to .asciidocDavid Sterba2015-04-14
| | | | | | | | | | | | | A few minor benefits: * editors set highliting according to the extensions * web access to the git repository (github) renders the .asciidoc files: * we can link to them from the wiki * the files are editable via browser and such editations can be submitted for merge easily Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: Doc: Add warning and note on btrfs-convert.Qu Wenruo2015-04-07
| | | | | | | | | | | | | | | Although btrfs-convert can rollback converted btrfs, it still has some limitation to ensure rollback. Add a warning on the limitations. Also add a note for users who decides to go on with btrfs and don't need the rollback ability. Reported-by: Vytautas D <vytdau@gmail.com> Reported-by: Tsutomu Itoh <t-itoh@jp.fujitsu.com> Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs doc: emphasis that only mounted device works for btrfs device statsChen Hanxiao2015-04-02
| | | | | | | | | | We provided format <path>|<device> in command line. But btrfs device stats doesn't work if device is not mounted. Also fix some tailing whitespace. Signed-off-by: Chen Hanxiao <chenhanxiao@cn.fujitsu.com> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: convert, add long options for all short optionsDavid Sterba2015-03-24
| | | | Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: btrfs-convert: Allow setting nodesizeSebastian Thorarensen2015-03-23
| | | | | | | | Allow btrfs-convert to use nodesizes other than 4096. It defaults to max(16384, pagesize), like mkfs. Signed-off-by: Sebastian Thorarensen <sebth@naju.se> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: convert, add option to disable progressDavid Sterba2015-03-09
| | | | | | | | With progress turned on by default we should be able to disable it as well. Reported-by: Jérôme Poulin <jeromepoulin@gmail.com> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: doc: clarify toplevel subvolidShriramana Sharma2015-02-27
| | | | | Signed-off-by: Shriramana Sharma <samjnaa@gmail.com> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: convert: show progress by defaultDavid Sterba2015-02-27
| | | | | | | Agreed by several people, showing progress by default makes sense as conversion is a one-time and long running action. Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: docs: fixed a grammar mistakeStefan Tatschner2015-02-24
| | | | | Signed-off-by: Stefan Tatschner <stefan@sevenbyte.org> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: find-root, add option to search through all the metadata extentsQu Wenruo2015-02-11
| | | | | | | | Add option '-a' for btrfs-find-root to iterate all the metadata extents even the root is already found. Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: autoconf: detect tools to build docsDavid Sterba2015-02-03
| | | | Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: build, fix version macro nameDavid Sterba2015-02-03
| | | | | | Autoconf changed it to PACKAGE_VERSION and moved to config.h. Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: autoconf: use variable substitutions in doc makefileDavid Sterba2015-02-03
| | | | Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: autoconf: generate documentation makefile as wellDavid Sterba2015-02-03
| | | | | | This is plain move to .in. Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: build, fix rules to clean temporary files in docsDavid Sterba2015-02-03
| | | | | | | | | | | | | | | | | $ make clean-doc Cleaning Documentation /usr/bin/rm: cannot remove ‘*.xml’: No such file or directory /usr/bin/rm: cannot remove ‘*.xml+’: No such file or directory /usr/bin/rm: cannot remove ‘*.5’: No such file or directory /usr/bin/rm: cannot remove ‘*.8’: No such file or directory make[1]: *** [clean] Error 1 make: *** [clean-doc] Error 2 The RM variable from parent makefile lacks -f, add it where it's missing. Minor change in LN_S variable name, same -f change. Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: update wording for qgroup limitsDavid Sterba2015-01-27
| | | | | | | Based on a user report, 'max' in help does not clearly point to the limits that are commonly used as a quota-related term. Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: add --human-readable option where applicableDavid Sterba2015-01-21
| | | | | | | Add an alias to -h to 'filesystem usage', 'filesystem df' and 'device usage' commands, same as the traditional 'df'. Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: make btrfs qgroups show human readable sizesFan Chengniang2015-01-21
| | | | | | | | | | | | | | | | add --raw, --si, --iec, --kbytes, --mbytes, --gbytes, --tbytes options make columns which show sizes align to right. Others aligned to left. example: qgroupid rfer excl max_rfer max_excl parent child -------- ---- ---- -------- -------- ------ ----- 0/5 299.58MiB 299.58MiB 300.00MiB 300.00MiB 1/1 --- 0/265 299.58MiB 16.00KiB 400.00MiB 0.00B 1/1 --- 0/266 299.58MiB 16.00KiB 350.00MiB 0.00B --- --- 1/1 599.16MiB 299.59MiB 800.00MiB 0.00B --- 0/5,0/265 Signed-off-by: Fan Chengniang <fancn.fnst@cn.fujitsu.com> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: Doc: Add explain on 'source' and 'target' for btrfs-image.Qu Wenruo2015-01-21
| | | | | | | | | Add explain on 'source' and 'target', which is somewhat confusing for users who want to restore dumped image. Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com> [reworded texts] Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: btrfstune: force to set seeding flagsFan Chengniang2015-01-19
| | | | | | | | | | Now we can use -f with -S option when setting seeding flags or clearing seeding flags Reported-by: Chen Hanxiao <chenhanxiao@cn.fujitsu.com> Signed-off-by: Fan Chengniang <fancn.fnst@cn.fujitsu.com> [updated docs] Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: add missing options to qgroup limitFan Chengniang2015-01-14
| | | | | | | | btrfs qgroup limit has two options -c and -e,. They were forgotten to add to manpage. Signed-off-by: Fan Chengniang <fancn.fnst@cn.fujitsu.com> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: fix some format errors in docFan Chengniang2015-01-09
| | | | | Signed-off-by: Fan Chengniang <fancn.fnst@cn.fujitsu.com> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: doc: fix format of btrfs-replaceTsutomu Itoh2015-01-09
| | | | | | | | | | | | | | | | | | | | | | | | Current 'man btrfs-replace' is as follows: ======================================================================== ... ... -f force using and overwriting <targetdev> even if it looks like containing a valid btrfs filesystem. A valid filesystem is assumed if a btrfs superblock is found which contains a correct checksum. Devices which are currently mounted are never allowed to be used as the <targetdev>. -B:::: no background replace. ... ... ======================================================================== The format of 'B' option is wrong. So, fix it. Signed-off-by: Tsutomu Itoh <t-itoh@jp.fujitsu.com> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: Documentation: fix broken conversionPeter Wu2015-01-09
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Fixes various formatting issues: Fixes quoting issues in various manpages. Before/After excerpts for mkfs.btrfs(8), btrfs-qgroup(8): mkfs.btrfs [-A|--alloc-start '<alloc-start>'] mkfs.btrfs [-A|--alloc-start <alloc-start>] id 0/<subvolume id>'' id 0/<subvolume id> If multiple '<attr>'s is given, use comma to separate. If multiple <attr>s is given, use comma to separate. The one that is most apparent is the removal of text in btrfs-subvolume(8) and others. Before/After: list [options] [-G <value>] [-C <value>] [--sort=rootid,gen,ogen,path] <path> list [options] [-G [+|-]<value>] [-C [+|-]<value>] [--sort=rootid,gen,ogen,path] <path> create [-i <qgroupid>] <name> create [-i <qgroupid>] [<dest>]<name> This happens because `<foo>` was replaced by `'<foo>'` in the sed expression, which is then treated as a constrained quote. As a result, the `[...]` before the string gets interpreted as "quoted text attributes". In this patch, the sed expression is dropped and asciidoc is configured to recognize `<...>` as a unconstrained quoted string (such that `<attr>s` is correctly emphasized) and to avoid adding quotes in contexts where it is not needed. A remaining problem is that some texts (the one between brackets) do not add the emphasis for `<...>`. While this could be solved by replacing `[` and `]` with `&#91;` and `&#93;` using sed, it introduces formatting problems in btrfs-zero-log(8) because the context is ignored. Signed-off-by: Peter Wu <peter@lekensteyn.nl> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: doc subvolume, sort subcommands alphabeticallyDavid Sterba2015-01-03
| | | | Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: doc scrub, sort subcommands alphabeticallyDavid Sterba2015-01-03
| | | | Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: doc replace, sort subcommands alphabeticallyDavid Sterba2015-01-03
| | | | Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: doc quota, sort subcommands alphabeticallyDavid Sterba2015-01-03
| | | | Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: doc qgroup, sort subcommands alphabeticallyDavid Sterba2015-01-03
| | | | Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: doc property, sort subcommands alphabeticallyDavid Sterba2015-01-03
| | | | Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: doc inspect-internal, sort subcommands alphabeticallyDavid Sterba2015-01-03
| | | | Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: doc device, sort subcommands alphabeticallyDavid Sterba2015-01-03
| | | | Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: doc, undocument old balance syntaxDavid Sterba2015-01-03
| | | | | | Standalone balance subcommand has been around since 3.3. Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: doc balance, sort subcommands alphabeticallyDavid Sterba2015-01-03
| | | | Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: doc filesystem, sort subcommands alphabeticallyDavid Sterba2015-01-03
| | | | Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: doc btrfs, sort subcommands alphabeticallyDavid Sterba2015-01-03
| | | | Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: doc restore, cleanups for wiki conversionDavid Sterba2015-01-03
| | | | | | Properly format the patch regex and add a line break. Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: doc filesystem, cleanups for wiki conversionDavid Sterba2015-01-03
| | | | | | Remove trailing space, add line break before NOTE. Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: doc balance, cleanups for wiki conversionDavid Sterba2015-01-03
| | | | Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: doc mkfs, cleanups for wiki conversionDavid Sterba2015-01-03
| | | | | | | - remove trailing whitespace - use +mono+ formatting for command line example Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: doc mkfs, mark leafsize deprecatedDavid Sterba2015-01-03
| | | | Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: doc: fix incorrect format of 'l' option in mkfs.btrfsTsutomu Itoh2015-01-03
| | | | | | | | | | | | | | | | | | | The format of 'l' option in mkfs.btrfs.txt is wrong. And, when the head of the character string is 65536, the following warning is displayed. $ make Making all in Documentation [ASCII] mkfs.btrfs.xml asciidoc: WARNING: mkfs.btrfs.xml.tmp1: line 67: list item index: expected 1 got 65536 [XMLTO] mkfs.btrfs.8 [GZ] mkfs.btrfs.8.gz rm mkfs.btrfs.8 mkfs.btrfs.xml So, fix it. Signed-off-by: Tsutomu Itoh <t-itoh@jp.fujitsu.com> Signed-off-by: David Sterba <dsterba@suse.cz>
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-20 10:13:41 +0000