Fix documentation of logging.path and logging.file

See gh-4969
This commit is contained in:
Stephane Nicoll 2016-01-19 09:32:54 +01:00
parent 43ed824f40
commit 2ceadd705b
4 changed files with 14 additions and 14 deletions

View File

@ -42,8 +42,8 @@ content into your application; rather pick only the properties that you need.
spring.main....= # see class for all properties spring.main....= # see class for all properties
# LOGGING # LOGGING
logging.path=/var/log logging.path=/var/log # directory where log files are written
logging.file=myapp.log logging.file=myapp.log # name of the log file
logging.config= # location of config file (default classpath:logback.xml for logback) logging.config= # location of config file (default classpath:logback.xml for logback)
logging.level.*= # levels for loggers, e.g. "logging.level.org.springframework=DEBUG" (TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF) logging.level.*= # levels for loggers, e.g. "logging.level.org.springframework=DEBUG" (TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF)

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2012-2014 the original author or authors. * Copyright 2012-2016 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -36,14 +36,14 @@ import org.springframework.util.StringUtils;
public class LogFile { public class LogFile {
/** /**
* The name of the Spring property that contains the name of the logging configuration * The name of the Spring property that contains the name of the log file. Names can
* file. * be an exact location or relative to the current directory.
*/ */
public static final String FILE_PROPERTY = "logging.file"; public static final String FILE_PROPERTY = "logging.file";
/** /**
* The name of the Spring property that contains the path where the logging * The name of the Spring property that contains the directory where log files are
* configuration can be found. * written.
*/ */
public static final String PATH_PROPERTY = "logging.path"; public static final String PATH_PROPERTY = "logging.path";

View File

@ -1,5 +1,5 @@
/* /*
* Copyright 2012-2015 the original author or authors. * Copyright 2012-2016 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -72,14 +72,14 @@ public class LoggingApplicationListener implements SmartApplicationListener {
public static final String CONFIG_PROPERTY = "logging.config"; public static final String CONFIG_PROPERTY = "logging.config";
/** /**
* The name of the Spring property that contains the path where the logging * The name of the Spring property that contains the directory where log files are
* configuration can be found. * written.
*/ */
public static final String PATH_PROPERTY = LogFile.PATH_PROPERTY; public static final String PATH_PROPERTY = LogFile.PATH_PROPERTY;
/** /**
* The name of the Spring property that contains the name of the logging configuration * The name of the Spring property that contains the name of the log file. Names can
* file. * be an exact location or relative to the current directory.
*/ */
public static final String FILE_PROPERTY = LogFile.FILE_PROPERTY; public static final String FILE_PROPERTY = LogFile.FILE_PROPERTY;

View File

@ -32,7 +32,7 @@
{ {
"name": "logging.file", "name": "logging.file",
"type": "java.lang.String", "type": "java.lang.String",
"description": "Log file name.", "description": "Name of the log file. Names can be an exact location or relative to the current directory.",
"sourceType": "org.springframework.boot.logging.LoggingApplicationListener" "sourceType": "org.springframework.boot.logging.LoggingApplicationListener"
}, },
{ {
@ -44,7 +44,7 @@
{ {
"name": "logging.path", "name": "logging.path",
"type": "java.lang.String", "type": "java.lang.String",
"description": "Location of the log file.", "description": "Directory where log files are written.",
"sourceType": "org.springframework.boot.logging.LoggingApplicationListener" "sourceType": "org.springframework.boot.logging.LoggingApplicationListener"
}, },
{ {