Xfconf Tutorial #4948

eiskasten · 2023-05-26T16:25:43Z

This PR adds a tutorial for Xfconf as mentioned in issue #280.

Basics

Short descriptions of your changes are in the release notes
(added as entry in doc/news/_preparation_next_release.md which contains _(my name)_)
Please always add them to the release notes.
Details of what you changed are in commit messages
(first line should have module: short statement syntax)
References to issues, e.g. close #X, are in the commit messages.
The buildservers are happy. If not, fix in this order:
- add a line in doc/news/_preparation_next_release.md
- reformat the code with scripts/dev/reformat-all
- make all unit tests pass
- fix all memleaks
- fix the CI itself (or rebase if already fixed)
The PR is rebased with current master.

Checklist

I added unit tests for my code
I fully described what my PR does in the documentation
(not in the PR description)
I fixed all affected documentation (see Documentation Guidelines)
I fixed all affected decisions (see Decision Process)
I added code comments, logging, and assertions as appropriate (see Coding Guidelines)
I updated all meta data (e.g. README.md of plugins and METADATA.ini)
I mentioned every code not directly written by me in reuse syntax

Review

Documentation is introductory, concise, good to read and describes everything what the PR does
Examples are well chosen and understandable
Code is conforming to our Coding Guidelines
APIs are conforming to our Design Guidelines
Code is consistent to our Design Decisions

Labels

Add the "work in progress" label if you do not want the PR to be reviewed yet.
Add the "ready to merge" label if everything is done and no further pushes are planned by you.

eiskasten · 2023-05-27T10:16:01Z

jenkins build libelektra please

hannes99

Maybe a short section on when what namespace makes sense. Other than that LGTM!

hannes99 · 2023-05-29T18:40:52Z

doc/tutorials/xfconf.md

+# Setting the value to `false` beforehand
+xfconf-query -c thunar -p /misc-single-click -s false -t bool -n
+
+kdb set /sw/xfce4/thunar/misc-single-click TRUE


Is dir: where this should end up? Maybe user: or spec: might make more sense, no?

Thank you for your review! You are right, the namespace which makes most sense to me are user: and system:. I just have overseen, that the default seemed to change.

tucek

LGTM!

eiskasten · 2023-06-05T20:24:16Z

jenkins build libelektra please

markus2330

Tutorial is great and easy to follow but doesn't provide enough material to be actually able to reconfigure xfce4 and unfortunately did not work on Debian bullseye.

markus2330 · 2023-06-07T17:41:17Z

doc/tutorials/xfconf.md

+# Setting the value to `false` beforehand
+xfconf-query -c thunar -p /misc-single-click -s false -t bool -n
+
+kdb set system:/sw/xfce4/thunar/misc-single-click TRUE


Sorry, 12 warnings were issued ;( 1: Module backend issued the warning C01200: Installation: No storage plugin defined for kdbGet(). You probably forgot to set 'system:/elektra/mountpoints/proc:\/sw\/xfce4\/thunar/definition/positions/get/storage'. If the configuration is intentional, you can silence this warning by setting 'system:/elektra/mountpoints/proc:\/sw\/xfce4\/thunar/definition/positions/get/storage/omit' to any value. (Configuration of mountpoint: 'proc:/sw/xfce4/thunar') 2: Module kdb issued the warning C01320: Interface: Calling the kdbInit function for the backend plugin ('backend') of the mountpoint 'proc:/sw/xfce4/thunar' has failed. 3: Module backend issued the warning C01200: Installation: No storage plugin defined for kdbGet(). You probably forgot to set 'system:/elektra/mountpoints/dir:\/sw\/xfce4\/thunar/definition/positions/get/storage'. If the configuration is intentional, you can silence this warning by setting 'system:/elektra/mountpoints/dir:\/sw\/xfce4\/thunar/definition/positions/get/storage/omit' to any value. (Configuration of mountpoint: 'dir:/sw/xfce4/thunar') 4: Module backend issued the warning C01200: Installation: You defined a set-resolver plugin, but no storage plugin for kdbSet(). You probably forgot to set 'system:/elektra/mountpoints/dir:\/sw\/xfce4\/thunar/definition/positions/set/storage'. (Configuration of mountpoint: 'dir:/sw/xfce4/thunar') 5: Module kdb issued the warning C01320: Interface: Calling the kdbInit function for the backend plugin ('backend') of the mountpoint 'dir:/sw/xfce4/thunar' has failed. 6: Module backend issued the warning C01200: Installation: No storage plugin defined for kdbGet(). You probably forgot to set 'system:/elektra/mountpoints/user:\/sw\/xfce4\/thunar/definition/positions/get/storage'. If the configuration is intentional, you can silence this warning by setting 'system:/elektra/mountpoints/user:\/sw\/xfce4\/thunar/definition/positions/get/storage/omit' to any value. (Configuration of mountpoint: 'user:/sw/xfce4/thunar') 7: Module backend issued the warning C01200: Installation: You defined a set-resolver plugin, but no storage plugin for kdbSet(). You probably forgot to set 'system:/elektra/mountpoints/user:\/sw\/xfce4\/thunar/definition/positions/set/storage'. (Configuration of mountpoint: 'user:/sw/xfce4/thunar') 8: Module kdb issued the warning C01320: Interface: Calling the kdbInit function for the backend plugin ('backend') of the mountpoint 'user:/sw/xfce4/thunar' has failed. 9: Module backend issued the warning C01200: Installation: No storage plugin defined for kdbGet(). You probably forgot to set 'system:/elektra/mountpoints/system:\/sw\/xfce4\/thunar/definition/positions/get/storage'. If the configuration is intentional, you can silence this warning by setting 'system:/elektra/mountpoints/system:\/sw\/xfce4\/thunar/definition/positions/get/storage/omit' to any value. (Configuration of mountpoint: 'system:/sw/xfce4/thunar') 10: Module backend issued the warning C01200: Installation: You defined a set-resolver plugin, but no storage plugin for kdbSet(). You probably forgot to set 'system:/elektra/mountpoints/system:\/sw\/xfce4\/thunar/definition/positions/set/storage'. (Configuration of mountpoint: 'system:/sw/xfce4/thunar') 11: Module kdb issued the warning C01320: Interface: Calling the kdbInit function for the backend plugin ('backend') of the mountpoint 'system:/sw/xfce4/thunar' has failed. 12: Module kdb issued the warning C01320: Interface: The init phase of kdbGet() has failed. See warnings for details. Sorry, module backend issued the error C01200: Installation: You defined a set-resolver plugin, but no storage plugin for kdbSet(). You probably forgot to set 'system:/elektra/mountpoints/proc:\/sw\/xfce4\/thunar/definition/positions/set/storage'. (Configuration of mountpoint: 'proc:/sw/xfce4/thunar')

#4947 fixed this. Since I rebased this PR after you tried it, that should work now.

markus2330 · 2023-06-07T17:43:51Z

doc/tutorials/xfconf.md

+
+```shell
+# Use Elektra instead of Xfconf system-wide
+kdb xfconf-system-lib-replace


/usr/lib/libxfconf-0.so.3.0.0 not found on my system it is in /usr/lib/x86_64-linux-gnu/libxfconf-0.so.3.0.0

#4960 Should solve this

markus2330 · 2023-06-07T17:45:35Z

doc/tutorials/xfconf.md

+kdb xfconf-user-lib replace
+
+# When replacing only the users library, either restart the session or run
+source ~/.xprofile


ERROR: ld.so: object '/usr/lib/libxfconf-elektra-5.0.so' from LD_PRELOAD cannot be preloaded (cannot open shared object file): ignored.. It should be export LD_PRELOAD="/usr/lib/libxfconf-elektra.so" inestead.

#4960 should solve this

markus2330 · 2023-06-07T17:47:11Z

doc/tutorials/xfconf.md

+#> Create a new key system:/sw/org/xfce/xfconf/test/hello with string "world"
+
+# Verify it with Xfconf
+xfconf-query -c test -p hello


Property "hello" does not exist on channel "test"

This is solved by 5d83e51

markus2330 · 2023-06-07T17:53:13Z

doc/tutorials/xfconf.md

+However, Xfce also uses some properties that are not stored in Xfconf.
+These properties will not work properly.
+An example of such a property is the Gtk theme.
+


Give a bit more examples what can be done. kdb set system:/sw/xfce4/thunar/misc-single-click TRUE didn't work for me.

I changed it a bit in abb6523 which should work now

markus2330 · 2023-06-07T17:59:21Z

doc/tutorials/xfconf.md

+kdb xfconf-system-lib-replace
+
+# Use Elektra instead of Xfconf only for the current user
+kdb xfconf-user-lib replace


Suggested change

kdb xfconf-user-lib replace

kdb xfconf-user-lib-replace && source ~/.xprofile

Done in 8486a89

markus2330 · 2023-06-07T18:01:47Z

doc/tutorials/xfconf.md

+
+```shell
+# Set an Xfconf property with Elektra
+kdb set system:/sw/org/xfce/xfconf/test/hello world


kdb: symbol lookup error: /usr/lib/libxfconf-elektra.so: undefined symbol: g_log

Should be solved by #4960

Looks like some dependency is missing.

Did you test also on Debian bullseye? In general some additional testing would be great.

markus2330 · 2023-06-07T18:04:33Z

src/plugins/xfconf/README.md

- infos/provides = storage/xfconf
+- infos/provides = storage/xml


This should be in a different PR to merge it first.

This was actually an accident. I committed it in two different PRs, the other one was #4947. Since I rebased this PR with the master, this PR will not change anything regarding this.

markus2330 · 2023-06-07T18:05:12Z

doc/tutorials/xfconf.md

+
+The following table shows a comparison between the different type systems.
+
+| Xfconf   | Elektra                    | Note                                                                                         |


Please also a xfce4 example per type.

Xfce actually only uses a few of them. I added examples to the types I have found in abb6523.

markus2330 · 2023-06-08T16:12:11Z

Btw. I think also restart of xfconfd is needed so that some parts of the tutorial actually can work? (Logout/Login does not restart xfconfd for me, and without restart it cannot pick up a different library).

eiskasten · 2023-06-08T16:52:58Z

Btw. I think also restart of xfconfd is needed so that some parts of the tutorial actually can work? (Logout/Login does not restart xfconfd for me, and without restart it cannot pick up a different library).

I do not think that this is necessary. Xfconfd is only used by the original libxfconf-0 for things such as caching or property monitoring. Since the Xfconf implementation of Elektra does not use it at all, it should be no problem. However, I do not know if some applications interact directly with it (which they definitely should not do at all). For that it should be enough to just kill it but I never run into problems with that.

eiskasten · 2023-06-08T16:53:37Z

Tutorial is great and easy to follow but doesn't provide enough material to be actually able to reconfigure xfce4 and unfortunately did not work on Debian bullseye.

Thank you for the review. I provided corrections for the requested things.

eiskasten · 2023-06-14T19:56:44Z

I have tested and fixed it for debian now and it works with the buster image within the repository. However, please make sure to use #4960 since this PR contains fixes which are mandatory to debian.

eiskasten · 2023-06-15T08:42:11Z

jenkins build libelektra please

markus2330 · 2023-07-14T13:36:51Z

jenkins build libelektra please

eiskasten force-pushed the tutorial/types branch from c757d3d to 7e566f6 Compare May 28, 2023 10:17

eiskasten changed the title ~~Tutorial/types~~ Xfconf Tutorial May 28, 2023

eiskasten requested a review from tucek May 28, 2023 15:18

hannes99 self-requested a review May 29, 2023 18:39

hannes99 approved these changes May 29, 2023

View reviewed changes

tucek approved these changes Jun 4, 2023

View reviewed changes

eiskasten requested a review from markus2330 June 6, 2023 21:17

markus2330 suggested changes Jun 7, 2023

View reviewed changes

eiskasten added 7 commits June 8, 2023 14:21

doc: Write xfconf storage tutorial section

d620b0e

doc: Update release notes

ba412af

doc: Add tutorial section on how to use the xfconf binding

b177509

doc: Add type comparison table

a5c4fa1

doc: Fix meta key spacing

06a9d62

doc: Use system namespace

5d00b6c

doc: Fix xfconf replace command in tutorial

8486a89

eiskasten added 3 commits June 8, 2023 18:26

doc: Reset property before setting it

2356745

doc: Append / to property name

5d83e51

doc: Add xfce property examples

abb6523

eiskasten force-pushed the tutorial/types branch from 6262fee to abb6523 Compare June 8, 2023 16:42

doc: Add more properties in xfconf tutorial

aae8d2d

eiskasten mentioned this pull request Jul 11, 2023

Release v0.11.0 #4974

Merged

19 tasks

markus2330 merged commit 6fe5335 into ElektraInitiative:master Jul 14, 2023

eiskasten deleted the tutorial/types branch July 16, 2023 09:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Xfconf Tutorial #4948

Xfconf Tutorial #4948

eiskasten commented May 26, 2023 •

edited

Loading

eiskasten commented May 27, 2023

hannes99 left a comment

hannes99 May 29, 2023 •

edited

Loading

eiskasten May 31, 2023

tucek left a comment

eiskasten commented Jun 5, 2023

markus2330 left a comment

markus2330 Jun 7, 2023

eiskasten Jun 8, 2023

markus2330 Jun 7, 2023

eiskasten Jun 8, 2023

markus2330 Jun 7, 2023

eiskasten Jun 8, 2023

markus2330 Jun 7, 2023

eiskasten Jun 8, 2023

markus2330 Jun 7, 2023

eiskasten Jun 8, 2023

markus2330 Jun 7, 2023

eiskasten Jun 8, 2023

markus2330 Jun 7, 2023

eiskasten Jun 8, 2023

markus2330 Jun 8, 2023

markus2330 Jun 7, 2023

eiskasten Jun 8, 2023

markus2330 Jun 7, 2023

eiskasten Jun 8, 2023

markus2330 commented Jun 8, 2023

eiskasten commented Jun 8, 2023

eiskasten commented Jun 8, 2023

eiskasten commented Jun 14, 2023

eiskasten commented Jun 15, 2023

markus2330 commented Jul 14, 2023

	kdb xfconf-user-lib replace
	kdb xfconf-user-lib-replace && source ~/.xprofile

		- infos/provides = storage/xfconf
		- infos/provides = storage/xml


		The following table shows a comparison between the different type systems.

		\| Xfconf \| Elektra \| Note \|

Xfconf Tutorial #4948

Xfconf Tutorial #4948

Conversation

eiskasten commented May 26, 2023 • edited Loading

Basics

Checklist

Review

Labels

eiskasten commented May 27, 2023

hannes99 left a comment

Choose a reason for hiding this comment

hannes99 May 29, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tucek left a comment

Choose a reason for hiding this comment

eiskasten commented Jun 5, 2023

markus2330 left a 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

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

Choose a reason for hiding this comment

markus2330 commented Jun 8, 2023

eiskasten commented Jun 8, 2023

eiskasten commented Jun 8, 2023

eiskasten commented Jun 14, 2023

eiskasten commented Jun 15, 2023

markus2330 commented Jul 14, 2023

eiskasten commented May 26, 2023 •

edited

Loading

hannes99 May 29, 2023 •

edited

Loading