Quellcode durchsuchen

Document log paths

Manav Rathi vor 1 Jahr
Ursprung
Commit
c7aa5ccd1f
2 geänderte Dateien mit 8 neuen und 7 gelöschten Zeilen
  1. 2 5
      desktop/src/main/log.ts
  2. 6 2
      desktop/src/main/services/dir.ts

+ 2 - 5
desktop/src/main/log.ts

@@ -5,11 +5,8 @@ import { isDev } from "./utils/electron";
 /**
  * Initialize logging in the main process.
  *
- * This will set our underlying logger up to log to a file named `ente.log`,
- *
- * - on Linux at ~/.config/ente/logs/ente.log
- * - on macOS at ~/Library/Logs/ente/ente.log
- * - on Windows at %USERPROFILE%\AppData\Roaming\ente\logs\ente.log
+ * This will set our underlying logger up to log to a file named `ente.log`, see
+ * [Note: App log path].
  *
  * On dev builds, it will also log to the console.
  */

+ 6 - 2
desktop/src/main/services/dir.ts

@@ -64,14 +64,18 @@ export const openLogDirectory = () => openDirectory(logDirectoryPath());
  * Note that Chromium also stores the browser state, e.g. localStorage or disk
  * caches, in userData.
  *
+ * https://www.electronjs.org/docs/latest/api/app
+ *
+ * [Note: App log path]
+ *
  * Finally, there is the "logs" directory. This is not within "appData" but has
  * a slightly different OS specific path. Since our log file is named
  * "ente.log", it can be found at:
  *
  * - macOS: ~/Library/Logs/ente/ente.log (production)
  * - macOS: ~/Library/Logs/Electron/ente.log    (dev)
- *
- * https://www.electronjs.org/docs/latest/api/app
+ * - Linux: ~/.config/ente/logs/ente.log
+ * - Windows: %USERPROFILE%\AppData\Roaming\ente\logs\ente.log
  */
 const logDirectoryPath = () => app.getPath("logs");