Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[dev.icinga.com #10411] Documentation missing for icinga2 CLI commands. #3518

Closed
icinga-migration opened this issue Oct 20, 2015 · 10 comments
Closed
Labels
area/cli Command line helpers bug Something isn't working wontfix Deprecated, not supported or not worth any effort

Comments

@icinga-migration
Copy link

This issue has been migrated from Redmine: https://dev.icinga.com/issues/10411

Created by IcePic on 2015-10-20 20:54:14 +00:00

Assignee: (none)
Status: Closed (closed on 2016-12-08 00:11:30 +00:00)
Target Version: (none)
Last Update: 2017-01-14 13:09:08 +00:00 (in Redmine)

Icinga Version: I noticed it on a box with 2.3.3, but the webpage version is to me unknown.
Backport?: Not yet backported
Include in Changelog: 1

prompt$ icinga2 add node
will complain about missing parameters (ie, the hostname), but the --help version just says goes after the command and the webpage docs for icinga2 add node doesn't add any info to it, just shows what --help already told you.

From freenode IRC:
17:44 < IcePic> I sense a pattern. "icinga2 add node" says "needs argument",
add node --help does only say that arguments go after "add
node", and the webpage docs doesn't list what it takes either,
even if it was rather trivial to figure out it was the node
name.
17:47 < shroud> hm, you're right, this seems like something we should fix
17:47 < shroud> can you submit a ticket for that? :)
17:50 < shroud> in fact
17:51 < shroud> the positional arguments are missing for all commands (in
--help)


Parent Task: #13257

@icinga-migration
Copy link
Author

Updated by mfriedrich on 2016-02-24 22:40:29 +00:00

  • Category changed from Documentation to CLI
  • Status changed from New to Assigned
  • Assigned to set to jflach

@icinga-migration
Copy link
Author

Updated by mfriedrich on 2016-03-18 16:58:43 +00:00

  • Parent Id set to 11413

@icinga-migration
Copy link
Author

Updated by mfriedrich on 2016-11-25 14:29:38 +00:00

  • Parent Id deleted 11413

@icinga-migration
Copy link
Author

Updated by mfriedrich on 2016-12-08 00:11:30 +00:00

  • Status changed from Assigned to Closed
  • Assigned to deleted jflach

Not relevant anymore.

@icinga-migration
Copy link
Author

Updated by IcePic on 2016-12-10 08:55:40 +00:00

May I inquire on why this ticket was closed?
The site docs are still skeletal, so it would have been a reminder that if
the cmd-line help is all but missing, and the web is generated by running
the command --help, then that will be all but empty too.

2016-12-08 1:11 GMT+01:00 <development@icinga.org>:

Issue #10411 has been updated by mfriedrich.

Status changed from Assigned to Closed
Assignee deleted (jflach)

Not relevant anymore.


Bug #10411: Documentation missing for icinga2 CLI commands.
https://dev.icinga.org/issues/10411#change-58541

* Author: IcePic
* Status: Closed
* Priority: Normal
* Assignee:
* Category: CLI
* Target version:
* Icinga Version: I noticed it on a box with 2.3.3, but the webpage
version is to me unknown.
* Package Repository:
* Backport?: Not yet backported
* Include in Changelog: Yes

prompt$ icinga2 add node
will complain about missing parameters (ie, the hostname), but the --help
version just says goes after the command and the webpage docs
for icinga2 add node doesn't add any info to it, just shows what --help
already told you.

From freenode IRC:
17:44 < IcePic> I sense a pattern. "icinga2 add node" says "needs
argument",
add node --help does only say that arguments go after "add
node", and the webpage docs doesn't list what it takes
either,
even if it was rather trivial to figure out it was the node
name.
17:47 < shroud> hm, you're right, this seems like something we should fix
17:47 < shroud> can you submit a ticket for that? :)
17:50 < shroud> in fact
17:51 < shroud> the positional arguments are missing for all commands (in
--help)

--
You have received this notification because you have either subscribed to
it, or are involved in it.
To change your notification preferences, please click here:
https://dev.icinga.org

--
May the most significant bit of your life be positive.

@icinga-migration
Copy link
Author

Updated by mfriedrich on 2016-12-10 15:17:13 +00:00

"node add" and others are deprecated in 2.6. I missed to link the issue, sorry about that.

@icinga-migration
Copy link
Author

Updated by mfriedrich on 2016-12-10 15:17:20 +00:00

  • Relates set to 13255

@icinga-migration
Copy link
Author

Updated by mfriedrich on 2017-01-14 13:09:01 +00:00

  • Relates deleted 13255

@icinga-migration
Copy link
Author

Updated by mfriedrich on 2017-01-14 13:09:08 +00:00

  • Parent Id set to 13257

@icinga-migration icinga-migration added bug Something isn't working area/cli Command line helpers labels Jan 17, 2017
@dnsmichi dnsmichi added the wontfix Deprecated, not supported or not worth any effort label Feb 2, 2017
@dnsmichi
Copy link
Contributor

dnsmichi commented Feb 2, 2017

#4799

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/cli Command line helpers bug Something isn't working wontfix Deprecated, not supported or not worth any effort
Projects
None yet
Development

No branches or pull requests

2 participants