On 11/24/2014 03:59 PM, Martin Basti wrote:
On 24/11/14 15:54, David Kupka wrote:
https://fedorahosted.org/freeipa/ticket/4695

IMO this is one of two reasonable ways how to fix this ticket.
The other one is to change just the manual page but it seems more
consistent to use singular for metavars everywhere.


I like this approach. But IMO we should instead of "You ..." form in
help, this message, as we use with forwarders

"This option can be used multiple times"

Martin^2

Our manual pages are not exactly unified in that but let's stay with the majority.

--
David Kupka
From 54f396b9b8316173b1c295c15feb0bb38025b64a Mon Sep 17 00:00:00 2001
From: David Kupka <dku...@redhat.com>
Date: Mon, 24 Nov 2014 08:49:05 -0500
Subject: [PATCH] Use singular in help metavars + update man pages.

https://fedorahosted.org/freeipa/ticket/4695
---
 install/tools/ipa-dns-install            | 4 ++--
 install/tools/ipa-replica-install        | 5 +++--
 install/tools/ipa-server-install         | 4 ++--
 install/tools/man/ipa-dns-install.1      | 3 ++-
 install/tools/man/ipa-replica-install.1  | 3 ++-
 install/tools/man/ipa-replica-prepare.1  | 3 ++-
 install/tools/man/ipa-server-install.1   | 4 +++-
 ipaserver/install/ipa_replica_prepare.py | 4 ++--
 8 files changed, 18 insertions(+), 12 deletions(-)

diff --git a/install/tools/ipa-dns-install b/install/tools/ipa-dns-install
index 806c2e2698d63da1f2deaff36e565591769d8538..01ca59be8d0f2530bd96faae0d8ed0fd02a31c8e 100755
--- a/install/tools/ipa-dns-install
+++ b/install/tools/ipa-dns-install
@@ -42,7 +42,7 @@ def parse_options():
                       sensitive=True, help="admin password")
     parser.add_option("-d", "--debug", dest="debug", action="store_true",
                       default=False, help="print debugging information")
-    parser.add_option("--ip-address", dest="ip_addresses",
+    parser.add_option("--ip-address", dest="ip_addresses", metavar="IP_ADDRESS",
                       default=[], action="append",
                       type="ip", ip_local=True, help="Master Server IP Address")
     parser.add_option("--forwarder", dest="forwarders", action="append",
@@ -50,7 +50,7 @@ def parse_options():
     parser.add_option("--no-forwarders", dest="no_forwarders", action="store_true",
                       default=False, help="Do not add any DNS forwarders, use root servers instead")
     parser.add_option("--reverse-zone", dest="reverse_zones",
-                      default=[], action="append",
+                      default=[], action="append", metavar="REVERSE_ZONE",
                       help="The reverse DNS zone to use")
     parser.add_option("--no-reverse", dest="no_reverse", action="store_true",
                       default=False, help="Do not create new reverse DNS zone")
diff --git a/install/tools/ipa-replica-install b/install/tools/ipa-replica-install
index 3cd8c41616c8b177e2e2eb164ced3e0af192fc4d..e7a0a53afd430708ff44b3fdd5a5e75ba7abcb5a 100755
--- a/install/tools/ipa-replica-install
+++ b/install/tools/ipa-replica-install
@@ -67,7 +67,7 @@ def parse_options():
                       default=False, help="configure a dogtag CA")
     basic_group.add_option("--ip-address", dest="ip_addresses",
                       type="ip", ip_local=True, action="append", default=[],
-                      help="Replica server IP Address")
+                      help="Replica server IP Address", metavar="IP_ADDRESS")
     basic_group.add_option("-p", "--password", dest="password", sensitive=True,
                       help="Directory Manager (existing master) password")
     basic_group.add_option("-w", "--admin-password", dest="admin_password", sensitive=True,
@@ -111,7 +111,8 @@ def parse_options():
     dns_group.add_option("--no-forwarders", dest="no_forwarders", action="store_true",
                       default=False, help="Do not add any DNS forwarders, use root servers instead")
     dns_group.add_option("--reverse-zone", dest="reverse_zones", default=[],
-                         action="append", help="The reverse DNS zone to use")
+                         action="append", help="The reverse DNS zone to use",
+                        metavar="REVERSE_ZONE")
     dns_group.add_option("--no-reverse", dest="no_reverse", action="store_true",
                       default=False, help="Do not create new reverse DNS zone")
     dns_group.add_option("--no-dnssec-validation", dest="no_dnssec_validation", action="store_true",
diff --git a/install/tools/ipa-server-install b/install/tools/ipa-server-install
index fb8db7acadf90c2ec2e6fc48946db2d51ee2c424..1a2d21ff86a41b6abdd2cd1d31d6c53eb35b04f9 100755
--- a/install/tools/ipa-server-install
+++ b/install/tools/ipa-server-install
@@ -179,7 +179,7 @@ def parse_options():
     basic_group.add_option("--hostname", dest="host_name", help="fully qualified name of server")
     basic_group.add_option("--ip-address", dest="ip_addresses",
                       type="ip", ip_local=True, action="append", default=[],
-                      help="Master Server IP Address")
+                      help="Master Server IP Address", metavar="IP_ADDRESS")
     basic_group.add_option("-N", "--no-ntp", dest="conf_ntp", action="store_false",
                       help="do not configure ntp", default=True)
     basic_group.add_option("--idstart", dest="idstart", default=namespace, type=int,
@@ -285,7 +285,7 @@ def parse_options():
     dns_group.add_option("--no-forwarders", dest="no_forwarders", action="store_true",
                       default=False, help="Do not add any DNS forwarders, use root servers instead")
     dns_group.add_option("--reverse-zone", dest="reverse_zones", help="The reverse DNS zone to use",
-                      action="append", default=[])
+                      action="append", default=[], metavar="REVERSE_ZONE")
     dns_group.add_option("--no-reverse", dest="no_reverse", action="store_true",
                       default=False, help="Do not create reverse DNS zone")
     dns_group.add_option("--no-dnssec-validation", dest="no_dnssec_validation", action="store_true",
diff --git a/install/tools/man/ipa-dns-install.1 b/install/tools/man/ipa-dns-install.1
index bde30cadba9b8b461f5373b734c3edf2faf9d0af..24931bc16f98158e6f7a64b51776e8515d921a12 100644
--- a/install/tools/man/ipa-dns-install.1
+++ b/install/tools/man/ipa-dns-install.1
@@ -33,6 +33,7 @@ Enable debug logging when more verbose output is needed
 .TP
 \fB\-\-ip\-address\fR=\fIIP_ADDRESS\fR
 The IP address of the IPA server. If not provided then this is determined based on the hostname of the server.
+You can use this option multiple times to specify more IP addresses of the server (e.g. multihomed and/or dualstacked server).
 .TP
 \fB\-\-forwarder\fR=\fIFORWARDER\fR
 A forwarder is a DNS server where queries for a specific non\-resolvable address can be directed. To define multiple forwarders use multiple instances of \fB\-\-forwarder\fR
@@ -41,7 +42,7 @@ A forwarder is a DNS server where queries for a specific non\-resolvable address
 Do not add any DNS forwarders, send non\-resolvable addresses to the DNS root servers.
 .TP
 \fB\-\-reverse\-zone\fR=\fIREVERSE_ZONE\fR
-The reverse DNS zone to use
+The reverse DNS zone to use. You can use this option multiple times to specify multiple reverse zones.
 .TP
 \fB\-\-no\-reverse\fR
 Do not create new reverse DNS zone. If used on a replica and a reverse DNS zone already exists for the subnet, it will be used.
diff --git a/install/tools/man/ipa-replica-install.1 b/install/tools/man/ipa-replica-install.1
index b7a55cb748dfd5536d86e1b2634df34fd43f319b..fe5e633c3cedeb4a05ec4041f5b26343652202f5 100644
--- a/install/tools/man/ipa-replica-install.1
+++ b/install/tools/man/ipa-replica-install.1
@@ -40,6 +40,7 @@ certificate operations will be forwarded to a master with a CA installed.
 .TP
 \fB\-\-ip\-address\fR=\fIIP_ADDRESS\fR
 The IP address of this server. If this address does not match the address the host resolves to and \-\-setup\-dns is not selected the installation will fail. If the server hostname is not resolvable, a record for the hostname and IP_ADDRESS is added to /etc/hosts.
+You can use this option multiple times to specify more IP addresses of the server (e.g. multihomed and/or dualstacked server).
 .TP
 \fB\-p\fR \fIDM_PASSWORD\fR, \fB\-\-password\fR=\fIDM_PASSWORD\fR
 Directory Manager (existing master) password
@@ -98,7 +99,7 @@ the \fB\-\-no\-forwarders\fR option is specified.
 Do not add any DNS forwarders. Root DNS servers will be used instead.
 .TP
 \fB\-\-reverse\-zone\fR=\fIREVERSE_ZONE\fR
-The reverse DNS zone to use
+The reverse DNS zone to use. You can use this option multiple times to specify multiple reverse zones.
 .TP
 \fB\-\-no\-reverse\fR
 Do not create new reverse DNS zone. If a reverse DNS zone already exists for the subnet, it will be used.
diff --git a/install/tools/man/ipa-replica-prepare.1 b/install/tools/man/ipa-replica-prepare.1
index a0d47c9add145b8840065f64b79443ade504d9db..2f66d8fbf3877d95e1f03483e9ecd88ba5555f9b 100644
--- a/install/tools/man/ipa-replica-prepare.1
+++ b/install/tools/man/ipa-replica-prepare.1
@@ -67,9 +67,10 @@ Directory Manager (existing master) password
 .TP
 \fB\-\-ip\-address\fR=\fIIP_ADDRESS\fR
 IP address of the replica server. If you provide this option, the A and PTR records will be added to the DNS.
+You can use this option multiple times to specify more IP addresses of the server (e.g. multihomed and/or dualstacked server).
 .TP
 \fB\-\-reverse\-zone\fR=\fIREVERSE_ZONE\fR
-The reverse DNS zone to use
+The reverse DNS zone to use. You can use this option multiple times to specify multiple reverse zones.
 .TP
 \fB\-\-no\-reverse\fR
 Do not create reverse DNS zone
diff --git a/install/tools/man/ipa-server-install.1 b/install/tools/man/ipa-server-install.1
index e5c9c319b95268af091287a7be14df6a2d06a6e0..f5774d6058cab941d58fdff0b89613b74b02be98 100644
--- a/install/tools/man/ipa-server-install.1
+++ b/install/tools/man/ipa-server-install.1
@@ -50,6 +50,7 @@ The fully\-qualified DNS name of this server. If the hostname does not match sys
 .TP
 \fB\-\-ip\-address\fR=\fIIP_ADDRESS\fR
 The IP address of this server. If this address does not match the address the host resolves to and --setup-dns is not selected the installation will fail. If the server hostname is not resolvable, a record for the hostname and IP_ADDRESS is added to /etc/hosts.
+You use this option multiple times to specify more IP addresses of the server (e.g. multihomed and/or dualstacked host).
 .TP
 \fB\-N\fR, \fB\-\-no\-ntp\fR
 Do not configure NTP
@@ -153,7 +154,8 @@ the \fB\-\-no\-forwarders\fR option is specified.
 Do not add any DNS forwarders. Root DNS servers will be used instead.
 .TP
 \fB\-\-reverse\-zone\fR=\fIREVERSE_ZONE\fR
-The reverse DNS zone to use
+The reverse DNS zone to use. You can use this option multiple times to specify
+more reverse zones.
 .TP
 \fB\-\-no\-reverse\fR
 Do not create reverse DNS zone
diff --git a/ipaserver/install/ipa_replica_prepare.py b/ipaserver/install/ipa_replica_prepare.py
index 3762f32700aa899541883d3af72b160c4c42ba7c..304b80951192d4d39597b701d64a8b33fb49e31c 100644
--- a/ipaserver/install/ipa_replica_prepare.py
+++ b/ipaserver/install/ipa_replica_prepare.py
@@ -55,10 +55,10 @@ class ReplicaPrepare(admintool.AdminTool):
         parser.add_option("-p", "--password", dest="password",
             help="Directory Manager password (for the existing master)")
         parser.add_option("--ip-address", dest="ip_addresses", type="ip",
-            action="append", default=[],
+            action="append", default=[], metavar="IP_ADDRESS"
             help="add A and PTR records of the future replica")
         parser.add_option("--reverse-zone", dest="reverse_zones",
-            action="append", default=[],
+            action="append", default=[], metavar="REVERSE_ZONE",
             help="the reverse DNS zone to use")
         parser.add_option("--no-reverse", dest="no_reverse",
             action="store_true", default=False,
-- 
2.1.0

_______________________________________________
Freeipa-devel mailing list
Freeipa-devel@redhat.com
https://www.redhat.com/mailman/listinfo/freeipa-devel

Reply via email to