diff options
| author | Daniel Pittman <daniel@rimspace.net> | 2011-02-03 16:19:03 -0800 |
|---|---|---|
| committer | Daniel Pittman <daniel@rimspace.net> | 2011-02-03 16:21:15 -0800 |
| commit | 04ea8269e70e9c1f81394ac6da2b48dcfb49b1d5 (patch) | |
| tree | cddea679f2c1ad1195017e429d08dcc83655c54e | |
| parent | 7a061409bd0490e5a9ef11a68260deb4f6e3b7ab (diff) | |
| download | puppet-04ea8269e70e9c1f81394ac6da2b48dcfb49b1d5.tar.gz puppet-04ea8269e70e9c1f81394ac6da2b48dcfb49b1d5.tar.xz puppet-04ea8269e70e9c1f81394ac6da2b48dcfb49b1d5.zip | |
(#5823) document the not-an-API status of set_run_mode
Since this is totally not API, document that in big, threatening letters so
that folks actually know what is going on. Include promises so they don't
feel too unhappy with us.
Paired-with: matt@puppetlabs.com
| -rw-r--r-- | lib/puppet/application.rb | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/lib/puppet/application.rb b/lib/puppet/application.rb index b944a554e..c3d7355f6 100644 --- a/lib/puppet/application.rb +++ b/lib/puppet/application.rb @@ -270,6 +270,13 @@ class Application require 'puppet' end + # WARNING: This is a totally scary, frightening, and nasty internal API. We + # strongly advise that you do not use this, and if you insist, we will + # politely allow you to keep both pieces of your broken code. + # + # We plan to provide a supported, long-term API to deliver this in a way + # that you can use. Please make sure that you let us know if you do require + # this, and this message is still present in the code. --daniel 2011-02-03 def set_run_mode(mode) @run_mode = mode $puppet_application_mode = @run_mode |