Updated manual to reflect changes

Author: notzippy

.travis.yml

@@ -1,8 +1,13 @@
 language: ruby
 rvm:
-- 2.1
+- 2.4.1
 before_install:
+  - gem install ruby_dep -v 1.3.1
   - gem install github-pages
   - gem install octopress-escape-code
+branches:
+  only:
+    - master
+    - develop
 script: "jekyll build"
 

manual/controllers.md

@@ -14,8 +14,59 @@ The [revel.Controller](https://godoc.org/github.com/revel/revel#Controller) is t
 a single request and controls
 - the incoming [Request](https://godoc.org/github.com/revel/revel#Request) stuff
 - and the [Response](https://godoc.org/github.com/revel/revel#Response) back, in Html, Json, Xml, File or your own custom.
+- `Controllers` are reused but not for the same Request <br />
+- `Controllers.Destroy` function may be defined to *clean up* locally defined variables and are called
+after the controller is used.
+ 
+A `Controller` instance is not shared by two simultaneous requests, but a controller instance may be 
+reused. So if you have instance variables that are set in your controller 
+(like in a `Before` function), you should ensure that these variables are always initialized inside your 
+`Before` function.  
+
+
+For example say you have a Map defined in your controller, and the `Before` function looks at 
+the `Controller.Params` object and see that the `name`  parameter exists, so it sets that value in the map.
+then the controller finishes its execution.  
+
+Now a new request comes in and the controller is reused, and the `Before` function looks at 
+the `Controller.Params` object and does not see that the `name` parameter exists, so it does not change 
+the "name" in the map, but as you see the map contains the value from the previous request. This type
+of hidden bugs can be difficult to track down and it is the reason why it is recommended not to use
+additional attributes in the controller 
+
+There are a few ways to avoid this situation, 
+1) Use the `Controller.Args` map to store your single use variables, this map is always initialized 
+to an empty map so it makes a perfect spot to transfer objects within the controller call 
+2) If you do use controller defined variables make sure you initialize them in your `Before` function. 
+(see Before function below)
+3) Define a `Destroy` function to "clean up" your locally defined stuff. Make sure the
+first thing the Destroy calls is to the controller `Destroy` call
+
+###### Example of a Controller with a `Destroy` function
+```go
+type MyAppController struct {
+    *revel.Controller
+    MyMappedData map[string]interface{}
+}
+
+// Assume that this is called for all the controller functions
+func (c MyAppController) Before() {
+  c.MyMappedData = map[string]interface{}{}
+}
+
+// This function will be called when the Controller is put back into the stack
+func (c MyAppController) Destroy() {
+	c.Controller.Destroy()
+	// Clean up locally defined maps or items
+	c.MyMappedData = nil
+}
+```
+
+
 
-A **Controller** is any type that embeds a [*revel.Controller](https://godoc.org/github.com/revel/revel#Controller) as the **first field/type**.
+A **Controller** is any type that embeds a 
+[*revel.Controller](https://godoc.org/github.com/revel/revel#Controller) as the **first field/type**
+and is in a source path called controllers.
 
 ```go
 type MyAppController struct {
@@ -59,7 +110,7 @@ type Controller struct {
     Session    Session                // Session, stored in cookie, signed.
     Params     *Params                // Parameters from URL and form (including multipart).
     Args       map[string]interface{} // Per-request scratch space.
-    ViewArgs map[string]interface{} // Args passed to the template.
+    ViewArgs   map[string]interface{} // Args passed to the template.
     Validation *Validation            // Data validation helpers
 }
 ```
@@ -113,7 +164,6 @@ type Response struct {
 - As part of handling a HTTP request, Revel instantiates an instance of a 
 [revel.Controller](https://godoc.org/github.com/revel/revel#Controller).
 - It then sets all of the properties on the embedded `revel.Controller`.
-- Revel does not share a `Controller` instance between requests.
 
 ### Extending the Controller
 

manual/i18n-messages.md

@@ -150,6 +150,7 @@ greeting.suffix=, welcome to Revel!
 
 A goconfig file is separated into *sections*. The *default section* always exists and contains any messages that are not defined in a specific section. For example:
 {% highlight ini %}
+[DEFAULT]
 key=value
 
 [SECTION]

manual/index.md

@@ -9,6 +9,7 @@ Ready to have a blast building apps? Let's get started!
     - Read about the [concepts](concepts.html)
     - Browse the [example applications](/examples/)
     - Read the API docs at [godoc](https://godoc.org/github.com/revel/revel)
+    - Read the Revel cmd [documentation](/manual/tool)
 - **Dev Support**
     - [![Gitter Chat](http://img.shields.io/badge/chat-online-brightgreen.svg)](https://gitter.im/revel/community)
     - [StackOverflow](http://stackoverflow.com/questions/tagged/revel)

manual/interceptors.md

@@ -21,9 +21,9 @@ which is useful for some common concerns such as:
 
 In Revel, an interceptor can take one of three forms:
 
-* A [Function Interceptor](#function_interceptor) 
-* A [Method Interceptor](#method_interceptor)
-* A [Controller Auto Interceptor](#controller_auto_interceptor)
+* A [Function Interceptor](#function-interceptor) 
+* A [Method Interceptor](#method-interceptor)
+* A [Controller Auto Interceptor](#controller-auto-interceptor)
      using the `revel.BeforeAfterFilter` filter 
 
 An Interceptor has an [intercept](#intercept_times) point in the request ([When](https://godoc.org/github.com/revel/revel#When)) 
@@ -120,7 +120,8 @@ Ensure your function names match `func (c Application) Before() (r revel.Result,
 
 ## Intercept Times
 
-An interceptor can be registered to run at four points in the request lifecycle; defined in [When()](https://godoc.org/github.com/revel/revel#When):
+An interceptor can be registered to run at four points in the request lifecycle; 
+defined in [When](https://godoc.org/github.com/revel/revel#When):
 
 1. **BEFORE**
     * After the request has been [routed](routing.html), the [session, flash](sessionflash.html), and [parameters](parameters.html) decoded, but before the action has been invoked.