-
Notifications
You must be signed in to change notification settings - Fork 65
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Break out docs into new structure, and add --man=faq and --man=cookbook options #5
Comments
This may not work out so well. I'm looking into Pod::Usage and its rules. http://search.cpan.org/~marekr/Pod-Usage-1.69/lib/Pod/Usage.pm |
ack-standalone has to work on itself without loading any external .pm files. Write a .t file to make sure |
Some options are loaded in ack, and some in App::Ack::ConfigLoader. Remove any extraneous stuff in ConfigLoader. |
The docs have been broken out in 81ce3cd but there are still problems to fix.
t/ack-man.t is TODOed because of these questions. |
Yes, we need to use perldoc / Pod::Usage. |
This split-up form of manual also will help us with the ack3 redesign where we will have different HTML pages for different manual sections. |
I have the --man, --faq and --cookbook working for ack-standalone, but ack-man.t fails. |
Looks like perldoc isn't happy about the removal of $ENV{PATH}. Needs more exploration. |
Remaining problems are now in #122. |
I've found it very difficult to maintain docs in
ack
. We also need more granular docs.Create a new doc structure
App::Ack::Docs::*
. To start with, we'll haveAll these docs will need to get put into the ack standalone. They'll get put at the end of the file during squashing.
The
ack --man
switch will now take arguments, so you can sayack --man=faq
andack --man=cookbook
.The text was updated successfully, but these errors were encountered: