(#10940) Deprecate --apply in favor of --catalog

[kelseyhightower]

Without this patch, the puppet apply command uses the --apply option
to reference a Puppet catalog. This can cause a bit of confusion as both
the subcommand and option have the same name.

This patch improves the usability of the puppet apply command by
adding a new --catalog option. This patch also adds a deprecation
warning whenever the --apply option is used, which advises end-users
to use the --catalog option instead.

This patch updates the in-line help documentation by adding help output
for the new --catalog option, and adding a deprecation warning for the
--apply option.

The plan is to deprecate the --apply option in the next 2.7.x release,
and removal in the future. External documentation should be updated to
reflect the new preference towards using the --catalog option in-place
of --apply.

Preferred method of applying a Puppet catalog using puppet apply:

$ puppet apply --catalog <catalog>

This patch also includes the spec tests covering the changes in
behavior.

[stahnma]

On Fri, Nov 18, 2011 at 12:09 PM, Kelsey Hightower
reply@reply.github.com
wrote:

Without this patch, the puppet apply command uses the --apply option
to reference a Puppet catalog. This can cause a bit of confusion as both
the subcommand and option have the same name.

This patch improves the usability of the puppet apply command by
adding a new --catalog option. This patch also adds a deprecation
warning whenever the --apply option is used, which advises end-users
to use the --catalog option instead.

This patch updates the in-line help documentation by adding help output
for the new --catalog option, and adding a deprecation warning for the
--apply option.

The plan is to deprecate the --apply option in the next 2.7.x release,
and removal in 2.8. External documentation should be updated to reflect
the new preference towards using the --catalog option in-place of
--apply.

We need to carry deprecation warnings for at least 1 full major
version before removal.

Preferred method of applying a Puppet catalog using puppet apply:

   $ puppet apply --catalog

You can merge this Pull Request by running:

 git pull https://github.com/kelseyhightower/puppet ticket/master/10940_deprecate_apply_for_catalog

Or you can view, comment on it, or merge it online at:

 #227

-- Commit Summary --

• (#10940) Deprecate --apply in favor of --catalog

-- File Changes --

M lib/puppet/application/apply.rb (16)

-- Patch Links --

 https://github.com/puppetlabs/puppet/pull/227.patch
 https://github.com/puppetlabs/puppet/pull/227.diff

---

Reply to this email directly or view it on GitHub:
#227

[jhelwig]

Just to be a little more clear about @stahnma's comment: We won't be able to remove --apply until Telly + 1 at the earliest if this gets into 2.7 now (or if this goes into Telly before it is released, but not 2.7).

@kelseyhightower It looks like this was based on, and targeted at the master branch (Telly) from the name of your branch, and what the pull request is targeted at. I'm assuming that this is incorrect?