Skip to content

Commit 2ceadd7

Browse files
committed
Fix documentation of logging.path and logging.file
See spring-projectsgh-4969
1 parent 43ed824 commit 2ceadd7

File tree

4 files changed

+14
-14
lines changed

4 files changed

+14
-14
lines changed

spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ content into your application; rather pick only the properties that you need.
4242
spring.main....= # see class for all properties
4343
4444
# LOGGING
45-
logging.path=/var/log
46-
logging.file=myapp.log
45+
logging.path=/var/log # directory where log files are written
46+
logging.file=myapp.log # name of the log file
4747
logging.config= # location of config file (default classpath:logback.xml for logback)
4848
logging.level.*= # levels for loggers, e.g. "logging.level.org.springframework=DEBUG" (TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF)
4949

spring-boot/src/main/java/org/springframework/boot/logging/LogFile.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2014 the original author or authors.
2+
* Copyright 2012-2016 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -36,14 +36,14 @@
3636
public class LogFile {
3737

3838
/**
39-
* The name of the Spring property that contains the name of the logging configuration
40-
* file.
39+
* The name of the Spring property that contains the name of the log file. Names can
40+
* be an exact location or relative to the current directory.
4141
*/
4242
public static final String FILE_PROPERTY = "logging.file";
4343

4444
/**
45-
* The name of the Spring property that contains the path where the logging
46-
* configuration can be found.
45+
* The name of the Spring property that contains the directory where log files are
46+
* written.
4747
*/
4848
public static final String PATH_PROPERTY = "logging.path";
4949

spring-boot/src/main/java/org/springframework/boot/logging/LoggingApplicationListener.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2015 the original author or authors.
2+
* Copyright 2012-2016 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -72,14 +72,14 @@ public class LoggingApplicationListener implements SmartApplicationListener {
7272
public static final String CONFIG_PROPERTY = "logging.config";
7373

7474
/**
75-
* The name of the Spring property that contains the path where the logging
76-
* configuration can be found.
75+
* The name of the Spring property that contains the directory where log files are
76+
* written.
7777
*/
7878
public static final String PATH_PROPERTY = LogFile.PATH_PROPERTY;
7979

8080
/**
81-
* The name of the Spring property that contains the name of the logging configuration
82-
* file.
81+
* The name of the Spring property that contains the name of the log file. Names can
82+
* be an exact location or relative to the current directory.
8383
*/
8484
public static final String FILE_PROPERTY = LogFile.FILE_PROPERTY;
8585

spring-boot/src/main/resources/META-INF/additional-spring-configuration-metadata.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
{
3333
"name": "logging.file",
3434
"type": "java.lang.String",
35-
"description": "Log file name.",
35+
"description": "Name of the log file. Names can be an exact location or relative to the current directory.",
3636
"sourceType": "org.springframework.boot.logging.LoggingApplicationListener"
3737
},
3838
{
@@ -44,7 +44,7 @@
4444
{
4545
"name": "logging.path",
4646
"type": "java.lang.String",
47-
"description": "Location of the log file.",
47+
"description": "Directory where log files are written.",
4848
"sourceType": "org.springframework.boot.logging.LoggingApplicationListener"
4949
},
5050
{

0 commit comments

Comments
 (0)