Skip to content

Commit

Permalink
Expand further on the documentation Dolmen submitted.
Browse files Browse the repository at this point in the history
  • Loading branch information
kentfredric committed May 20, 2016
1 parent d7f2330 commit 61564cb
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.mkdn
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,28 @@ These can be overridden when consuming a bundle in `dist.ini`

# LIMITATIONS

## Self References in develop\_requires

If you bundle plugins with your bundle, and use those plugins in the bundle,
you'll risk a self-reference problem, which may be solved in a future release of Dist::Zilla.

Until then, you'll need to possibly use [`[RemovePrereqs]`](https://metacpan.org/pod/Dist::Zilla::Plugin::RemovePrereqs)
to trim self-references.

## Bootstrap problems on Bundles

When using your bundle to ship itself, the use of this role can imply some confusion if the role is not installed,
as `dzil listdeps` will require this role present to work.

It is subsequently recommended to state an explicit `AuthorDep` in `dist.ini` to avoid this.

[Bootstrap::lib]

[@Author::MyBundle]
; authordep Dist::Zilla::Role::BundleDeps
bundledeps_phase = runtime
bundledeps_relationship = requires

# SEE ALSO

[`[BundleInspector]`](https://metacpan.org/pod/Dist::Zilla::Plugin::BundleInspector)
Expand Down
16 changes: 16 additions & 0 deletions lib/Dist/Zilla/Role/BundleDeps.pm
Original file line number Diff line number Diff line change
Expand Up @@ -127,12 +127,28 @@ by standing between your C<bundle_config> method and C<Dist::Zilla>
=head1 LIMITATIONS
=head2 Self References in develop_requires
If you bundle plugins with your bundle, and use those plugins in the bundle,
you'll risk a self-reference problem, which may be solved in a future release of Dist::Zilla.
Until then, you'll need to possibly use L<< C<[RemovePrereqs]>|Dist::Zilla::Plugin::RemovePrereqs >>
to trim self-references.
=head2 Bootstrap problems on Bundles
When using your bundle to ship itself, the use of this role can imply some confusion if the role is not installed,
as C<dzil listdeps> will require this role present to work.
It is subsequently recommended to state an explicit C<AuthorDep> in C<dist.ini> to avoid this.
[Bootstrap::lib]
[@Author::MyBundle]
; authordep Dist::Zilla::Role::BundleDeps
bundledeps_phase = runtime
bundledeps_relationship = requires
=head1 SEE ALSO
L<< C<[BundleInspector]>|Dist::Zilla::Plugin::BundleInspector >>
Expand Down

0 comments on commit 61564cb

Please sign in to comment.