amoeba commented on code in PR #4527:
URL: https://github.com/apache/arrow-adbc/pull/4527#discussion_r3616483260
##########
docs/source/driver/flight_sql.rst:
##########
@@ -266,15 +227,9 @@ Database options
If unset, the ``adbcfile`` exporter writes traces under the user's
configuration directory in:
- - Windows: ``%APPDATA%\.adbc\traces``
- - macOS: ``~/Library/Application Support/.adbc/traces``
- - Linux: ``$XDG_CONFIG_HOME/.adbc/traces`` or ``~/.config/.adbc/traces``
-
- .. note::
-
- These default paths reflect the current implementation. See
- `issue #4501 <https://github.com/apache/arrow-adbc/issues/4501>`_
- for the planned config-path redesign.
+ - Windows: ``%APPDATA%\ADBC\Traces``
+ - macOS: ``~/Library/Application Support/ADBC/Traces``
+ - Linux: ``$XDG_CONFIG_HOME/adbc/traces`` or ``~/.config/adbc/traces``
Review Comment:
I wasn't able to find anything examples that help and this makes sense now
that I think about it: Software that produces logs and traces is usually
installed at the system level so XDG base dir stuff doesn't come up. i.e.,
traces would just go in `/var/log/$app`.
$XDG_STATE_HOME seems like a good fit:
> The $XDG_STATE_HOME contains state data that should persist between
(application) restarts, but that is not important or portable enough to the
user that it should be stored in $XDG_DATA_HOME
So I'd go with:
- macOS: `~/Library/Application Support/ADBC/Traces`
- Linux: `$XDG_STATE_HOME/adbc/traces` or `$HOME/.local/state/adbc/traces`
if `$XDG_STATE_HOME` is not set
- Windows: `%LOCALAPPDATA%\ADBC\Traces`
My reasoning for my choice for macOS above is two-fold: (1) platform dirs
uses that dir for `user_state_dir` (2) it's just simpler to use a single dir
for everything on a platform without a clearly-defined pattern for XDG base
dirs.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
