yahoo-eng-team team mailing list archive

[Samuel Matzek <smatzek@xxxxxxxxxx>]

Public bug reported:

I know of two examples in the documentation that contain dashes in
config keys when they need to be underscores to function at runtime.

Following the examples in this case can lead to a lot of wasted time and
the dash vs underscore difference can be easy to miss, even when looking
at the code to see why things aren't working.

The two locations that have caused problems are:
http://bazaar.launchpad.net/~cloud-init-dev/cloud-init/trunk/view/head:/doc/examples/cloud-config-resolv-conf.txt

In this example manage-resolv-conf should be manage_resolv_conf since
that is what the module is really looking for.

and
http://bazaar.launchpad.net/~cloud-init-dev/cloud-init/trunk/view/head:/doc/examples/cloud-config-user-groups.txt

This user/groups example has 3 occurrences of lock-passwd that should be lock_passwd
This particular one is very frustrating when you hit it because when you hit it you're usually trying to set lock_passwd to False because you have some need to log into the account using a password but when you specify anything on lock-passwd the value of lock_passwd still defaults to True and locks you out.

** Affects: cloud-init
     Importance: Undecided
         Status: New

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to cloud-init.
https://bugs.launchpad.net/bugs/1531582

Title:
  Some examples in documentation incorrectly contain dashes vs
  underscores

Status in cloud-init:
  New

Bug description:
  I know of two examples in the documentation that contain dashes in
  config keys when they need to be underscores to function at runtime.

  Following the examples in this case can lead to a lot of wasted time
  and the dash vs underscore difference can be easy to miss, even when
  looking at the code to see why things aren't working.

  The two locations that have caused problems are:
  http://bazaar.launchpad.net/~cloud-init-dev/cloud-init/trunk/view/head:/doc/examples/cloud-config-resolv-conf.txt

  In this example manage-resolv-conf should be manage_resolv_conf since
  that is what the module is really looking for.

  and
  http://bazaar.launchpad.net/~cloud-init-dev/cloud-init/trunk/view/head:/doc/examples/cloud-config-user-groups.txt

  This user/groups example has 3 occurrences of lock-passwd that should be lock_passwd
  This particular one is very frustrating when you hit it because when you hit it you're usually trying to set lock_passwd to False because you have some need to log into the account using a password but when you specify anything on lock-passwd the value of lock_passwd still defaults to True and locks you out.

To manage notifications about this bug go to:
https://bugs.launchpad.net/cloud-init/+bug/1531582/+subscriptions