1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00

Asset pipeline: Remove documentation about outdated config.assets.compress option

[ci skip]
This commit is contained in:
Prathamesh Sonpatki 2016-05-08 13:45:41 -05:00
parent e8e9b6f25e
commit d4530c9c90
No known key found for this signature in database
GPG key ID: 8B90F6B89E2BCB71
2 changed files with 7 additions and 14 deletions

View file

@ -435,11 +435,11 @@ Sprockets uses manifest files to determine which assets to include and serve.
These manifest files contain _directives_ - instructions that tell Sprockets These manifest files contain _directives_ - instructions that tell Sprockets
which files to require in order to build a single CSS or JavaScript file. With which files to require in order to build a single CSS or JavaScript file. With
these directives, Sprockets loads the files specified, processes them if these directives, Sprockets loads the files specified, processes them if
necessary, concatenates them into one single file and then compresses them (if necessary, concatenates them into one single file and then compresses them
`Rails.application.config.assets.compress` is true). By serving one file rather (based on value of `Rails.application.config.assets.js_compressor`). By serving
than many, the load time of pages can be greatly reduced because the browser one file rather than many, the load time of pages can be greatly reduced because
makes fewer requests. Compression also reduces file size, enabling the the browser makes fewer requests. Compression also reduces file size, enabling
browser to download them faster. the browser to download them faster.
For example, a new Rails application includes a default For example, a new Rails application includes a default
@ -1105,11 +1105,6 @@ NOTE: You will need an [ExecJS](https://github.com/rails/execjs#readme)
supported runtime in order to use `uglifier`. If you are using Mac OS X or supported runtime in order to use `uglifier`. If you are using Mac OS X or
Windows you have a JavaScript runtime installed in your operating system. Windows you have a JavaScript runtime installed in your operating system.
NOTE: The `config.assets.compress` initialization option is no longer used in
Rails to enable either CSS or JavaScript compression. Setting it will have no
effect on the application. Instead, setting `config.assets.css_compressor` and
`config.assets.js_compressor` will control compression of CSS and JavaScript
assets.
### Using Your Own Compressor ### Using Your Own Compressor
@ -1290,8 +1285,8 @@ config.assets.digest = true
Rails 4 and above no longer set default config values for Sprockets in `test.rb`, so Rails 4 and above no longer set default config values for Sprockets in `test.rb`, so
`test.rb` now requires Sprockets configuration. The old defaults in the test `test.rb` now requires Sprockets configuration. The old defaults in the test
environment are: `config.assets.compile = true`, `config.assets.compress = false`, environment are: `config.assets.compile = true`, `config.assets.debug = false` and
`config.assets.debug = false` and `config.assets.digest = false`. `config.assets.digest = false`.
The following should also be added to your `Gemfile`: The following should also be added to your `Gemfile`:

View file

@ -157,8 +157,6 @@ pipeline is enabled. It is set to true by default.
* `config.assets.raise_runtime_errors` Set this flag to `true` to enable additional runtime error checking. Recommended in `config/environments/development.rb` to minimize unexpected behavior when deploying to `production`. * `config.assets.raise_runtime_errors` Set this flag to `true` to enable additional runtime error checking. Recommended in `config/environments/development.rb` to minimize unexpected behavior when deploying to `production`.
* `config.assets.compress` a flag that enables the compression of compiled assets. It is explicitly set to true in `config/environments/production.rb`.
* `config.assets.css_compressor` defines the CSS compressor to use. It is set by default by `sass-rails`. The unique alternative value at the moment is `:yui`, which uses the `yui-compressor` gem. * `config.assets.css_compressor` defines the CSS compressor to use. It is set by default by `sass-rails`. The unique alternative value at the moment is `:yui`, which uses the `yui-compressor` gem.
* `config.assets.js_compressor` defines the JavaScript compressor to use. Possible values are `:closure`, `:uglifier` and `:yui` which require the use of the `closure-compiler`, `uglifier` or `yui-compressor` gems respectively. * `config.assets.js_compressor` defines the JavaScript compressor to use. Possible values are `:closure`, `:uglifier` and `:yui` which require the use of the `closure-compiler`, `uglifier` or `yui-compressor` gems respectively.