Modify

Opened 4 years ago

Closed 4 years ago

#12691 closed enhancement (fixed)

Shorten help text so that it doesn't wrap

Reported by: Ryan J Ollos Owned by: Jun Omae
Priority: lowest Component: TracMigratePlugin
Severity: normal Keywords:
Cc: Trac Release:

Description

Here is truncated output from trac-admin $env help:

trac-admin - The Trac Administration Console 1.0.10

Usage: trac-admin </path/to/projenv> [command [subcommand] [option ...]]

Invoking trac-admin without command starts interactive mode.

help                 Show documentation
initenv              Create and initialize a new environment
attachment add       Attach a file to a resource
attachment export    Export an attachment from a resource to a file or stdout
attachment list      List attachments of a resource
attachment remove    Remove an attachment from a resource
changeset added      Notify trac about changesets added to a repository
changeset modified   Notify trac about changesets modified in a repository
component add        Add a new component
component chown      Change component ownership
component list       Show available components
component remove     Remove/uninstall a component
component rename     Rename a component
config get           Get the value of the given option in "trac.ini"
config remove        Remove the specified option from "trac.ini"
config set           Set the value for the given option in "trac.ini"
deploy               Extract static resources from Trac and all plugins
hotcopy              Make a hot backup copy of an environment
migrate              Migrate to new environment with another database or another
 database without creating a new environment.
milestone add        Add milestone
milestone completed  Set milestone complete date
milestone due        Set milestone due date
milestone list       Show milestones
milestone remove     Remove milestone
milestone rename     Rename milestone
permission add       Add a new permission rule
permission export    Export permission rules to a file or stdout as CSV
permission import    Import permission rules from a file or stdin as CSV
permission list      List permission rules
permission remove    Remove a permission rule
priority add         Add a priority value option
priority change      Change a priority value
priority list        Show possible ticket priorities
priority order       Move a priority value up or down in the list
priority remove      Remove a priority value
repository add       Add a source repository
...

It would be good to shorten the help text for migrate so that it doesn't wrap on an 80-char terminal.

Attachments (0)

Change History (4)

comment:1 Changed 4 years ago by Jun Omae

Okay. I'll fix it. However, it might be over 80 columns if one of plugin provides long long command names. Ideally, Trac core should wrap the help text to 80 columns.

comment:2 in reply to:  1 ; Changed 4 years ago by Ryan J Ollos

Replying to jun66j5:

Ideally, Trac core should wrap the help text to 80 columns.

Yeah, that sounds like a good improvement for the core.

comment:3 in reply to:  2 Changed 4 years ago by Ryan J Ollos

Replying to rjollos:

Replying to jun66j5:

Ideally, Trac core should wrap the help text to 80 columns.

Yeah, that sounds like a good improvement for the core.

Created trac:#12388.

comment:4 Changed 4 years ago by Jun Omae

Resolution: fixed
Status: newclosed

In 15434:

TracMigratePlugin: shorten first line in help text within 80 columns (closes #12691)

Modify Ticket

Change Properties
Set your email in Preferences
Action
as closed The owner will remain Jun Omae.
The resolution will be deleted. Next status will be 'reopened'.

Add Comment


E-mail address and name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.