Skip to content

Commit

Permalink
Move down known issues
Browse files Browse the repository at this point in the history
  • Loading branch information
kentfredric committed Jun 6, 2016
1 parent 03ae80b commit 78c1547
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 24 deletions.
1 change: 1 addition & 0 deletions Changes
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Release history for Dist-Zilla-App-Command-dumpwith

{{$NEXT}}
- Documentation: Update screenshots to reflect new notation.
- Documentation: Move KNOWN ISSUES further down.

0.003000 2016-05-28T16:13:51Z 2b26a07
- Add support for "--" escaping to isolate the role names to avoid complications introduced by '-V' becomming a thing
Expand Down
44 changes: 22 additions & 22 deletions README.mkdn
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,28 @@ If you are using an HTML-enabled POD viewer, you should see a screenshot of this
</center>
</div>

# DESCRIPTION

This command, like its sibling [`dumpphases`](https://metacpan.org/pod/Dist::Zilla::App::Command::dumpphases), exists to help make understanding
what is going on in `Dist::Zilla` a little easier.

At least, having this command means debugging certain kinds of problems is more obvious.

If you want to see all plugins that are adding files to your dist?

dzil dumpwith -- -FileGatherer

Though, of course, this requires some knowledge of what roles are applicable.

If you want to turn colors off, use [`Term::ANSIcolor`'s environment variable](https://metacpan.org/pod/Term::ANSIColor)
`ANSI_COLORS_DISABLED`. E.g.,

ANSI_COLORS_DISABLED=1 dzil dumpphases

Alternatively, specify a color-free theme:

dzil dumpwith --color-theme=basic::plain -- -VersionProvider

# KNOWN ISSUES

Prior to `Dist::Zilla 6.0`, the format
Expand All @@ -50,28 +72,6 @@ Or place all the role names (and only role names) after a `--`
Any suggestions welcome for how I can detect this problem case happening and report it,
but the data appears now outside of a scope I can probe.

# DESCRIPTION

This command, like its sibling [`dumpphases`](https://metacpan.org/pod/Dist::Zilla::App::Command::dumpphases), exists to help make understanding
what is going on in `Dist::Zilla` a little easier.

At least, having this command means debugging certain kinds of problems is more obvious.

If you want to see all plugins that are adding files to your dist?

dzil dumpwith -- -FileGatherer

Though, of course, this requires some knowledge of what roles are applicable.

If you want to turn colors off, use [`Term::ANSIcolor`'s environment variable](https://metacpan.org/pod/Term::ANSIColor)
`ANSI_COLORS_DISABLED`. E.g.,

ANSI_COLORS_DISABLED=1 dzil dumpphases

Alternatively, specify a color-free theme:

dzil dumpwith --color-theme=basic::plain -- -VersionProvider

# AUTHOR

Kent Fredric <kentnl@cpan.org>
Expand Down
4 changes: 4 additions & 0 deletions lib/Dist/Zilla/App/Command/dumpwith.pm
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,8 @@ If you are using an HTML-enabled POD viewer, you should see a screenshot of this
( Everyone else can visit L<http://kentnl.github.io/screenshots/Dist-Zilla-App-Command-dumpwith/0.003000/example_01.png> )
=begin :screenshot
=begin html
<center>
Expand All @@ -179,6 +181,8 @@ If you are using an HTML-enabled POD viewer, you should see a screenshot of this
=end html
=end :screenshot
=head1 DESCRIPTION
This command, like its sibling L<< C<dumpphases>|Dist::Zilla::App::Command::dumpphases >>, exists to help make understanding
Expand Down
4 changes: 2 additions & 2 deletions weaver.ini
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[Region / prelude]

[Generic / SYNOPSIS]
[Leftovers]
[Region / screenshot]

[Generic / DESCRIPTION]
[Generic / OVERVIEW]
Expand Down Expand Up @@ -40,7 +40,7 @@ command = p_attr
header = PRIVATE METHODS
command = p_method

;[Leftovers]
[Leftovers]

[Region / postlude]

Expand Down

0 comments on commit 78c1547

Please sign in to comment.