Add XDG Base Directory support #6858

4e554c4c · 2023-09-15T22:28:29Z

Test plan:

> mkdir ~/.agda
> cabal run agda -- --print-agda-app-dir
/home/pounce/.agda

> rmdir ~/.agda
> cabal run agda -- --print-agda-app-dir
/home/pounce/.config/agda

> AGDA_DIR=/tmp cabal run agda -- --print-agda-app-dir
/tmp

> cabal run agda -- --print-agda-data-dir
/home/pounce/programming/agda/./src/data

fixes #6852

Test plan: --------- ``` > mkdir ~/.agda > cabal run agda -- --print-agda-app-dir /home/pounce/.agda > rmdir ~/.agda > cabal run agda -- --print-agda-app-dir /home/pounce/.config/agda > AGDA_DIR=/tmp cabal run agda -- --print-agda-app-dir /tmp > cabal run agda -- --print-agda-data-dir /home/pounce/programming/agda/./src/data ``` fixes agda#6852

This commit also changes the documentation for --print-agda-dir, renaming it to --print-agda-data-dir. It also removes inconsistancies in naming between $AGDA_DIR and the agda data directory.

4e554c4c · 2023-09-16T10:10:38Z

@wenkokke I think the renaming from --print-agda-dir to --print-agda-data-dir will have an impact on setup-agda
I'm happy to add it back for compatibility reasons, if need-be.

wenkokke · 2023-09-16T11:59:54Z

Thanks for the heads up!

I don't think it will, because I manually set the data directory through the environment, as the data directory set by cabal isn't reliable.

wenkokke · 2023-09-16T20:36:40Z

With the proposed change, would Agda continue to respond to the Agdadata_dir environment variable?

4e554c4c · 2023-09-16T20:40:06Z

it should, i didn't touch that at all (only app dir resolution)

4e554c4c · 2023-09-25T11:34:24Z

@wenkokke
ok this was a little bit hard to test, since cabal run messes with Agda_datadir, but it seems that the environment variable still works.

$ Agda_datadir=/tmp dist-newstyle/build/*/ghc-*/Agda-*/build/agda/agda --print-agda-data-dir
/tmp

wenkokke · 2023-09-25T23:36:45Z

Honestly, it may be easier to add code for resolving finding the Agda app and data directories based on configuration and environment variables, and work on phasing out the use of the Cabal-generated Paths module, given how much trouble it gives us.

plt-amy

Very welcome changes, thank you! For the sake of backwards compatibility, I don't think we should get rid of --print-agda-dir just yet.

doc/user-manual/tools/command-line-options.rst

src/full/Agda/Interaction/Options/Base.hs

Test plan: --------- ``` > cabal run agda -- --print-agda-data-dir /home/pounce/programming/agda/./src/data > cabal run agda -- --print-agda-dir /home/pounce/programming/agda/./src/data ```

plt-amy · 2023-09-27T19:02:33Z

@andreasabel Do you think this needs a test case? If not, I'm merging it. (If so, how?)

4e554c4c · 2023-10-06T13:46:53Z

Is this going to make it into the 2.6.4 release?

edit: no

jespercockx · 2023-11-08T15:00:11Z

@plt-amy Is now a good time to merge this?

plt-amy · 2023-11-08T15:05:50Z

I think so, yeah!

andreasabel

Thanks for this PR.

There seem to be some errors in the docs, partially old errors, partially introduced by this PR.
Also, a CHANGELOG entry is missing so far.

andreasabel · 2023-11-08T16:27:40Z

doc/user-manual/tools/command-line-options.rst

@@ -111,13 +111,26 @@ General options

     Show just the version number.

+.. option:: --print-agda-app-dir
+
+     .. versionadded:: 2.6.4


This needs bumping to 2.6.4.1

andreasabel · 2023-11-08T16:27:49Z

doc/user-manual/tools/command-line-options.rst

+
+.. option:: --print-agda-data-dir
+
+     .. versionadded:: 2.6.4


andreasabel · 2023-11-08T16:29:20Z

doc/user-manual/tools/generating-html.rst

-  :samp:`cat $(agda --print-agda-dir)/html/Agda.css`.
+  :file:`{${AGDA_DATA_DIR}}/html/Agda.css`.  Since version 2.6.2, the
+  Agda data directory is printed by option
+  :option:`--print-agda-data-dir`. Thus, you can get hold of the CSS


Not entirely correct.
From 2.6.2, --print-agda-dir, since 2.6.4.1, --print-agda-data-dir.

andreasabel · 2023-11-08T16:29:44Z

doc/user-manual/tools/generating-latex.rst

+  :file:`{${AGDA_DIR}}/latex/agda.  Since version 2.6.2, the
+  Agda data directory is printed by option
+  :option:`--print-agda-data-dir`. Thus, you can get hold of the class
+  file via :samp:`cat $(agda --print-agda-data-dir)/latex/agda.sty`.


andreasabel · 2023-11-08T16:31:04Z

doc/user-manual/tools/generating-latex.rst

-  :envvar:`AGDA_DIR` is printed by option :option:`--print-agda-dir`.
-  Thus, you can get hold of the CSS file via
-  :samp:`cat $(agda --print-agda-dir)/latex/agda.sty`.
+  :file:`{${AGDA_DIR}}/latex/agda.  Since version 2.6.2, the


This should also be Agda_datadir, shouldn't it?

andreasabel · 2023-11-08T16:32:18Z

doc/user-manual/tools/command-line-options.rst

+     .. versionadded:: 2.6.4
+
+     Outputs the root of the directory structure holding Agda's data
+     files such as core libraries, style files for the backends, etc.


Should this mention the env var Agda_datadir?

andreasabel · 2023-11-08T16:42:29Z

doc/user-manual/tools/generating-html.rst

-  :envvar:`AGDA_DIR` is printed by option :option:`--print-agda-dir`.
-  Thus, you can get hold of the CSS file via
-  :samp:`cat $(agda --print-agda-dir)/html/Agda.css`.
+  :file:`{${AGDA_DATA_DIR}}/html/Agda.css`.  Since version 2.6.2, the


I think the old docs AGDA_DIR were wrong. The correct thing (now and then) should be Agda_datadir.

andreasabel · 2023-11-08T16:43:52Z

doc/user-manual/tools/package-system.rst

-overridden by setting the ``AGDA_DIR`` environment variable.
+overridden by setting the :envvar:``AGDA_DIR`` environment variable.
+
+The ``AGDA_DIR`` will fall-back to ``~/.agda``, if it exists, for


Use :envvar: here?

andreasabel · 2023-11-08T16:44:01Z

doc/user-manual/tools/package-system.rst

+
+The ``AGDA_DIR`` will fall-back to ``~/.agda``, if it exists, for
+backward compatibility reasons. You can find the precise location of
+``AGDA_DIR``  by running ``agda --print-agda-app-dir``.


andreasabel · 2023-11-08T16:46:26Z

@plt-amy agreed to write the changelog entry.
Amelia, could you also fix the docs (see my comments above)?

Co-authored-by: Andreas Abel <andreas.abel@ifi.lmu.de>

* Add XDG Base Directory support

Co-authored-by: Andreas Abel <andreas.abel@ifi.lmu.de>

4e554c4c added 2 commits September 15, 2023 22:25

Add documentation for --print-agda-app-dir

ca63acd

This commit also changes the documentation for --print-agda-dir, renaming it to --print-agda-data-dir. It also removes inconsistancies in naming between $AGDA_DIR and the agda data directory.

plt-amy requested changes Sep 27, 2023

View reviewed changes

doc/user-manual/tools/command-line-options.rst Outdated Show resolved Hide resolved

src/full/Agda/Interaction/Options/Base.hs Outdated Show resolved Hide resolved

4e554c4c added 2 commits September 27, 2023 16:21

re-add --print-agda-dir option for compatibility

e0178ed

Test plan: --------- ``` > cabal run agda -- --print-agda-data-dir /home/pounce/programming/agda/./src/data > cabal run agda -- --print-agda-dir /home/pounce/programming/agda/./src/data ```

add oxford comma

f107018

plt-amy approved these changes Sep 27, 2023

View reviewed changes

plt-amy added this to the 2.6.4.1 milestone Nov 8, 2023

plt-amy merged commit fa12905 into agda:master Nov 8, 2023
24 checks passed

andreasabel reviewed Nov 8, 2023

View reviewed changes

andreasabel assigned plt-amy Nov 8, 2023

plt-amy added a commit that referenced this pull request Nov 9, 2023

Add missing changelogs for #6858 and #6955

8ee410d

plt-amy mentioned this pull request Nov 9, 2023

Add missing changelogs for #6858 and #6955 #6967

Merged

andreasabel added a commit that referenced this pull request Nov 9, 2023

Changelog #6858: clarify the XDG situation for Windows

4ccdf38

andreasabel added a commit that referenced this pull request Nov 9, 2023

Add missing changelogs for #6858 and #6955 (#6967)

57e3382

Co-authored-by: Andreas Abel <andreas.abel@ifi.lmu.de>

andreasabel mentioned this pull request Feb 7, 2024

Bug in size preservation knisht/agda#2

Closed

JobPetrovcic pushed a commit to JobPetrovcic/agda that referenced this pull request Apr 12, 2024

Add XDG Base Directory support (agda#6858)

0b1fc9f

* Add XDG Base Directory support

JobPetrovcic pushed a commit to JobPetrovcic/agda that referenced this pull request Apr 12, 2024

Add missing changelogs for agda#6858 and agda#6955 (agda#6967)

1154263

Co-authored-by: Andreas Abel <andreas.abel@ifi.lmu.de>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add XDG Base Directory support #6858

Add XDG Base Directory support #6858

4e554c4c commented Sep 15, 2023

4e554c4c commented Sep 16, 2023

wenkokke commented Sep 16, 2023

wenkokke commented Sep 16, 2023 •

edited

Loading

4e554c4c commented Sep 16, 2023

4e554c4c commented Sep 25, 2023

wenkokke commented Sep 25, 2023 •

edited

Loading

plt-amy left a comment

plt-amy commented Sep 27, 2023

4e554c4c commented Oct 6, 2023 •

edited

Loading

jespercockx commented Nov 8, 2023

plt-amy commented Nov 8, 2023

andreasabel left a comment •

edited

Loading

andreasabel Nov 8, 2023

andreasabel Nov 8, 2023

andreasabel Nov 8, 2023

andreasabel Nov 8, 2023

andreasabel Nov 8, 2023

andreasabel Nov 8, 2023

andreasabel Nov 8, 2023

andreasabel Nov 8, 2023

andreasabel Nov 8, 2023

andreasabel commented Nov 8, 2023

Add XDG Base Directory support #6858

Add XDG Base Directory support #6858

Conversation

4e554c4c commented Sep 15, 2023

Test plan:

4e554c4c commented Sep 16, 2023

wenkokke commented Sep 16, 2023

wenkokke commented Sep 16, 2023 • edited Loading

4e554c4c commented Sep 16, 2023

4e554c4c commented Sep 25, 2023

wenkokke commented Sep 25, 2023 • edited Loading

plt-amy left a comment

Choose a reason for hiding this comment

plt-amy commented Sep 27, 2023

4e554c4c commented Oct 6, 2023 • edited Loading

jespercockx commented Nov 8, 2023

plt-amy commented Nov 8, 2023

andreasabel left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andreasabel commented Nov 8, 2023

wenkokke commented Sep 16, 2023 •

edited

Loading

wenkokke commented Sep 25, 2023 •

edited

Loading

4e554c4c commented Oct 6, 2023 •

edited

Loading

andreasabel left a comment •

edited

Loading