summaryrefslogtreecommitdiff
path: root/Documentation
Commit message (Collapse)AuthorAge
...
* 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>
* btrfs-progs: doc filesystem, add unit suffixes to option descriptionsDavid Sterba2015-01-03
| | | | | Reported-by: Chris Murphy <lists@colorremedies.com> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: doc filesystem, fix quoting of size suffixesDavid Sterba2015-01-03
| | | | | | | Escape the first quote of two to cancel effects of ordinary '...' . Reported-by: Chris Murphy <lists@colorremedies.com> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: Documentation: add T/P/E description for resize cmdGui Hecheng2014-12-30
| | | | | | Signed-off-by: Gui Hecheng <guihc.fnst@cn.fujitsu.com> Reviewed-by: Satoru Takeuchi <takeuchi_satoru@jp.fujitsu.com> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: Enhance the document of btrfs propertySatoru Takeuchi2014-12-19
| | | | | | | | | | | | Enhance the document of btrfs property as follows. - Add the description about the candidates of <name>. - Enrich the description of <object>. - Fix typos and some redundancy. Signed-off-by: Satoru Takeuchi <takeuchi_satoru@jp.fujitsu.com> Reported-by: Naohiro Aota <naota@elisp.net> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: check, update documentationDavid Sterba2014-12-18
| | | | | | Add recently added options to manpage, a few other rewordings. Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: dev usage, update manpageDavid Sterba2014-12-18
| | | | Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: fi usage, update manpageDavid Sterba2014-12-18
| | | | Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: Add a brief explanation of btrfs property in man 8 btrfsSatoru Takeuchi2014-12-17
| | | | | | | | | | | | As Chris reported at the following mail, although btrfs property has its own manpage, man 8 btrfs-property, there is no explanation about it in man 8 btrfs. https://www.mail-archive.com/linux-btrfs@vger.kernel.org/msg40134.html Signed-off-by: Satoru Takeuchi <takeuchi_satoru@jp.fujitsu.com> Reported-by: Chris Murphy <lists@colorremedies.com> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: convert: use task for progress indication of metadata creationSilvio Fricke2014-12-04
| | | | | Signed-off-by: Silvio Fricke <silvio.fricke@gmail.com> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: use the correct SI prefixesDavid Sterba2014-11-04
| | | | | | The SI standard defines lowercase 'k' and uppercase for the rest. Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: Fix the argument requirement for '--subvol-extents'Qu Wenruo2014-11-03
| | | | | | | | | | | | | The following commit changed the argument requirement for '--subvol-extents', which causes it to call arg_strtou64() on NULL, resulting a segfault. d34cbe76 btrfs-progs: check: do not require argument for --subvol-extents This patch revert the patch and change the help string and man page to make it no longer confusing. Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: document the limit balance filterDavid Sterba2014-10-10
| | | | Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: convert: set label or copy from originDavid Sterba2014-10-10
| | | | Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: add options to tune units for fi df outputDavid Sterba2014-10-10
| | | | | | | | | | | | | The size unit format is a longstanding annoyance. This patch is based on the work of Nils and Alexandre and enhances the options. It's possible to select raw bytes, SI-based or IEC-based compact units (human frientdly) or a fixed base from kilobytes to terabytes. The default is compact human readable IEC-based, no change to current version. CC: Nils Steinger <nst@voidptr.de> CC: Alexandre Oliva <oliva@gnu.org> Reviewed-by: Hugo Mills <hugo@carfax.org.uk> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: wait until all subvolumes are cleanedDavid Sterba2014-10-10
| | | | | | | | Enhance the 'subvolume' subcommand to wait until a given list of subvolumes or all currently scheduled for deletion are cleaned completely from the filesystem. Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: fix typo in subvol list usageDavid Disseldorp2014-10-01
| | | | | | Signed-off-by: David Disseldorp <ddiss@suse.de> [moved to new asciidoc] Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: update manpage with new option -f for btrfstuneGui Hecheng2014-10-01
| | | | | | | | | The new option -f will force to do dangerous changes. e.g. clear the seeding flag. Signed-off-by: Gui Hecheng <guihc.fnst@cn.fujitsu.com> [more text from 3db4c0a3d35dd5f8 changelog] Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: fix many typos in documentsNaohiro Aota2014-10-01
| | | | | | | | | | | There are many trivial typos in Documentation/*.txt. All of these use "exist status" to mean "exit status" by mistake. I guess someone first made this mistake and it has spread by copy-and-paste :-D Signed-off-by: Naohiro Aota <naota@elisp.net> Signed-off-by: Satoru Takeuchi <takeuchi_satoru@jp.fujitsu.com> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: doc: fix invalid reference to setattr(8)Naohiro Aota2014-09-14
| | | | | | | | | man 8 btrfs-property refers to `setattr(8)` which does not actually exist. It should refer to `chattr (1)` instead. Signed-off-by: Naohiro Aota <naota@elisp.net> Reviewed-by: Qu Wenruo <quwenruo@cn.fujitsu.com> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: Add -R to list UUIDs of original received subvolumeHugo Mills2014-09-14
| | | | | | | | | | | When using send/receive, it it useful to be able to match up source subvols on the send side (as, say, for -p or -c clone sources) with their corresponding copies on the receive side. This patch adds a -R option to btrfs sub list to show the received subvolume UUID on the receive side, allowing the user to perform that matching correctly. Signed-off-by: Hugo Mills <hugo@carfax.org.uk> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: add missing descriptions of '--max-errors' in btrfs-receive ↵Satoru Takeuchi2014-08-22
| | | | | | | | | | documentation Fix the lack of description of "--max-erros" option in both man and command usage of btrfs receive. Signed-off-by: Satoru Takeuchi <takeuchi_satoru@jp.fujitsu.com> Signed-off-by: David Sterba <dsterba@suse.cz>
* Btrfs-progs: remove author and copyright info from man pageWang Shilong2014-08-22
| | | | | | | | | | | | | | | | | | | >From: http://man7.org/linux/man-pages/man7/man-pages.7.html ... AUTHORS lists authors of the documentation or program.Use of an AUTHORS section is strongly discouraged. Generally, it is better not to clutter every page with a list of (over time potentially numerous) authors; if you write or significantly amend a page, add a copyright notice as a comment in the source file. If you are the author of a device driver and want to include an address for reporting bugs, place this under the BUGS section. ... Suggested-by: Satoru Takeuchi <takeuchi_satoru@jp.fujitsu.com> Signed-off-by: Wang Shilong <wangsl.fnst@cn.fujitsu.com> Signed-off-by: David Sterba <dsterba@suse.cz>
* Btrfs-progs: fix wrong manpage of defrag commandLiu Bo2014-08-22
| | | | | | | | | | | | | | | | | | | | | | 'btrfs filesystem defrag' has an option '-t', whose manpage says "Any extent bigger than threshold given by -t option, will be considered already defragged. Use 0 to take the kernel default, and use 1 to say every single extent must be rewritten." Here 'use 0' still works, it refers to the default value(256K), however, 'use 1' is an obvious typo, it should be -1, which means the largest value it can be. Right now, we use parse_size() which no more allow value '-1', so in order to keep the manpage correct, this updates it to only keep value '0'. If you want to make sure every single extent is rewritten, please use a fairly large size, say 1G. Reported-by: Sebastian Ochmann <ochmann@informatik.uni-bonn.de> Signed-off-by: Liu Bo <bo.li.liu@oracle.com> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: Add uninstall targets to Makefiles.Nils Steinger2014-08-22
| | | | | Signed-off-by: Nils Steinger <git@n-st.de> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: correct manpage option description for scrubGui Hecheng2014-08-22
| | | | | | | | | | | | | | | | | | The -f option of scrub means to "force starting new scrub even if a scrub is already running" *not* "force to check whether scrub has started or resumed in userspace" as described originally. So replace the orignal description in the manpage and code. Also, add description of the potential failure as follows "If a scrub is already running, it fails." Signed-off-by: Gui Hecheng <guihc.fnst@cn.fujitsu.com> Signed-off-by: Satoru Takeuchi <takeuchi_satoru@jp.fujitsu.com> Cc: David Sterba <dsterba@suse.cz> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: doc: fix incorrect subvol nameTsutomu Itoh2014-08-22
| | | | | | | Subvolume name is wrong. Fix it. Signed-off-by: Tsutomu Itoh <t-itoh@jp.fujitsu.com> Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: add X inode flag to btrfs(5)David Sterba2014-08-22
| | | | | | | | | | After the discussion in http://thread.gmane.org/gmane.comp.file-systems.btrfs/36334 the 'X' will be mentioned in the manpage because new e2fsprogs/lsattr will display it and represents the NOCOMPRESS bit of an inode. Signed-off-by: David Sterba <dsterba@suse.cz>
* btrfs-progs: add supported attr flags to btrfs(5)Eric Sandeen2014-08-22
| | | | | | | | | | | | | | | The chattr(1) manpage suffers from the same problems mount(1) had: many options listed, not kept up to date for various filesystems. I've submitted a manpage update for chattr(1) which says to refer to filesystem-specific manpages for supported attributes; this patch updates btrfs(5) to list the attributes supported by btrfs. Signed-off-by: Eric Sandeen <sandeen@redhat.com> [added some asciidoc markups, adjusted formatting] Signed-off-by: David Sterba <dsterba@suse.cz>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-17 11:27:02 +0000