Re: [Freeipa-devel] [PATCH] 0033 Use singular in help metavars + update man pages.
On 25/11/14 15:44, David Kupka wrote: On 11/25/2014 03:23 PM, Martin Basti wrote: On 25/11/14 13:16, David Kupka wrote: On 11/25/2014 09:57 AM, David Kupka wrote: On 11/25/2014 09:51 AM, David Kupka wrote: 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. ___ Freeipa-devel mailing list Freeipa-devel@redhat.com https://www.redhat.com/mailman/listinfo/freeipa-devel Wrong patch, sorry. ___ Freeipa-devel mailing list Freeipa-devel@redhat.com https://www.redhat.com/mailman/listinfo/freeipa-devel Extending help messages too. NACK, you edited wrong option --no-reverseDo not create reverse DNS zone. This option can be used multiple times Bad line, thanks for noticing, fixed patches attached. ./make-lint * Module ipaserver.install.ipa_replica_prepare ipaserver/install/ipa_replica_prepare.py:59: [E0001(syntax-error), ] invalid syntax) * Module ipa-replica-prepare install/tools/ipa-replica-prepare:21: [E0611(no-name-in-module), ] No name 'ipa_replica_prepare' in module 'ipaserver.install') -- Martin Basti ___ Freeipa-devel mailing list Freeipa-devel@redhat.com https://www.redhat.com/mailman/listinfo/freeipa-devel
Re: [Freeipa-devel] [PATCH] 0033 Use singular in help metavars + update man pages.
On 11/26/2014 12:23 PM, Martin Basti wrote: On 25/11/14 15:44, David Kupka wrote: On 11/25/2014 03:23 PM, Martin Basti wrote: On 25/11/14 13:16, David Kupka wrote: On 11/25/2014 09:57 AM, David Kupka wrote: On 11/25/2014 09:51 AM, David Kupka wrote: 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. ___ Freeipa-devel mailing list Freeipa-devel@redhat.com https://www.redhat.com/mailman/listinfo/freeipa-devel Wrong patch, sorry. ___ Freeipa-devel mailing list Freeipa-devel@redhat.com https://www.redhat.com/mailman/listinfo/freeipa-devel Extending help messages too. NACK, you edited wrong option --no-reverseDo not create reverse DNS zone. This option can be used multiple times Bad line, thanks for noticing, fixed patches attached. ./make-lint * Module ipaserver.install.ipa_replica_prepare ipaserver/install/ipa_replica_prepare.py:59: [E0001(syntax-error), ] invalid syntax) * Module ipa-replica-prepare install/tools/ipa-replica-prepare:21: [E0611(no-name-in-module), ] No name 'ipa_replica_prepare' in module 'ipaserver.install') Fixed. -- David Kupka From 3e4ff8de6670260d04db6cc5c5234d9797a78c8f 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| 8 install/tools/ipa-replica-install| 5 +++-- install/tools/ipa-server-install | 8 +--- 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 | 3 ++- ipaserver/install/ipa_replica_prepare.py | 8 8 files changed, 24 insertions(+), 17 deletions(-) diff --git a/install/tools/ipa-dns-install b/install/tools/ipa-dns-install index 7d9bf6a8b223b586e7923137abec557036f650da..967057e1afae11873d2cd116d4385b0d79da8e14 100755 --- a/install/tools/ipa-dns-install +++ b/install/tools/ipa-dns-install @@ -43,16 +43,16 @@ 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) + type=ip, ip_local=True, help=Master Server IP Address. This option can be used multiple times) parser.add_option(--forwarder, dest=forwarders, action=append, type=ip, help=Add a DNS forwarder. This option can be used multiple times) 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, - help=The reverse DNS zone to use) + default=[], action=append, metavar=REVERSE_ZONE, + help=The reverse DNS zone to use. This option can be used multiple times) parser.add_option(--no-reverse, dest=no_reverse, action=store_true, default=False, help=Do not create new reverse DNS zone) parser.add_option(--no-dnssec-validation, dest=no_dnssec_validation, action=store_true, diff --git a/install/tools/ipa-replica-install b/install/tools/ipa-replica-install index 409f1f61b42ccb2a4f2053689a7452f4fe344b4d..20d833d72d550ccaec2b56230a52d310185977ec 100755 --- a/install/tools/ipa-replica-install +++ b/install/tools/ipa-replica-install @@ -69,7 +69,7 @@ def parse_options(): default=False, help=configure a dogtag KRA) 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. This option can be used multiple times, metavar=IP_ADDRESS) basic_group.add_option(-p, --password, dest=password,
Re: [Freeipa-devel] [PATCH] 0033 Use singular in help metavars + update man pages.
On 26/11/14 12:37, David Kupka wrote: On 11/26/2014 12:23 PM, Martin Basti wrote: On 25/11/14 15:44, David Kupka wrote: On 11/25/2014 03:23 PM, Martin Basti wrote: On 25/11/14 13:16, David Kupka wrote: On 11/25/2014 09:57 AM, David Kupka wrote: On 11/25/2014 09:51 AM, David Kupka wrote: 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. ___ Freeipa-devel mailing list Freeipa-devel@redhat.com https://www.redhat.com/mailman/listinfo/freeipa-devel Wrong patch, sorry. ___ Freeipa-devel mailing list Freeipa-devel@redhat.com https://www.redhat.com/mailman/listinfo/freeipa-devel Extending help messages too. NACK, you edited wrong option --no-reverseDo not create reverse DNS zone. This option can be used multiple times Bad line, thanks for noticing, fixed patches attached. ./make-lint * Module ipaserver.install.ipa_replica_prepare ipaserver/install/ipa_replica_prepare.py:59: [E0001(syntax-error), ] invalid syntax) * Module ipa-replica-prepare install/tools/ipa-replica-prepare:21: [E0611(no-name-in-module), ] No name 'ipa_replica_prepare' in module 'ipaserver.install') Fixed. Thanks! ACK -- Martin Basti ___ Freeipa-devel mailing list Freeipa-devel@redhat.com https://www.redhat.com/mailman/listinfo/freeipa-devel
Re: [Freeipa-devel] [PATCH] 0033 Use singular in help metavars + update man pages.
On 11/26/2014 01:04 PM, Martin Basti wrote: On 26/11/14 12:37, David Kupka wrote: Fixed. Thanks! ACK Pushed to ipa-4-1: 2f8c4e7b165609706a4af9f680579c0e47edaeca Pushed to master: 3a6d714bb229f8dd68ae219d94283f05cf57a6d7 -- Petr Vobornik ___ Freeipa-devel mailing list Freeipa-devel@redhat.com https://www.redhat.com/mailman/listinfo/freeipa-devel
Re: [Freeipa-devel] [PATCH] 0033 Use singular in help metavars + update man pages.
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)
Re: [Freeipa-devel] [PATCH] 0033 Use singular in help metavars + update man pages.
On 11/25/2014 09:51 AM, David Kupka wrote: 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. ___ Freeipa-devel mailing list Freeipa-devel@redhat.com https://www.redhat.com/mailman/listinfo/freeipa-devel Wrong patch, sorry. -- David Kupka From a34b361d01488a5676fdc7b3dbebbb183140c746 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 | 3 ++- ipaserver/install/ipa_replica_prepare.py | 4 ++-- 8 files changed, 17 insertions(+), 12 deletions(-) diff --git a/install/tools/ipa-dns-install b/install/tools/ipa-dns-install index 7d9bf6a8b223b586e7923137abec557036f650da..ed219327fd69b84158a82d7dc026b5e3242ec156 100755 --- a/install/tools/ipa-dns-install +++ b/install/tools/ipa-dns-install @@ -43,7 +43,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, @@ -51,7 +51,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 409f1f61b42ccb2a4f2053689a7452f4fe344b4d..4d57e213345bd36808219a17d2ff684401d5125f 100755 --- a/install/tools/ipa-replica-install +++ b/install/tools/ipa-replica-install @@ -69,7 +69,7 @@ def parse_options(): default=False, help=configure a dogtag KRA) 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, @@ -113,7 +113,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 1280b631db4f7b6ad69d1151d047a8190ca5215a..958845b6e00b9d4ab1f0796c4a2f55621b920aaf 100755 --- a/install/tools/ipa-server-install +++ b/install/tools/ipa-server-install @@ -180,7 +180,7 @@ def parse_options(): basic_group.add_option(--hostname, dest=host_name, help=fully qualified name of server) basic_group.add_option(--ip-address,
Re: [Freeipa-devel] [PATCH] 0033 Use singular in help metavars + update man pages.
On 11/25/2014 09:57 AM, David Kupka wrote: On 11/25/2014 09:51 AM, David Kupka wrote: 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. ___ Freeipa-devel mailing list Freeipa-devel@redhat.com https://www.redhat.com/mailman/listinfo/freeipa-devel Wrong patch, sorry. ___ Freeipa-devel mailing list Freeipa-devel@redhat.com https://www.redhat.com/mailman/listinfo/freeipa-devel Extending help messages too. -- David Kupka From 64c080682bf2ce0d8b448ab61c0f8a66426b2f8e 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| 8 install/tools/ipa-replica-install| 5 +++-- install/tools/ipa-server-install | 7 --- 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 | 3 ++- ipaserver/install/ipa_replica_prepare.py | 8 8 files changed, 23 insertions(+), 17 deletions(-) diff --git a/install/tools/ipa-dns-install b/install/tools/ipa-dns-install index 7d9bf6a8b223b586e7923137abec557036f650da..967057e1afae11873d2cd116d4385b0d79da8e14 100755 --- a/install/tools/ipa-dns-install +++ b/install/tools/ipa-dns-install @@ -43,16 +43,16 @@ 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) + type=ip, ip_local=True, help=Master Server IP Address. This option can be used multiple times) parser.add_option(--forwarder, dest=forwarders, action=append, type=ip, help=Add a DNS forwarder. This option can be used multiple times) 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, - help=The reverse DNS zone to use) + default=[], action=append, metavar=REVERSE_ZONE, + help=The reverse DNS zone to use. This option can be used multiple times) parser.add_option(--no-reverse, dest=no_reverse, action=store_true, default=False, help=Do not create new reverse DNS zone) parser.add_option(--no-dnssec-validation, dest=no_dnssec_validation, action=store_true, diff --git a/install/tools/ipa-replica-install b/install/tools/ipa-replica-install index 409f1f61b42ccb2a4f2053689a7452f4fe344b4d..20d833d72d550ccaec2b56230a52d310185977ec 100755 --- a/install/tools/ipa-replica-install +++ b/install/tools/ipa-replica-install @@ -69,7 +69,7 @@ def parse_options(): default=False, help=configure a dogtag KRA) 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. This option can be used multiple times, 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, @@ -113,7 +113,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. This option can be used multiple times, +metavar=REVERSE_ZONE)
Re: [Freeipa-devel] [PATCH] 0033 Use singular in help metavars + update man pages.
On 25/11/14 13:16, David Kupka wrote: On 11/25/2014 09:57 AM, David Kupka wrote: On 11/25/2014 09:51 AM, David Kupka wrote: 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. ___ Freeipa-devel mailing list Freeipa-devel@redhat.com https://www.redhat.com/mailman/listinfo/freeipa-devel Wrong patch, sorry. ___ Freeipa-devel mailing list Freeipa-devel@redhat.com https://www.redhat.com/mailman/listinfo/freeipa-devel Extending help messages too. NACK, you edited wrong option --no-reverseDo not create reverse DNS zone. This option can be used multiple times -- Martin Basti ___ Freeipa-devel mailing list Freeipa-devel@redhat.com https://www.redhat.com/mailman/listinfo/freeipa-devel
Re: [Freeipa-devel] [PATCH] 0033 Use singular in help metavars + update man pages.
On 11/25/2014 03:23 PM, Martin Basti wrote: On 25/11/14 13:16, David Kupka wrote: On 11/25/2014 09:57 AM, David Kupka wrote: On 11/25/2014 09:51 AM, David Kupka wrote: 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. ___ Freeipa-devel mailing list Freeipa-devel@redhat.com https://www.redhat.com/mailman/listinfo/freeipa-devel Wrong patch, sorry. ___ Freeipa-devel mailing list Freeipa-devel@redhat.com https://www.redhat.com/mailman/listinfo/freeipa-devel Extending help messages too. NACK, you edited wrong option --no-reverseDo not create reverse DNS zone. This option can be used multiple times Bad line, thanks for noticing, fixed patches attached. -- David Kupka From afa525952dada6990a8abed9d701984e455a847d 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| 8 install/tools/ipa-replica-install| 5 +++-- install/tools/ipa-server-install | 8 +--- 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 | 3 ++- ipaserver/install/ipa_replica_prepare.py | 8 8 files changed, 24 insertions(+), 17 deletions(-) diff --git a/install/tools/ipa-dns-install b/install/tools/ipa-dns-install index 7d9bf6a8b223b586e7923137abec557036f650da..967057e1afae11873d2cd116d4385b0d79da8e14 100755 --- a/install/tools/ipa-dns-install +++ b/install/tools/ipa-dns-install @@ -43,16 +43,16 @@ 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) + type=ip, ip_local=True, help=Master Server IP Address. This option can be used multiple times) parser.add_option(--forwarder, dest=forwarders, action=append, type=ip, help=Add a DNS forwarder. This option can be used multiple times) 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, - help=The reverse DNS zone to use) + default=[], action=append, metavar=REVERSE_ZONE, + help=The reverse DNS zone to use. This option can be used multiple times) parser.add_option(--no-reverse, dest=no_reverse, action=store_true, default=False, help=Do not create new reverse DNS zone) parser.add_option(--no-dnssec-validation, dest=no_dnssec_validation, action=store_true, diff --git a/install/tools/ipa-replica-install b/install/tools/ipa-replica-install index 409f1f61b42ccb2a4f2053689a7452f4fe344b4d..20d833d72d550ccaec2b56230a52d310185977ec 100755 --- a/install/tools/ipa-replica-install +++ b/install/tools/ipa-replica-install @@ -69,7 +69,7 @@ def parse_options(): default=False, help=configure a dogtag KRA) 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. This option can be used multiple times, 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, @@ -113,7 +113,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)
[Freeipa-devel] [PATCH] 0033 Use singular in help metavars + update man pages.
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. -- 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,
Re: [Freeipa-devel] [PATCH] 0033 Use singular in help metavars + update man pages.
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 -- Martin Basti ___ Freeipa-devel mailing list Freeipa-devel@redhat.com https://www.redhat.com/mailman/listinfo/freeipa-devel
