Skip to content

Commit fec3399

Browse files
committed
Add file path examples to logging flags
1 parent 89b6c9a commit fec3399

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

java/src/org/openqa/selenium/grid/log/LoggingFlags.java

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,15 @@ public class LoggingFlags implements HasRoles {
6464
@ConfigValue(section = LOGGING_SECTION, name = "http-logs", example = "true")
6565
private Boolean httpLogs = DEFAULT_HTTP_LOGS;
6666

67-
@Parameter(description = "File to write out logs", names = "--log", arity = 1)
68-
@ConfigValue(section = LOGGING_SECTION, name = "log-file", example = "true")
67+
@Parameter(description = "File to write out logs. "
68+
+ "Ensure the file path is compatible with the operating system's file path.\n"
69+
+ "Windows path example : \\\\path\\to\\file\\gridlog.log OR "
70+
+ "C:\\path\\path\\to\\file\\gridlog.log \n"
71+
+ "Linux/Unix/MacOS path example : /path/to/file/gridlog.log \n"
72+
, names = "--log", arity = 1)
73+
@ConfigValue(section = LOGGING_SECTION, name = "log-file", example = {"'\\\\path\\to\\file\\gridlog.log'",
74+
"'C:\\path\\path\\to\\file\\gridlog.log'",
75+
"'/path/to/file/gridlog.log'"})
6976
private String logFile;
7077

7178
@Parameter(description = "Log encoding", names = "--log-encoding", arity = 1)

0 commit comments

Comments
 (0)