Files
fish-config/functions/__kitty_logging_dir.fish
T
rootiest e651566e14 docs(functions): split RETURNS into EXIT STATUS and stdout RETURNS
RETURNS previously conflated fish's $status exit code with genuine
stdout/printed output, e.g. rm listing "0/1" as if they were print
values rather than exit codes. Rename RETURNS to EXIT STATUS across
all 83 documented functions, and reintroduce RETURNS as a distinct
label reserved for the 15 functions that actually print to stdout.

Update build-manual.py's ENTRY_HEADS to render Exit Status before
Returns, manualtools.py's SECTIONS constant, and AGENTS.md's label
order and label-usage guidance to match. Add two verify-manual.py
regression tests: EXIT STATUS bodies must never contain stray
stdout/printed language, and Returns: must always render after
Exit Status: when both are present. Regenerate docs/fish-config.md.
2026-07-26 16:41:57 -04:00

29 lines
800 B
Fish

# Copyright (C) 2026 Rootiest
# SPDX-License-Identifier: AGPL-3.0-or-later
# SYNOPSIS
# __kitty_logging_dir
#
# DESCRIPTION
# Echoes the Kitty configuration directory, mirroring Kitty's own resolution
# order: $KITTY_CONFIG_DIRECTORY, else $XDG_CONFIG_HOME/kitty, else
# ~/.config/kitty.
#
# EXIT STATUS
# 0 Always
#
# RETURNS
# The Kitty configuration directory path, printed to stdout
#
# EXAMPLE
# set -l dir (__kitty_logging_dir)
function __kitty_logging_dir --description 'Resolve the Kitty config directory'
if set -q KITTY_CONFIG_DIRECTORY; and test -n "$KITTY_CONFIG_DIRECTORY"
echo $KITTY_CONFIG_DIRECTORY
else if set -q XDG_CONFIG_HOME; and test -n "$XDG_CONFIG_HOME"
echo $XDG_CONFIG_HOME/kitty
else
echo $HOME/.config/kitty
end
end