Document client provided tags feature in the client manpage

Bug #496626 reported by Andreas Hasenack
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Landscape Client
Fix Released
Low
Andreas Hasenack

Bug Description

The landscape-client manpage (and/or landscape-config) should mention the new tag command line option.

Related branches

tags: added: needs-doc
Changed in landscape:
milestone: none → 1.4.3
affects: landscape → landscape-client
Changed in landscape-client:
assignee: nobody → Andreas Hasenack (ahasenack)
milestone: 1.4.3 → none
affects: landscape-client → landscape
affects: landscape → landscape-client
visibility: private → public
Changed in landscape-client:
milestone: none → 1.4.3
Revision history for this message
Andreas Hasenack (ahasenack) wrote :

I also took the liberty of updating the other manpages.

For review, it's easier to review the changes in the .txt files

tags: added: review
Changed in landscape-client:
status: New → In Progress
importance: Undecided → Low
Revision history for this message
Kevin McDermott (bigkevmcd) wrote :

+ -k SSL_PUBLIC_KEY, --ssl-public-key=SSL_PUBLIC_KEY The public SSL key to
+ verify the server. Only used if the given URL is
+ https.

This is actually the certificate, not the public key (it's a really badly named option), and "the given URL" which one?

We don't support non-HTTPS connections to Landscape, so providing a non-HTTPS transport URL to the client won't work.

+ --cloud Set this if your computer is in an EC2 cloud.

I'd be concerned that there's more to this than just adding --cloud to the configuration script.

Kevin

Revision history for this message
Jamu Kakar (jkakar) wrote :

[1]

+OPTIONS
+ --version show program's version number and exit
+ -h, --help show this help message and exit

'show' in the descript should be 'Show'. Also, I don't know if it
matters, but there's trailing whitespace in some of the .txt files.

[2]

I wonder if we should include the default values in option
descriptions?

Thanks for cleaning this up, +1!

tags: removed: review
Revision history for this message
Andreas Hasenack (ahasenack) wrote :

Kevin:

[1]

Done. I also looked into renaming that option to --ssl-ca-certificate instead of --ssl-public-key, but that implies in code changes in a lot of places, and there is also an upgrade path to consider. If we think it's worth it, I can give it a try in another ticket, probably making both options work as synonyms but marking the --ssl-public-key one as deprecated.

[2]

done

Jamu:

[1]

Done

[2]

Done, I added defaults to the help text and manpages. Maybe even to some options we don't really want people messing with, as Kevin mentioned in IRC.

Please re-review

tags: added: review
Changed in landscape-client:
milestone: 1.4.3 → 1.4.4
Revision history for this message
Jamu Kakar (jkakar) wrote :
Sidnei da Silva (sidnei)
tags: removed: review
Changed in landscape-client:
status: In Progress → Fix Committed
tags: removed: needs-doc
tags: added: needs-testing
Revision history for this message
Andreas Hasenack (ahasenack) wrote :

Tested with staging packages.

tags: removed: needs-testing
Changed in landscape-client:
status: Fix Committed → Fix Released
Changed in landscape-client:
status: Fix Released → Fix Committed
Changed in landscape-client:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.