Change default session log directory to ~/.local/state (#859)

This addresses #808 and #823 conclusively for all parties.
- It requires no additional directory creation.
- It does not impact users who do not have a problem.
- It adds additional documentation detail in both the bug template and
the readme to help users who *are* having a problem.
- Fulfills the spirit of the [XDG Spec(https://specifications.freedesktop.org/basedir-spec/latest)
but not in practice as `$XDG_CONFIG_HOME` and `$HOME` and the associated
logic are not implemented. `~/.local/state` is the fallback location.

In particular, the spec indicates:
> It may contain: actions history (**logs**, history, …)

Reviewed-on: https://codeberg.org/fairyglade/ly/pulls/859
Reviewed-by: AnErrupTion <anerruption@disroot.org>
Co-authored-by: Corey Newton <corey.newton@zenoprax.com>
Co-committed-by: Corey Newton <corey.newton@zenoprax.com>
This commit is contained in:
Corey Newton
2025-11-05 21:57:10 +01:00
committed by AnErrupTion
parent 2da3648179
commit 1537addd67
3 changed files with 8 additions and 3 deletions

View File

@@ -58,8 +58,9 @@ body:
attributes:
label: Relevant logs
description: |
Please copy and paste (or attach) any relevant logs, error messages or any other output. This will be automatically formatted into code, so no need for backticks. Screenshots are accepted if they make life easier for you.
Moreover, it is almost always a good idea to include your session log and your general log files (found at ~/ly-session.log and /var/log/ly.log respectively by default) as it usually contains relevant information about the problem.
Please copy and paste (or attach) any relevant logs, error messages or any other output. This will be automatically formatted into code, so no need for backticks. Screenshots are accepted if they make life easier for you. The log files (located as specified by `/etc/ly/config.ini`) usually contain relevant information about the problem:
- The session log is located at `~/.local/state/ly-session.log` by default.
- The system log is located at `/var/log/ly.log` by default.
render: shell
- type: textarea
id: moreinfo

View File

@@ -57,6 +57,10 @@ managers, all of which you can find in the sections below:
[X11 environments](#supported-x11-environments)
Logs are defined by `/etc/ly/config.ini`:
- The session log is located at `~/.local/state/ly-session.log` by default.
- The system log is located at `/var/log/ly.log` by default.
## Manually building
The procedure for manually building Ly is pretty standard:

View File

@@ -285,7 +285,7 @@ service_name = ly
# Important: due to technical limitations, X11 and shell sessions aren't supported, which
# means you won't get any logs from those sessions.
# If null, no session log will be created
session_log = ly-session.log
session_log = .local/state/ly-session.log
# Setup command
setup_cmd = $CONFIG_DIRECTORY/ly/setup.sh