Skip to content

Commit c17c5f0

Browse files
brianphaleybrianphaley
committed
Try to make help text of network code consistent
Just change all text to be as consistent as possible. TrivialFix Change-Id: I959cda9b0688f0fcec0f55ce4c8cadf209d3537f Signed-off-by: Brian Haley <haleyb.dev@gmail.com>
1 parent d6b2f42 commit c17c5f0

23 files changed

Lines changed: 182 additions & 110 deletions

‎openstackclient/network/v2/address_group.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,13 +151,14 @@ def get_parser(self, prog_name):
151151
parser.add_argument(
152152
'--name',
153153
metavar='<name>',
154-
help=_("List only address groups of given name in output"),
154+
help=_("List only address groups with the specified name"),
155155
)
156156
parser.add_argument(
157157
'--project',
158158
metavar="<project>",
159159
help=_(
160-
"List address groups according to their project (name or ID)"
160+
"List only address groups with the specified project "
161+
"(name or ID)"
161162
),
162163
)
163164
identity_common.add_project_domain_option_to_parser(parser)

‎openstackclient/network/v2/address_scope.py‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ def get_parser(self, prog_name):
160160
parser.add_argument(
161161
'--name',
162162
metavar='<name>',
163-
help=_("List only address scopes of given name in output"),
163+
help=_("List only address scopes with the specified name"),
164164
)
165165
parser.add_argument(
166166
'--ip-version',
@@ -169,14 +169,16 @@ def get_parser(self, prog_name):
169169
metavar='<ip-version>',
170170
dest='ip_version',
171171
help=_(
172-
"List address scopes of given IP version networks (4 or 6)"
172+
"List only address scopes with the specified IP version "
173+
"networks (4 or 6)"
173174
),
174175
)
175176
parser.add_argument(
176177
'--project',
177178
metavar="<project>",
178179
help=_(
179-
"List address scopes according to their project (name or ID)"
180+
"List only address scopes with the specified project "
181+
"(name or ID)"
180182
),
181183
)
182184
identity_common.add_project_domain_option_to_parser(parser)
@@ -185,12 +187,12 @@ def get_parser(self, prog_name):
185187
shared_group.add_argument(
186188
'--share',
187189
action='store_true',
188-
help=_("List address scopes shared between projects"),
190+
help=_("List only address scopes shared between projects"),
189191
)
190192
shared_group.add_argument(
191193
'--no-share',
192194
action='store_true',
193-
help=_("List address scopes not shared between projects"),
195+
help=_("List only address scopes not shared between projects"),
194196
)
195197
return parser
196198

‎openstackclient/network/v2/default_security_group_rule.py‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -300,7 +300,8 @@ def get_parser(self, prog_name):
300300
metavar='<protocol>',
301301
type=network_utils.convert_to_lowercase,
302302
help=_(
303-
"List rules by the IP protocol (ah, dhcp, egp, esp, gre, "
303+
"List only default rules with the specified IP protocol "
304+
"(ah, dhcp, egp, esp, gre, "
304305
"icmp, igmp, ipv6-encap, ipv6-frag, ipv6-icmp, "
305306
"ipv6-nonxt, ipv6-opts, ipv6-route, ospf, pgm, rsvp, "
306307
"sctp, tcp, udp, udplite, vrrp and integer "
@@ -319,15 +320,15 @@ def get_parser(self, prog_name):
319320
'--ingress',
320321
action='store_true',
321322
help=_(
322-
"List default rules which will be applied to incoming "
323+
"List only default rules which will be applied to incoming "
323324
"network traffic"
324325
),
325326
)
326327
direction_group.add_argument(
327328
'--egress',
328329
action='store_true',
329330
help=_(
330-
"List default rules which will be applied to outgoing "
331+
"List only default rules which will be applied to outgoing "
331332
"network traffic"
332333
),
333334
)

‎openstackclient/network/v2/floating_ip.py‎

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ def update_parser_network(self, parser):
247247
action='append',
248248
help=self.enhance_help_neutron(
249249
_(
250-
"List floating IP(s) according to given network "
250+
"List only floating IP(s) with the specified network "
251251
"(name or ID) "
252252
"(repeat option to fiter on multiple networks)"
253253
)
@@ -260,7 +260,8 @@ def update_parser_network(self, parser):
260260
action='append',
261261
help=self.enhance_help_neutron(
262262
_(
263-
"List floating IP(s) according to given port (name or ID) "
263+
"List only floating IP(s) with the specified port "
264+
"(name or ID) "
264265
"(repeat option to fiter on multiple ports)"
265266
)
266267
),
@@ -269,14 +270,20 @@ def update_parser_network(self, parser):
269270
'--fixed-ip-address',
270271
metavar='<ip-address>',
271272
help=self.enhance_help_neutron(
272-
_("List floating IP(s) according to given fixed IP address")
273+
_(
274+
"List only floating IP(s) with the specified fixed IP "
275+
"address"
276+
)
273277
),
274278
)
275279
parser.add_argument(
276280
'--floating-ip-address',
277281
metavar='<ip-address>',
278282
help=self.enhance_help_neutron(
279-
_("List floating IP(s) according to given floating IP address")
283+
_(
284+
"List only floating IP(s) with the specified floating IP "
285+
"address"
286+
)
280287
),
281288
)
282289
parser.add_argument(
@@ -285,8 +292,8 @@ def update_parser_network(self, parser):
285292
choices=['ACTIVE', 'DOWN'],
286293
help=self.enhance_help_neutron(
287294
_(
288-
"List floating IP(s) according to given status ('ACTIVE', "
289-
"'DOWN')"
295+
"List only floating IP(s) with the specified status "
296+
"('ACTIVE', 'DOWN')"
290297
)
291298
),
292299
)
@@ -295,8 +302,8 @@ def update_parser_network(self, parser):
295302
metavar='<project>',
296303
help=self.enhance_help_neutron(
297304
_(
298-
"List floating IP(s) according to given project "
299-
"(name or ID) "
305+
"List only floating IP(s) with the specified project "
306+
"(name or ID)"
300307
)
301308
),
302309
)
@@ -308,7 +315,7 @@ def update_parser_network(self, parser):
308315
action='append',
309316
help=self.enhance_help_neutron(
310317
_(
311-
"List floating IP(s) according to given router "
318+
"List only floating IP(s) with the specified router "
312319
"(name or ID) "
313320
"(repeat option to fiter on multiple routers)"
314321
)

‎openstackclient/network/v2/floating_ip_port_forwarding.py‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -265,23 +265,26 @@ def get_parser(self, prog_name):
265265
'--port',
266266
metavar='<port>',
267267
help=_(
268-
"Filter the list result by the ID or name of "
269-
"the internal network port"
268+
"List only floating IP port forwardings with the "
269+
"specified internal network port (name or ID)"
270270
),
271271
)
272272
parser.add_argument(
273273
'--external-protocol-port',
274274
metavar='<port-number>',
275275
dest='external_protocol_port',
276276
help=_(
277-
"Filter the list result by the "
278-
"protocol port number of the floating IP"
277+
"List only floating IP port forwardings with the "
278+
"specified external protocol port number"
279279
),
280280
)
281281
parser.add_argument(
282282
'--protocol',
283283
metavar='<protocol>',
284-
help=_("Filter the list result by the port protocol"),
284+
help=_(
285+
"List only floating IP port forwardings with the "
286+
"specified protocol number"
287+
),
285288
)
286289

287290
return parser

‎openstackclient/network/v2/ip_availability.py‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,17 @@ def get_parser(self, prog_name):
4747
metavar='<ip-version>',
4848
dest='ip_version',
4949
help=_(
50-
"List IP availability of given IP version "
51-
"networks (default is 4)"
50+
"List only IP availability with the specified IP version "
51+
"networks (4 or 6, default is 4)"
5252
),
5353
)
5454
parser.add_argument(
5555
'--project',
5656
metavar='<project>',
57-
help=_("List IP availability of given project (name or ID)"),
57+
help=_(
58+
"List only IP availability with the specified project "
59+
"(name or ID)"
60+
),
5861
)
5962
identity_common.add_project_domain_option_to_parser(parser)
6063
return parser

‎openstackclient/network/v2/l3_conntrack_helper.py‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -150,19 +150,26 @@ def get_parser(self, prog_name):
150150
parser.add_argument(
151151
'--helper',
152152
metavar='<helper>',
153-
help=_('The netfilter conntrack helper module'),
153+
help=_(
154+
'List only helpers using the specified netfilter conntrack '
155+
'helper module'
156+
),
154157
)
155158
parser.add_argument(
156159
'--protocol',
157160
metavar='<protocol>',
158161
help=_(
159-
'The network protocol for the netfilter conntrack target rule'
162+
'List only helpers with the specified network protocol for '
163+
'the netfilter conntrack target rule'
160164
),
161165
)
162166
parser.add_argument(
163167
'--port',
164168
metavar='<port>',
165-
help=_('The network port for the netfilter conntrack target rule'),
169+
help=_(
170+
'List only helpers with the specified network port for '
171+
'the netfilter conntrack target rule (name or ID)'
172+
),
166173
)
167174

168175
return parser

‎openstackclient/network/v2/local_ip.py‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -198,32 +198,38 @@ def get_parser(self, prog_name):
198198
parser.add_argument(
199199
'--name',
200200
metavar='<name>',
201-
help=_("List only Local IPs of given name in output"),
201+
help=_("List only local IP(s) with the specified name"),
202202
)
203203
parser.add_argument(
204204
'--project',
205205
metavar="<project>",
206-
help=_("List Local IPs according to their project (name or ID)"),
206+
help=_(
207+
"List only local IP(s) with the specified project (name or ID)"
208+
),
207209
)
208210
parser.add_argument(
209211
'--network',
210212
metavar='<network>',
211-
help=_("List Local IP(s) according to given network (name or ID)"),
213+
help=_(
214+
"List only local IP(s) with the specified network (name or ID)"
215+
),
212216
)
213217
parser.add_argument(
214218
'--local-port',
215219
metavar='<local-port>',
216-
help=_("List Local IP(s) according to given port (name or ID)"),
220+
help=_(
221+
"List only local IP(s) with the specified port (name or ID)"
222+
),
217223
)
218224
parser.add_argument(
219225
'--local-ip-address',
220226
metavar='<local-ip-address>',
221-
help=_("List Local IP(s) according to given Local IP Address"),
227+
help=_("List only local IP(s) with the specified IP address"),
222228
)
223229
parser.add_argument(
224230
'--ip-mode',
225231
metavar='<ip_mode>',
226-
help=_("List Local IP(s) according to given IP mode"),
232+
help=_("List only local IP(s) with the specified IP mode"),
227233
)
228234

229235
identity_common.add_project_domain_option_to_parser(parser)

‎openstackclient/network/v2/local_ip_association.py‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -150,18 +150,21 @@ def get_parser(self, prog_name):
150150
'--fixed-port',
151151
metavar='<fixed-port>',
152152
help=_(
153-
"Filter the list result by the ID or name of the fixed port"
153+
"List only local IP assocations with the specified fixed IP "
154+
"port (name or ID)"
154155
),
155156
)
156157
parser.add_argument(
157158
'--fixed-ip',
158159
metavar='<fixed-ip>',
159-
help=_("Filter the list result by fixed ip"),
160+
help=_(
161+
"List only local IP associations with the specified fixed IP"
162+
),
160163
)
161164
parser.add_argument(
162165
'--host',
163166
metavar='<host>',
164-
help=_("Filter the list result by given host"),
167+
help=_("List only local IP associations with the specified host"),
165168
)
166169
identity_common.add_project_domain_option_to_parser(parser)
167170

‎openstackclient/network/v2/ndp_proxy.py‎

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -143,30 +143,37 @@ def get_parser(self, prog_name):
143143
'--router',
144144
metavar='<router>',
145145
help=_(
146-
"List only NDP proxies belonging to this router (name or ID)"
146+
"List only NDP proxies associated with the specifed router "
147+
"(name or ID)"
147148
),
148149
)
149150
parser.add_argument(
150151
'--port',
151152
metavar='<port>',
152153
help=_(
153-
"List only NDP proxies associated to this port (name or ID)"
154+
"List only NDP proxies associated with the specified port "
155+
"(name or ID)"
154156
),
155157
)
156158
parser.add_argument(
157159
'--ip-address',
158160
metavar='<ip-address>',
159-
help=_("List only NDP proxies associated to this IPv6 address"),
161+
help=_(
162+
"List only NDP proxies associated with the specified "
163+
"IPv6 address"
164+
),
160165
)
161166
parser.add_argument(
162167
'--project',
163168
metavar='<project>',
164-
help=_("List only NDP proxies of given project (name or ID)"),
169+
help=_(
170+
"List only NDP proxies with the specified project (name or ID)"
171+
),
165172
)
166173
parser.add_argument(
167174
'--name',
168175
metavar='<name>',
169-
help=_("List only NDP proxies of given name"),
176+
help=_("List only NDP proxies with the specified name"),
170177
)
171178

172179
identity_common.add_project_domain_option_to_parser(parser)

0 commit comments

Comments
 (0)