From patchwork Sat Aug 6 22:40:04 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Xose Vazquez Perez X-Patchwork-Id: 9266127 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 4942360754 for ; Sat, 6 Aug 2016 22:44:23 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 3981528395 for ; Sat, 6 Aug 2016 22:44:23 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 2E88E2841F; Sat, 6 Aug 2016 22:44:23 +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=-4.1 required=2.0 tests=BAYES_00, DKIM_ADSP_CUSTOM_MED, DKIM_SIGNED, FREEMAIL_FROM, RCVD_IN_DNSWL_MED, T_DKIM_INVALID autolearn=ham version=3.3.1 Received: from mx6-phx2.redhat.com (mx6-phx2.redhat.com [209.132.183.39]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id 846EF28395 for ; Sat, 6 Aug 2016 22:44:22 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by mx6-phx2.redhat.com (8.14.4/8.14.4) with ESMTP id u76MeiOV044159; Sat, 6 Aug 2016 18:40:45 -0400 Received: from int-mx09.intmail.prod.int.phx2.redhat.com (int-mx09.intmail.prod.int.phx2.redhat.com [10.5.11.22]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id u76MeH0g015789 for ; Sat, 6 Aug 2016 18:40:17 -0400 Received: from mx1.redhat.com (ext-mx07.extmail.prod.ext.phx2.redhat.com [10.5.110.31]) by int-mx09.intmail.prod.int.phx2.redhat.com (8.14.4/8.14.4) with ESMTP id u76MeHUj008267 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=NO) for ; Sat, 6 Aug 2016 18:40:17 -0400 Received: from mail-wm0-f67.google.com (mail-wm0-f67.google.com [74.125.82.67]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 0C6DEC04B317 for ; Sat, 6 Aug 2016 22:40:16 +0000 (UTC) Received: by mail-wm0-f67.google.com with SMTP id o80so9091064wme.0 for ; Sat, 06 Aug 2016 15:40:15 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=0eIwaQSEkk8nkYwn1gxmrfCr/ZWaxfUc73Ie/11yudE=; b=Zt80XB0QqU43Q/RPSnwtzlWY0qJzfXyqn4f4Mqm2dvhCVYY81XlM5ngg7YvAOfqqdP yOco4Fon5RyxFVIRJ/mpMx3GQGMrEVe23Gn5SFq7BUddRCTZDD55XDJpYhQahU6Ryacm 2CibPmPLW7MFlxdjAef96v/OAV6arMMW/0roGd59uA7QF1k4uZ/P9Hg9FkHenGuCyDCY /bJbVhCg0tycGEyZWC9WP4b/US/yvCuWziuPnNFSqEj82OyAgbo2LpiDATkNtFzfFhSZ IEMVdGWVqfb3hDAYqpuMuxiCBcfseiXXp5B6RVYkoPNm9h16Wwc9oAP8yfGueKV11nEZ Px1g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=0eIwaQSEkk8nkYwn1gxmrfCr/ZWaxfUc73Ie/11yudE=; b=GvN+qrjCr6moqWhpXTG7lceRQJOtjfvxYfORxO0S9EtZRy+iGkl22zm3affALnm1Tz 13uEcO2Z9HuU97d3hg/uQ5Fn0AqnHAbtqx/rRj/F1laaNrMLyEA1kX10x6OZNHE5csAz OmvJrKBQcwTW7TkkMW8mpxRAthUg7BS8raPfAnp3MskSYOlgoQ48XSn/x7E4rkaYljJA N/0JoC5j98UoPaEFfi5SJJIW6swzmINvMeBQlVbuhr8rgAfXGCcF7AmR63Vo4lzVzbXG NWTjFBfXtGoWE6djV9WvzPwFVP8bFfFZ5JIjZoPh4V0h2RtfVQSW8Y2JOaGn8BkPHDO0 LerA== X-Gm-Message-State: AEkoouuNoSMf5rn0sxpXnfjPk9YhkWRxWhx1bNcQw4sjWLDEJ1KuAJHiHLGOgig1Uw5CCg== X-Received: by 10.28.36.10 with SMTP id k10mr8900208wmk.33.1470523214594; Sat, 06 Aug 2016 15:40:14 -0700 (PDT) Received: from localhost (193.173.78.188.dynamic.jazztel.es. [188.78.173.193]) by smtp.gmail.com with ESMTPSA id x6sm24878686wjk.26.2016.08.06.15.40.13 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Sat, 06 Aug 2016 15:40:13 -0700 (PDT) From: Xose Vazquez Perez To: Date: Sun, 7 Aug 2016 00:40:04 +0200 Message-Id: <1470523208-14067-3-git-send-email-xose.vazquez@gmail.com> In-Reply-To: <1470523208-14067-1-git-send-email-xose.vazquez@gmail.com> References: <1470523208-14067-1-git-send-email-xose.vazquez@gmail.com> X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.31]); Sat, 06 Aug 2016 22:40:16 +0000 (UTC) X-Greylist: inspected by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.31]); Sat, 06 Aug 2016 22:40:16 +0000 (UTC) for IP:'74.125.82.67' DOMAIN:'mail-wm0-f67.google.com' HELO:'mail-wm0-f67.google.com' FROM:'xose.vazquez@gmail.com' RCPT:'' X-RedHat-Spam-Score: -0.02 (BAYES_50, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, FREEMAIL_FROM, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, SPF_PASS) 74.125.82.67 mail-wm0-f67.google.com 74.125.82.67 mail-wm0-f67.google.com X-Scanned-By: MIMEDefang 2.68 on 10.5.11.22 X-Scanned-By: MIMEDefang 2.78 on 10.5.110.31 X-loop: dm-devel@redhat.com Cc: device-mapper development , Xose Vazquez Perez Subject: [dm-devel] [PATCH 3/7] multipath-tools: stand out sections headings with comments at multipath.conf.5 X-BeenThere: dm-devel@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: device-mapper development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Sender: dm-devel-bounces@redhat.com Errors-To: dm-devel-bounces@redhat.com X-Virus-Scanned: ClamAV using ClamSMTP Cc: Christophe Varoqui Cc: device-mapper development Signed-off-by: Xose Vazquez Perez --- multipath/multipath.conf.5 | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/multipath/multipath.conf.5 b/multipath/multipath.conf.5 index ed5dd10..1a96acf 100644 --- a/multipath/multipath.conf.5 +++ b/multipath/multipath.conf.5 @@ -1,13 +1,19 @@ -.TH MULTIPATH.CONF 5 2016-07-08 "Linux" +.TH MULTIPATH.CONF 5 2016-08-06 "Linux" +.\" ---------------------------------------------------------------------------- .SH NAME +.\" ---------------------------------------------------------------------------- multipath.conf \- multipath daemon configuration file. +.\" ---------------------------------------------------------------------------- .SH DESCRIPTION +.\" ---------------------------------------------------------------------------- .B "/etc/multipath.conf" is the configuration file for the multipath daemon. It is used to overwrite the built-in configuration table of \fBmultipathd\fP. Any line whose first non-white-space character is a '#' is considered a comment line. Empty lines are ignored. +.\" ---------------------------------------------------------------------------- .SH SYNTAX +.\" ---------------------------------------------------------------------------- The configuration file contains entries of the form: .RS .nf @@ -67,7 +73,9 @@ This section defines values for attributes that should override the device-specific settings for all devices. .RE .LP +.\" ---------------------------------------------------------------------------- .SH "defaults section" +.\" ---------------------------------------------------------------------------- The \fIdefaults\fR section recognizes the following keywords: .TP 17 .B verbosity @@ -686,7 +694,9 @@ on a device until it receives a change uevent from the initial table load. Default value is: \fB30\fR .RE . +.\" ---------------------------------------------------------------------------- .SH "blacklist section" +.\" ---------------------------------------------------------------------------- The \fIblacklist\fR section is used to exclude specific device from inclusion in the multipath topology. It is most commonly used to exclude local disks or @@ -710,7 +720,9 @@ and .B product keywords. For a full description of these keywords please see the \fIdevices\fR section description. +.\" ---------------------------------------------------------------------------- .SH "blacklist_exceptions section" +.\" ---------------------------------------------------------------------------- The \fIblacklist_exceptions\fR section is used to revert the actions of the \fIblacklist\fR section, for example to include specific device in the multipath topology. This allows one to selectively include devices which @@ -744,7 +756,9 @@ The \fIproperty\fR blacklist and whitelist handling is different from the usual handling in the sense that the whitelist \fIhas\fR to be set, otherwise the device will be blacklisted. In these cases the message \fIblacklisted, udev property missing\fR will be displayed. +.\" ---------------------------------------------------------------------------- .SH "multipaths section" +.\" ---------------------------------------------------------------------------- The only recognized attribute for the \fImultipaths\fR section is the \fImultipath\fR subsection. .LP @@ -797,7 +811,9 @@ section: .RE .PD .LP +.\" ---------------------------------------------------------------------------- .SH "devices section" +.\" ---------------------------------------------------------------------------- The only recognized attribute for the \fIdevices\fR section is the \fIdevice\fR subsection. .LP @@ -894,7 +910,9 @@ section: .RE .PD .LP +.\" ---------------------------------------------------------------------------- .SH "overrides section" +.\" ---------------------------------------------------------------------------- The overrides section recognizes the following optional attributes; if not set the values are taken from the \fIdevices\fR or \fIdefaults\fR sections: .sp 1 @@ -949,7 +967,9 @@ the values are taken from the \fIdevices\fR or \fIdefaults\fR sections: .RE .PD .LP +.\" ---------------------------------------------------------------------------- .SH "WWID generation" +.\" ---------------------------------------------------------------------------- Multipath uses a \fIWorld Wide Identification\fR (WWID) to determine which paths belong to the same device. Each path presenting the same WWID is assumed to point to the same device. @@ -973,7 +993,9 @@ variable. If none of the \fIgetuid_callout\fR or \fIuid_attribute\fR parameters are present multipath will try to use the sysfs attribute \fIvpd_pg83\fR to generate the WWID. +.\" ---------------------------------------------------------------------------- .SH "KNOWN ISSUES" +.\" ---------------------------------------------------------------------------- The usage of \fIqueue_if_no_path\fR option can lead to \fID state\fR processes being hung and not killable in situations where all the paths to the LUN go offline. It is advisable to use the \fIno_path_retry\fR option instead. @@ -984,12 +1006,16 @@ while I/O is still queued. The multipath daemon will update the \fIdev_loss_tmo\ setting accordingly to avoid this deadlock. Hence if both values are specified the order of precedence is \fIno_path_retry, queue_if_no_path, dev_loss_tmo.\fR +.\" ---------------------------------------------------------------------------- .SH "SEE ALSO" +.\" ---------------------------------------------------------------------------- .BR udev (8), .BR dmsetup (8), .BR multipath (8), .BR multipathd (8). +.\" ---------------------------------------------------------------------------- .SH AUTHORS +.\" ---------------------------------------------------------------------------- \fImultipath-tools\fR was developed by Christophe Varoqui, and others.