From patchwork Fri Dec 19 07:22:49 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Satoru Takeuchi X-Patchwork-Id: 5517811 Return-Path: X-Original-To: patchwork-linux-btrfs@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork2.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.19.201]) by patchwork2.web.kernel.org (Postfix) with ESMTP id C1B80BEEA8 for ; Fri, 19 Dec 2014 07:23:27 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id CB91720131 for ; Fri, 19 Dec 2014 07:23:26 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id AC3502012D for ; Fri, 19 Dec 2014 07:23:24 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752118AbaLSHXT (ORCPT ); Fri, 19 Dec 2014 02:23:19 -0500 Received: from fgwmail5.fujitsu.co.jp ([192.51.44.35]:49442 "EHLO fgwmail5.fujitsu.co.jp" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751933AbaLSHXR (ORCPT ); Fri, 19 Dec 2014 02:23:17 -0500 Received: from kw-mxoi1.gw.nic.fujitsu.com (unknown [10.0.237.133]) by fgwmail5.fujitsu.co.jp (Postfix) with ESMTP id 4FB473EE188 for ; Fri, 19 Dec 2014 16:23:16 +0900 (JST) Received: from s3.gw.fujitsu.co.jp (s3.gw.fujitsu.co.jp [10.0.50.93]) by kw-mxoi1.gw.nic.fujitsu.com (Postfix) with ESMTP id 45B11AC036E for ; Fri, 19 Dec 2014 16:23:15 +0900 (JST) Received: from g01jpfmpwyt01.exch.g01.fujitsu.local (g01jpfmpwyt01.exch.g01.fujitsu.local [10.128.193.38]) by s3.gw.fujitsu.co.jp (Postfix) with ESMTP id D2E31E08004 for ; Fri, 19 Dec 2014 16:23:14 +0900 (JST) Received: from g01jpexchyt37.g01.fujitsu.local (unknown [10.128.193.4]) by g01jpfmpwyt01.exch.g01.fujitsu.local (Postfix) with ESMTP id 127156D64AB; Fri, 19 Dec 2014 16:23:14 +0900 (JST) X-SecurityPolicyCheck: OK by SHieldMailChecker v2.0.1 X-SHieldMailCheckerPolicyVersion: FJ-ISEC-20120718-4 Message-ID: <5493D249.5020207@jp.fujitsu.com> Date: Fri, 19 Dec 2014 16:22:49 +0900 From: Satoru Takeuchi User-Agent: Mozilla/5.0 (Windows NT 6.1; rv:31.0) Gecko/20100101 Thunderbird/31.3.0 MIME-Version: 1.0 To: "linux-btrfs@vger.kernel.org" CC: naota Subject: [PATCH] btrfs-progs: Enhance the document of btrfs property X-SecurityPolicyCheck-GC: OK by FENCE-Mail X-TM-AS-MML: No Sender: linux-btrfs-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-btrfs@vger.kernel.org X-Spam-Status: No, score=-6.9 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_HI, T_RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=unavailable version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP From: Satoru Takeuchi Enhance the document of btrfs property as follows. - Add the description about the candidates of . - Enrich the description of . - Fix typos and some redundancy. Signed-off-by: Satoru Takeuchi Reported-by: Naohiro Aota --- Documentation/btrfs-property.txt | 32 +++++++++++++++++++------------- 1 file changed, 19 insertions(+), 13 deletions(-) diff --git a/Documentation/btrfs-property.txt b/Documentation/btrfs-property.txt index 3a71315..f8dcbab 100644 --- a/Documentation/btrfs-property.txt +++ b/Documentation/btrfs-property.txt @@ -11,8 +11,9 @@ SYNOPSIS DESCRIPTION ----------- -*btrfs property* is used to get/set/list property, like lable or compression -state, for given btrfs object. +*btrfs property* is used to get/set/list property for given btrfs object. +See the description of *get* subcommand for more information about +both btrfs object and property. *btrfs property* provides an unified and user-friendly method to tune different btrfs properties instead of using the traditional method like `chattr`(1) or @@ -23,31 +24,36 @@ SUBCOMMAND *get* [-t ] []:: Gets a property from a btrfs object. + -If no name is specified, all properties for the given object are -printed. -A filesystem object can be a the filesystem itself, a subvolume, -an inode or a device. +A btrfs object, which is set by , can be a btrfs filesystem +itself, a btrfs subvolume, an inode(file or directory) inside btrfs, +or a device on which a btrfs exists. + +Set the name of property by ''. If no '' is specified, +all properties for the given object are printed. '' is one of +the followings. ++ +ro:::: +read-only flag of subvolume: true or false +label:::: +label of device +compression:::: +compression setting for an inode: lzo, zlib, or "" (empty string) + The '-t ' option can be used to explicitly specify what type of object you meant. This is only needed when a property could be set for more then one object type. + Possible types are 's[ubvol]', 'f[ilesystem]', 'i[node]' and 'd[evice]'. -+ -The can be path of btrfs device, btrfs mount point, or any -directories/files inside btrfs. *set* [-t ] :: Sets a property on a btrfs object. + -See description of *get* subcommand for a description of objects and object -types. +See the description of *get* subcommand for the meaning of each option. *list* [-t ] :: Lists available properties with their descriptions for the given object. + -Please see the help of *btrfs property get* for a description of -objects and object types. +See the description of *get* subcommand for the meaning of each option. EXIT STATUS -----------