ipfs/kubo

Implement XDG base directories

Open

#120 opened on Sep 24, 2014

View on GitHub
 (11 comments) (0 reactions) (0 assignees)Go (13,906 stars) (2,725 forks)batch import
P2help wanted

Description

See: http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html

Basically:

configuration should be searched in:

  • XDG_CONFIG_HOME/go-ipgs/config
  • XDG_CONFIG_DIRS/go-ipgs/config

Some rules :

  • XDG_CONFIG_HOME defaults to HOME/.config when not set
  • XDG_CONFIG_DIRS defaults to /etc/xdg when not set

The same logic applies to persistent data files (the one we want to keep) and cached data files (the one we may delete at any moment)

Contributor guide

Tech stack
go
Domain
backendtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go programmingUnderstanding of XDG Base Directory SpecificationFile system path handling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Review the XDG Base Directory Specification to understand the expected paths for configuration, data, and cache files. Examine the current Go codebase for existing config file path logic, likely in a config package. Check the 11 comments on the issue for any suggested implementations or challenges. Implement the lookup logic for XDG CONFIG HOME, XDG CONFIG DIRS, and similar for data and cache directories, with appropriate fallbacks.