README.md in puppet-lint-absolute_classname-check-0.2.4 vs README.md in puppet-lint-absolute_classname-check-0.2.5
- old
+ new
@@ -1,13 +1,13 @@
puppet-lint-absolute_classname-check
====================================
-[![Build Status](https://img.shields.io/travis/puppet-community/puppet-lint-absolute_classname-check.svg)](https://travis-ci.org/puppet-community/puppet-lint-absolute_classname-check)
+[![Build Status](https://img.shields.io/travis/voxpupuli/puppet-lint-absolute_classname-check.svg)](https://travis-ci.org/voxpupuli/puppet-lint-absolute_classname-check)
[![Gem Version](https://img.shields.io/gem/v/puppet-lint-absolute_classname-check.svg)](https://rubygems.org/gems/puppet-lint-absolute_classname-check)
[![Gem Downloads](https://img.shields.io/gem/dt/puppet-lint-absolute_classname-check.svg)](https://rubygems.org/gems/puppet-lint-absolute_classname-check)
-[![Coverage Status](https://img.shields.io/coveralls/puppet-community/puppet-lint-absolute_classname-check.svg)](https://coveralls.io/r/puppet-community/puppet-lint-absolute_classname-check?branch=master)
-[![Gemnasium](https://img.shields.io/gemnasium/puppet-community/puppet-lint-absolute_classname-check.svg)](https://gemnasium.com/puppet-community/puppet-lint-absolute_classname-check)
+[![Coverage Status](https://img.shields.io/coveralls/voxpupuli/puppet-lint-absolute_classname-check.svg)](https://coveralls.io/r/voxpupuli/puppet-lint-absolute_classname-check?branch=master)
+[![Gemnasium](https://img.shields.io/gemnasium/voxpupuli/puppet-lint-absolute_classname-check.svg)](https://gemnasium.com/voxpupuli/puppet-lint-absolute_classname-check)
[![Donated by Camptocamp](https://img.shields.io/badge/donated%20by-camptocamp-fb7047.svg)](#transfer-notice)
A puppet-lint plugin to check that classes are included by their absolute name.
## Installing
@@ -26,11 +26,11 @@
## Checks
### Relative class name inclusion
-Including a class by a relative name might lead to unexpected results.
+Including a class by a relative name might lead to unexpected results [in Puppet 3](https://docs.puppet.com/puppet/3/lang_namespaces.html#relative-name-lookup-and-incorrect-name-resolution). This plugin is **not** recommended for use with Puppet code that has dropped support for Puppet 3 (EOL 20161231).
#### What you have done
```puppet
include foobar
@@ -42,19 +42,19 @@
include ::foobar
```
#### Disabling the check
-To disable this check, you can add `--no-absolute_classname-check` to your puppet-lint command line.
+To disable this check, you can add `--no-relative_classname_inclusion-check` to your puppet-lint command line.
```shell
-$ puppet-lint --no-absolute_classname-check path/to/file.pp
+$ puppet-lint --no-relative_classname_inclusion-check path/to/file.pp
```
Alternatively, if you’re calling puppet-lint via the Rake task, you should insert the following line to your `Rakefile`.
```ruby
-PuppetLint.configuration.send('disable_absolute_classname')
+PuppetLint.configuration.send('disable_relative_classname_inclusion')
```
## Transfer Notice
This plugin was originally authored by [Camptocamp](http://www.camptocamp.com).