split up Mojolicious::Guides::Cheatsheet into more reference document…

…ation
mojolicious · Feb 26, 2012 · 1925cb9 · 1925cb9
1 parent 153f79b
commit 1925cb9
Show file tree

Hide file tree

Showing 15 changed files with 39 additions and 372 deletions.
diff --git a/Changes b/Changes
@@ -1,9 +1,11 @@
 This file documents the revision history for Perl extension Mojolicious.
 
-2.54    2012-02-25 00:00:00
+2.54    2012-02-26 00:00:00
         - Added support for MOJO_CONNECT_TIMEOUT, MOJO_INACTIVITY_TIMEOUT,
           MOJO_REQUEST_TIMEOUT and MOJO_WEBSOCKET_TIMEOUT environment
           variables.
+        - Split up Mojolicious::Guides::Cheatsheet into more reference
+          documentation.
         - Increased default connect timeout from 3 to 10 seconds in
           Mojo::UserAgent and Mojo::IOLoop::Client.
         - Improved test command to colorize by default.

diff --git a/lib/Mojo/Command.pm b/lib/Mojo/Command.pm
@@ -488,7 +488,8 @@ relative file.
   $commands->run;
   $commands->run(@ARGV);
 
-Load and run commands.
+Load and run commands. Automatic deployment environment detection can be
+disabled with the C<MOJO_NO_DETECT> environment variable.
 
 =head2 C<start>
 

diff --git a/lib/Mojo/DOM.pm b/lib/Mojo/DOM.pm
@@ -407,7 +407,7 @@ sub _text {
 sub _trim {
   my ($e, $trim) = @_;
 
-  # Deactivated
+  # Disabled
   return 0 unless $trim = defined $trim ? $trim : 1;
 
   # Detect "pre" tag
@@ -477,7 +477,7 @@ switch into XML mode and everything becomes case sensitive.
   say $dom->at('P')->text;
   say $dom->P->{ID};
 
-XML detection can be also deactivated with the C<xml> method.
+XML detection can be also disabled with the C<xml> method.
 
   # XML sematics
   $dom->xml(1);
@@ -502,7 +502,7 @@ Construct a new L<Mojo::DOM> object.
   my $untrimmed = $dom->all_text(0);
 
 Extract all text content from DOM structure, smart whitespace trimming is
-activated by default. Note that the trim argument of this method is
+disabled by default. Note that the trim argument of this method is
 EXPERIMENTAL and might change without warning!
 
   # "foo bar baz"
@@ -645,7 +645,7 @@ Find root node.
   my $untrimmed = $dom->text(0);
 
 Extract text content from element only (not including child elements), smart
-whitespace trimming is activated by default. Note that the trim argument of
+whitespace trimming is disabled by default. Note that the trim argument of
 this method is EXPERIMENTAL and might change without warning!
 
   # "foo baz"
@@ -660,7 +660,7 @@ this method is EXPERIMENTAL and might change without warning!
   my $untrimmed = $dom->text_after(0);
 
 Extract text content immediately following element, smart whitespace trimming
-is activated by default. Note that this method is EXPERIMENTAL and might
+is disabled by default. Note that this method is EXPERIMENTAL and might
 change without warning!
 
   # "baz"
@@ -675,7 +675,7 @@ change without warning!
   my $untrimmed = $dom->text_before(0);
 
 Extract text content immediately preceding element, smart whitespace trimming
-is activated by default. Note that this method is EXPERIMENTAL and might
+is disabled by default. Note that this method is EXPERIMENTAL and might
 change without warning!
 
   # "foo"

diff --git a/lib/Mojo/Home.pm b/lib/Mojo/Home.pm
@@ -167,7 +167,8 @@ Construct a new L<Mojo::Home> object.
   $home = $home->detect;
   $home = $home->detect('My::App');
 
-Detect home directory from application class.
+Detect home directory from value of C<MOJO_HOME> environment variable or
+application class.
 
 =head2 C<lib_dir>
 

diff --git a/lib/Mojo/Log.pm b/lib/Mojo/Log.pm
@@ -150,7 +150,8 @@ value of C<path> or C<STDERR>.
   my $level = $log->level;
   $log      = $log->level('debug');
 
-Active log level, defaults to C<debug>.
+Active log level, defaults to the value of the C<MOJO_LOG_LEVEL> environment
+variable or C<debug>.
 
 These levels are currently available:
 

diff --git a/lib/Mojo/Server.pm b/lib/Mojo/Server.pm
@@ -124,8 +124,8 @@ Application this server handles, defaults to a L<Mojo::HelloWorld> object.
   my $app_class = $server->app_class;
   $server       = $server->app_class('MojoSubclass');
 
-Class of the application this server handles, defaults to
-L<Mojo::HelloWorld>.
+Class of the application this server handles, defaults to the value of the
+C<MOJO_APP> environment variable or L<Mojo::HelloWorld>.
 
 =head1 METHODS
 

diff --git a/lib/Mojo/Server/Daemon.pm b/lib/Mojo/Server/Daemon.pm
@@ -369,7 +369,8 @@ WebSocket server with C<IPv6>, C<TLS>, C<Bonjour> and C<libev> support.
 
 Optional modules L<EV>, L<IO::Socket::IP>, L<IO::Socket::SSL> and
 L<Net::Rendezvous::Publish> are supported transparently and used if
-installed.
+installed. Individual features can be disabled with the C<MOJO_NO_BONJOUR>,
+C<MOJO_NO_IPV6> and C<MOJO_NO_TLS> environment variables.
 
 See L<Mojolicious::Guides::Cookbook> for deployment recipes.
 

diff --git a/lib/Mojo/UserAgent.pm b/lib/Mojo/UserAgent.pm
@@ -632,7 +632,8 @@ L<Mojo::UserAgent> is a full featured non-blocking I/O HTTP 1.1 and WebSocket
 user agent with C<IPv6>, C<TLS> and C<libev> support.
 
 Optional modules L<EV>, L<IO::Socket::IP> and L<IO::Socket::SSL> are
-supported transparently and used if installed.
+supported transparently and used if installed. Individual features can be
+disabled with the C<MOJO_NO_IPV6> and C<MOJO_NO_TLS> environment variables.
 
 =head1 EVENTS
 
@@ -890,7 +891,8 @@ append a callback to perform requests non-blocking.
   $ua = $ua->detect_proxy;
 
 Check environment variables C<HTTP_PROXY>, C<http_proxy>, C<HTTPS_PROXY>,
-C<https_proxy>, C<NO_PROXY> and C<no_proxy> for proxy information.
+C<https_proxy>, C<NO_PROXY> and C<no_proxy> for proxy information. Automatic
+proxy detection can be enabled with the C<MOJO_PROXY> environment variable.
 
 =head2 C<get>
 

diff --git a/lib/Mojolicious/Controller.pm b/lib/Mojolicious/Controller.pm
@@ -32,8 +32,8 @@ our $DEV_NOT_FOUND = $H->slurp_rel_file('not_found.development.html.ep');
 
 # Reserved stash values
 my @RESERVED = (
-  qw/action app cb class controller data exception extends format handler/,
-  qw/json layout method namespace partial path status template text/
+  qw/action app cb class controller data extends format handler json layout/,
+  qw/method namespace partial path status template text/
 );
 my %RESERVED;
 $RESERVED{$_}++ for @RESERVED;

diff --git a/lib/Mojolicious/Guides.pod b/lib/Mojolicious/Guides.pod
@@ -53,10 +53,6 @@ Generating content with the L<Mojolicious> renderer.
 
 Cooking with L<Mojolicious>, recipes for every taste.
 
-=item L<Mojolicious::Guides::Cheatsheet>
-
-A concise all-purpose reference.
-
 =item L<Mojolicious::Guides::FAQ>
 
 Frequently asked questions with the right answers.