From 1383fde3457168ed759d6ed3b913dfae8a6085ef Mon Sep 17 00:00:00 2001 From: Martin Braun Date: Thu, 5 Mar 2020 16:23:07 -0800 Subject: uhd: paths: Harmonize around XDG Base Directory specification Up until now, we completely ignore the XDG specification. This commit does the following to change that: - It uses XDG_DATA_HOME and XDG_CONFIG_HOME for cal and config data, respectively. - If config data is in ~/.uhd/uhd.conf, that is still accepted, but if it conflicts with $XDG_CONFIG_HOME/uhd.conf, it is ignored and a warning is displayed - The default location for cal data is thus ${HOME}/.local/share/uhd/cal on Unix, and %LOCALAPPDATA%\uhd\cal on Windows. This is a change in location! - The UHD_CONFIG_DIR environment variable was confusingly named and is now removed. It provided an alternative location than the home directory. The same purpose is now much better served by XDG_DATA_HOME and XDG_CONFIG_HOME. The specification can be found here: specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html --- host/docs/calibration.dox | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) (limited to 'host/docs/calibration.dox') diff --git a/host/docs/calibration.dox b/host/docs/calibration.dox index 764060bb8..4807515a6 100644 --- a/host/docs/calibration.dox +++ b/host/docs/calibration.dox @@ -60,20 +60,20 @@ daughterboard's EEPROM: \subsection calibration_data Calibration Data By default, calibration files are stored in the user's home/application -directory: +directory (`$XDG_DATA_HOME`): -- **Linux:** `${HOME}/.uhd/cal/` -- **Windows:** `%APPDATA%\.uhd\cal\` +- **Linux:** `${HOME}/.local/share/uhd/cal/` +- **Windows:** `%LOCALAPPDATA%\uhd\cal\` -If you would like to specify a custom directory, you can do so with the -`$UHD_CONFIG_DIR` environment variable: +Calibration files are binary files with a `.cal` file extension. -- **Custom (any OS):** `${UHD_CONFIG_DIR}/.uhd/cal/` +If you would like to specify a custom directory, you can do so with the +`$UHD_CAL_DATA_PATH` environment variable. Calibration files can easily be moved from one machine to another by copying the -"cal" directory. Re-running a calibration utility will replace the existing -calibration file. The old calibration file will be renamed so it may be -recovered by the user. +"cal" directory, or individual files therein. Re-running a calibration utility +will replace the existing calibration file. The old calibration file will be +renamed so it may be recovered by the user. \subsection calibration_data_csv Converting UHD 3.x calibration data to UHD 4 -- cgit v1.2.3