Polish devtools documentation

See gh-3088
pull/3211/head
Stephane Nicoll 10 years ago
parent e687c9456f
commit fcb45a4bb7

@ -81,7 +81,7 @@ public class DevToolsProperties {
private long quietPeriod = DEFAULT_RESTART_QUIET_PERIOD;
/**
* The name of specific that that when changed will will trigger the restart. If
* Name of a specific file that when changed will trigger the restart. If
* not specified any classpath file change will trigger the restart.
*/
private String triggerFile;

@ -85,7 +85,7 @@ public class RemoteDevToolsProperties {
public static class Restart {
/**
* Enable remote restart
* Enable remote restart.
*/
private boolean enabled = true;

@ -545,6 +545,24 @@ content into your application; rather pick only the properties that you need.
spring.mobile.devicedelegatingviewresolver.tablet-prefix=tablet/
spring.mobile.devicedelegatingviewresolver.tablet-suffix=
# ----------------------------------------
# DEVTOOLS PROPERTIES
# ----------------------------------------
spring.devtools.livereload.enabled=true # enable a livereload.com compatible server
spring.devtools.livereload.port=35729 # server port.
spring.devtools.remote.context-path=/.~~spring-boot!~ # context path used to handle the remote connection
spring.devtools.remote.debug.enabled=true # enable remote debug support
spring.devtools.remote.debug.local-port=8000 # local remote debug server port
spring.devtools.remote.restart.enabled=true # enable remote restart
spring.devtools.remote.secret= # a shared secret required to establish a connection
spring.devtools.remote.secret-header-name=X-AUTH-TOKEN # HTTP header used to transfer the shared secret
spring.devtools.restart.enabled=true # enable automatic restart
spring.devtools.restart.exclude= # patterns that should be excluding for triggering a full restart
spring.devtools.restart.poll-interval= # amount of time (in milliseconds) to wait between polling for classpath changes
spring.devtools.restart.quiet-period= # amount of quiet time (in milliseconds) requited without any classpath changes before a restart is triggered
spring.devtools.restart.trigger-file= # name of a specific file that when changed will trigger the restart
# ----------------------------------------
# ACTUATOR PROPERTIES
# ----------------------------------------

@ -1861,7 +1861,7 @@ for other Velocity customization options.
The `spring-boot-devtools` module includes support for automatic application restarts.
Whilst not as fast a technologies such as http://zeroturnaround.com/software/jrebel/[JRebel]
or https://github.com/spring-projects/spring-loaded[Spring Loaded] it's usually
significantly faster that a "`cold start`". You should probably give it a try before
significantly faster than a "`cold start`". You should probably give it a try before
investigating some of the more complex reload options discussed bellow.
For more details see the <<using-spring-boot.adoc#using-boot-devtools>> section.

@ -799,7 +799,7 @@ on the classpath change. This can be a useful feature when working in an IDE as
a very fast feedback loop for code changes. By default, any entry on the classpath that
points to a folder will be monitored for changes.
TIP: Automatic restart work very well when used with with LiveReload.
TIP: Automatic restart work very well when used with LiveReload.
<<using-boot-devtools-livereload,See below>> for details.
.Restart vs Reload
@ -909,7 +909,7 @@ the following:
=== Remote applications
The Spring Boot developer tools are not just limited to local development. You can also
use several features when running applications remotely. Remote support is opt-in, to
enable it you need set a `spring.devtools.remote.password` property. For example:
enable it you need to set a `spring.devtools.remote.password` property. For example:
[source,properties,indent=0]
----
@ -939,7 +939,7 @@ you've deployed to Cloud Foundry, you would do the following:
* Create a new `Java Application` "`launch configuration`".
* Browse for the `my-app` project.
* Use `org.springframework.boot.devtools.RemoteSpringApplication` as the main class.
* Add `+++http://myapp.cfapps.io+++` to the `Program arguments` (or whatever your remote
* Add `+++https://myapp.cfapps.io+++` to the `Program arguments` (or whatever your remote
URL is).
A running remote client will look like this:
@ -986,7 +986,7 @@ before starting the remote client, it won't be pushed to the remote server.
[[using-boot-devtools-remote-debugtunnel]]
==== Remote debug tunnel
Java remote debugging is useful tool when diagnosing issues on a remote application.
Java remote debugging is useful when diagnosing issues on a remote application.
Unfortunately, it's not always possible to enable remote debugging when your application
is deployed outside of your data center. Remote debugging can also be tricky to setup if
you are using a container based technology such as Docker.

Loading…
Cancel
Save