From patchwork Wed May 30 18:10:48 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Eric Sandeen X-Patchwork-Id: 10439565 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 3CF92601D3 for ; Wed, 30 May 2018 18:10:53 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 2C109291F6 for ; Wed, 30 May 2018 18:10:53 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 20F1929201; Wed, 30 May 2018 18:10:53 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-7.9 required=2.0 tests=BAYES_00, MAILING_LIST_MULTI, RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id F15F0291F6 for ; Wed, 30 May 2018 18:10:51 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753885AbeE3SKv (ORCPT ); Wed, 30 May 2018 14:10:51 -0400 Received: from sandeen.net ([63.231.237.45]:60750 "EHLO sandeen.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753641AbeE3SKt (ORCPT ); Wed, 30 May 2018 14:10:49 -0400 Received: from [10.0.0.4] (erlite [10.0.0.1]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by sandeen.net (Postfix) with ESMTPSA id 8E36117DFC; Wed, 30 May 2018 13:10:45 -0500 (CDT) Subject: [PATCH 3.5/4] mkfs.xfs: document defaults config file details To: "Luis R. Rodriguez" , linux-xfs@vger.kernel.org Cc: darrick.wong@oracle.com, jack@suse.com, jeffm@suse.com, okurz@suse.com, lpechacek@suse.com, jtulak@redhat.com References: <20180529220603.29420-1-mcgrof@kernel.org> <20180529220603.29420-4-mcgrof@kernel.org> From: Eric Sandeen Message-ID: <7f30d5cb-800e-13a2-9ad7-d884cebc31e4@sandeen.net> Date: Wed, 30 May 2018 13:10:48 -0500 User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.11; rv:52.0) Gecko/20100101 Thunderbird/52.8.0 MIME-Version: 1.0 In-Reply-To: <20180529220603.29420-4-mcgrof@kernel.org> Content-Language: en-US Sender: linux-xfs-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-xfs@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Here's my stab at documenting the defaults/config file behavior. I've condensed it down to just mkfs.xfs 8 changes, and tried to make it more concise. I'll let people bikeshed this while I work out a proper way to substitute %sysconfdir% in the text. Note that what I describe in terms of bare filename behavior doesn't match the code today - I think we still need to reach a consensus on whether a bare filename looks in $PWD first, or only in the /etc/ path. (I'd prefer the latter, I think, but still slightly wobbly on this) Signed-off-by: Eric Sandeen --- -- To unsubscribe from this list: send the line "unsubscribe linux-xfs" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html diff --git a/man/man8/mkfs.xfs.8 b/man/man8/mkfs.xfs.8 index 4b8c78c..64853cc 100644 --- a/man/man8/mkfs.xfs.8 +++ b/man/man8/mkfs.xfs.8 @@ -4,6 +4,10 @@ mkfs.xfs \- construct an XFS filesystem .SH SYNOPSIS .B mkfs.xfs [ +.B \-c +.I configuration +] [ +[ .B \-b .I block_size_options ] [ @@ -121,8 +125,38 @@ when parameters are quantified in those units. .PP Many feature options allow an optional argument of 0 or 1, to explicitly disable or enable the functionality. +.SH DEFAULT VALUES +.BR mkfs.xfs (8) +contains built-in default values for every option as described in the sections +below. +These built-in defaults may evolve over time as new capabilities are added. +If the file +.B /etc/xfs/mkfs/defaults +exists, it will be parsed to override built-in defaults as specified in the +.B defaults +file, and the defaults described in sections below may no longer apply. +.PP +The +.B \-c +option may also be used to specify an alternate configuration file +as descibed in the OPTIONS section. .SH OPTIONS .TP +.BI \-c " configuration" +This option may be used to specify a configuration file other than +.B /etc/xfs/mkfs/defaults +to override selected built-in parameter defaults. +If +.B configuration +is a bare filename, it will be searched in the +.B /etc/xfs/mkfs/ +directory. If +.B configuration +is a full pathname or a relative pathname starting with +.BR \'./\' " or " \'../\' +then that explicit path to the configuration file will be used. +See also the CONFIGURATION FILE FORMAT section below. +.TP .BI \-b " block_size_options" This option specifies the fundamental block size of the filesystem. The valid @@ -920,6 +954,55 @@ Do not attempt to discard blocks at mkfs time. .TP .B \-V Prints the version number and exits. +.SH CONFIGURATION FILE FORMAT +The optional default configuration file in +.B /etc/xfs/mkfs/default +as well as any alternate configuration file specified via the +.B \-c +option follow a simple ini-style format as shown below. +Available options consist of a small subset of the parameters available +via the +.BR mkfs.xfs (8) +command line. +Currently all default parameters can only be either enabled or disabled, +with a value of 1 to enable or 0 to disable. +See below for a list of all supported configuration parameters and their +current built-in default settings. +.PP +.BI [data] +.br +.BI noalign=0 +.PP +.BI [inode] +.br +.BI align=1 +.br +.BI projid32bit=1 +.br +.BI sparse=0 +.PP +.BI [log] +.br +.BI lazy-count=1 +.PP +.BI [metadata] +.br +.BI crc=1 +.br +.BI finobt=1 +.br +.BI rmapbt=0 +.br +.BI reflink=0 +.PP +.BI [naming] +.br +.BI ftype=1 +.PP +.BI [rtdev] +.br +.BI noalign=0 +.PP .SH SEE ALSO .BR xfs (5), .BR mkfs (8),