Skip to content

Commit 813ae24

Browse files
committed
Updated logging section.
1 parent 3c8cfe6 commit 813ae24

File tree

1 file changed

+13
-16
lines changed

1 file changed

+13
-16
lines changed

UserManual.md

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -831,15 +831,17 @@ ShellAnything provides logging support for troubleshooting and debugging command
831831

832832
### Location ###
833833

834-
The log files are stored in the user's home directory available in `C:\Users\%USERNAME%\ShellAnything\Logs` directory where `%USERNAME%` matches your current login username.
835-
For instance, the user `JohnSmith` can find his ShellAnything log files in directory `C:\Users\JohnSmith\ShellAnything\Logs`.
834+
The logging directory is unique for each users of the system.
835+
836+
The log files are stored in `C:\Users\%USERNAME%\ShellAnything\Logs` directory where `%USERNAME%` matches your current login username.
837+
For example, the user `JohnSmith` can find his own ShellAnything log files in directory `C:\Users\JohnSmith\ShellAnything\Logs`.
836838

837839

838840

839841
### Filename Format ###
840842

841843
The log files names are generated in the following format:
842-
`<name>.<LEVEL>.<date>-<time>.<pid>.log`.
844+
`name.LEVEL.date-time.pid.log`.
843845

844846
The following table defines each field identifier in the filename format:
845847

@@ -851,8 +853,7 @@ The following table defines each field identifier in the filename format:
851853
| time | The current date when the file was created in `hhmmss` format. |
852854
| pid | The Process Id which generates the log message. |
853855

854-
For example, the following filename is a valid log file format:
855-
`shellext.dll.INFO.20191125-083305.9456.log`
856+
For example, `shellext.dll.INFO.20191125-083305.9456.log` is a valid log filename.
856857

857858

858859

@@ -872,30 +873,26 @@ shellext.dll.ERROR.20191125-084152.9456.log
872873
```
873874
See [Filename Format](#filename-format) for details.
874875

875-
Each log file contains the messages at it's matching level but also the messages with a higher severity.
876+
Each log file contains the messages of it's matching level but also the messages with higher severity.
876877
In other words, all logs messages are available in the INFO log file, including messages logged with WARNING and ERROR levels.
877878

878-
The ERROR log file contains all messages with ERROR level.
879-
The WARNING log file contains all messages with ERROR and WARNING levels.
879+
The ERROR log file contains all messages with ERROR level.</br>
880+
The WARNING log file contains all messages with ERROR and WARNING levels.</br>
880881
The INFO log file contains all messages with ERROR, WARNING and INFO levels.
881882

882883
Debugging log messages are only available in debug builds of the application.
883884

884885

885886

886-
### Log files life cycle###
887+
### Log files life cycle ###
887888

888-
The log files are kept for a maximum of 5 days.
889+
The log files are kept for a maximum of 5 days. This is for security reason as the files may contains sensitive information.
889890

890891
On application startup, the existing log files are all validated and files older than 5 days are deleted.
891892

892-
To force the the application restart, one can do one of the following:
893-
* reboot the computer, open a new Windows Explorer.
894-
* close all Windows Explorer before opening a new Window Explorer window.
895-
896-
This is for security reason as the files may contains sensitive information.
893+
To force the application restart, reboot the computer and open a new Windows Explorer or close all Windows Explorer before opening a new Window Explorer window.
897894

898-
There are no mean of keeping the log files for more than 5 days.
895+
There are no plan for keeping the log files for more than 5 days.
899896

900897

901898

0 commit comments

Comments
 (0)