juju-core

add help topics for jujud tools

Bug #1186969 reported by Andreas Hasenack
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
juju-core
Fix Released
High
Andrew Wilkins
juju-core 1.14.0

Bug Description

Given that it's hard to get the --help output from the juju tools themselves (see https://lists.ubuntu.com/archives/juju-dev/2013-May/001064.html), this bug is to request a juju command called "help-tool" that would print out the help of the requested tool. The idea is from Niemeyer.

So, instead of calling (the now basically impossible):

  relation-get --help

you would call, on your own machine or wherever the juju-core package is installed:

  juju help relation-get

This would use the built in help topics (see 'juju help topics')

See original description

Related branches

lp://staging/~axwalk/juju-core/lp1186969-add-jujud-tools-help
Juju Engineering: Pending requested
Diff: 202 lines (+171/-0)
4 files modified
cmd/juju/helptool.go (+104/-0)
cmd/juju/helptool_test.go (+63/-0)
cmd/juju/main.go (+3/-0)
cmd/juju/main_test.go (+1/-0)
Revision history for this message
William Reade (fwereade) wrote :

This mitigates the current lack of debug-hooks and/or juju-run and has a lot of value relative to its cost.

Changed in juju-core:
status: New → Triaged
importance: Undecided → High
tags: added: bitesize cli
Revision history for this message
Tim Penhey (thumper) wrote :

This could be trivially (?) added by using the help topics.

summary: - juju help-tool <toolname>
+ add help topics for jujud tools
description: updated
Andrew Wilkins (axwalk)
Changed in juju-core:
assignee: nobody → Andrew Wilkins (axwalk)
Revision history for this message
Andrew Wilkins (axwalk) wrote :

I think it would be better for this to live in jujud, given that that's the binary that contains the commands. cmd/juju doesn't currently have a dependency on the worker/uniter/jujuc package, which is where the tools live. Adding static help to cmd/juju doesn't sound great.

I'm currently modify cmd/jujud to allow:
 - jujud help tools (lists tools, in the same format as "help commands").
 - jujud help <tool> (describes tool, in the same format as "help <command>").
Both are implemented as help topics.

Revision history for this message
Andrew Wilkins (axwalk) wrote :

This has the undesirable consequence of adding a topic for every tool though... investigating what other options there are.

Andrew Wilkins (axwalk)
Changed in juju-core:
milestone: none → dev-docs
status: Triaged → In Progress
Andrew Wilkins (axwalk)
Changed in juju-core:
milestone: dev-docs → none
Andrew Wilkins (axwalk)
Changed in juju-core:
status: In Progress → Fix Committed
Curtis Hovey (sinzui)
Changed in juju-core:
milestone: none → 1.14.0
status: Fix Committed → Fix Released
Andreas Hasenack (ahasenack)
tags: added: landscape
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

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