Uploaded image for project: 'Puppet'
  1. Puppet
  2. PUP-8445

Deprecate "puppet man"

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Closed
    • Priority: Normal
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: PUP 5.5.0
    • Component/s: None
    • Labels:
      None
    • Template:
    • Sub-team:
    • Team:
      Platform Core
    • Sprint:
      Platform Core KANBAN
    • Release Notes:
      Deprecation
    • Release Notes Summary:
      The 'puppet man' command is deprecated and will be removed in a future release. Please use 'puppet help <subcommand>' or the installed manpages 'man puppet-<subcommand>'
    • QA Risk Assessment:
      No Action

      Description

      The "puppet man" face application is being deprecated in favor of "puppet help", and direct usage of the shipped man pages.

      As such, we need to:

      • Add a deprecation message to "puppet man" and its documentation to alert users to this.
      • Remove references to "puppet man", "puppet man man", "man puppet-man", etc., and update them to point at "puppet help" or "man puppet-<thing>" if appropriate.
      • Add mentions of setting MANPATH (and what to set it to include) so that the shipped man pages can be accessed via the man command.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              kris.bosland Kris Bosland
              Reporter:
              jacob.helwig Jacob Helwig
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Zendesk Support