Fix documentation of logging.path and logging.file

See gh-4969

Author: snicoll

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

@@ -42,8 +42,8 @@ content into your application; rather pick only the properties that you need.
 	spring.main....= # see class for all properties
 
 	# LOGGING
-	logging.path=/var/log
-	logging.file=myapp.log
+	logging.path=/var/log # directory where log files are written
+	logging.file=myapp.log # name of the log file
 	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)
 

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

@@ -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");
  * you may not use this file except in compliance with the License.
@@ -36,14 +36,14 @@
 public class LogFile {
 
 	/**
-	 * The name of the Spring property that contains the name of the logging configuration
-	 * file.
+	 * The name of the Spring property that contains the name of the log file. Names can
+	 * be an exact location or relative to the current directory.
 	 */
 	public static final String FILE_PROPERTY = "logging.file";
 
 	/**
-	 * The name of the Spring property that contains the path where the logging
-	 * configuration can be found.
+	 * The name of the Spring property that contains the directory where log files are
+	 * written.
 	 */
 	public static final String PATH_PROPERTY = "logging.path";
 

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

@@ -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");
  * 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";
 
 	/**
-	 * The name of the Spring property that contains the path where the logging
-	 * configuration can be found.
+	 * The name of the Spring property that contains the directory where log files are
+	 * written.
 	 */
 	public static final String PATH_PROPERTY = LogFile.PATH_PROPERTY;
 
 	/**
-	 * The name of the Spring property that contains the name of the logging configuration
-	 * file.
+	 * The name of the Spring property that contains the name of the log file. Names can
+	 * be an exact location or relative to the current directory.
 	 */
 	public static final String FILE_PROPERTY = LogFile.FILE_PROPERTY;
 

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

@@ -32,7 +32,7 @@
   {
     "name": "logging.file",
     "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"
   },
   {
@@ -44,7 +44,7 @@
   {
     "name": "logging.path",
     "type": "java.lang.String",
-    "description": "Location of the log file.",
+    "description": "Directory where log files are written.",
     "sourceType": "org.springframework.boot.logging.LoggingApplicationListener"
   },
   {