search

plone / plone.recipe.zope2instance

zc.buildout recipe to setup and configure a Zope 2 instance.
https://pypi.org/project/plone.recipe.zope2instance
7 stars 23 forks source link

Documentation of the scripts option is misleading #29

Closed rafaelbco closed 5 years ago

rafaelbco commented 7 years ago

The docs may lead to the impression that the user must include the eggs' names in the scripts option, in order to generate scripts for those eggs.

I found out this is wrong. What you need to do is add the scripts' names to the option AND also make sure the corresponding eggs are listed explicitly on the eggs option, even if an egg is a dependency of an already listed egg.

rafaelbco commented 7 years ago

Suggestion of text:

scripts

Add this parameter with no arguments to suppress script generation. Otherwise (i.e. without this parameter), scripts for packages added to the eggs parameter will be generated. You may also configure per script. E.g.:

[instance]
recipe = plone.recipe.zope2instance
eggs =
  Plone
  mr.migrator
  my.package
scripts = my_package_script

In the above example, only the my_package_script will be generated. Keep in mind that the egg containing the script (my.package in the example) must be listed explicitly in the eggs option, even if it's a dependency of an already listed egg.

gforcada commented 7 years ago

Would you mind creating a pull request? That will be far more easy to integrate 😃

rafaelbco commented 7 years ago

No problem. When I have the time ...

I like to fill issue reports quickly so I don't let the issue pass and later submit a PR.

Rafael Oliveira

On Fri, Aug 11, 2017 at 11:41 AM, Gil Forcada Codinachs < notifications@github.com> wrote:

Would you mind creating a pull request? That will be far more easy to integrate 😃

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/plone/plone.recipe.zope2instance/issues/29#issuecomment-321832177, or mute the thread https://github.com/notifications/unsubscribe-auth/ABCVOidhWFdCmBvPxbsQCbK9T56dAwM0ks5sXGgogaJpZM4OyNfm .

dataflake commented 5 years ago

This was fixed by e9807380a1561d36786da00d78dca5edf883eba9