Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

All commands that users are expected to invoke should have manual pages. The manual pages should be up to date and accurate. Manual pages should be installed and shipped in source and binary distributions. The traffic_line subcommands should be coalesced into a single page. It's unlikely that anyone doing "man exit" is looking for the traffic_line subcommand.

Commands should be "self-documenting" as much as possible.

Configuration files should have man pages.

Finally, the html-ized version of the man pages should be linked from the administration guide and accessible from trafficserver.apache.org/docs.

https://issues.apache.org/jira/browse/TS-764

Command option consistency

...

All content that users should not directly interact with should not be in the $PATH. This means that commands like traffic_server should move to libexec.

Renaming user commands

Bundled plugins

Plugins should have their own man pages documenting behaviour and configuration.I would like to rename some of the commands, eg. traffic_sac. This raises a binary compatibility problem that might not be surmountable. Generating consensus will be a problem (smile)