Skip to content
This repository has been archived by the owner on Oct 15, 2024. It is now read-only.

Commit

Permalink
fixes and TODOs after removal of kdb global-mount
Browse files Browse the repository at this point in the history
  • Loading branch information
kodebach committed Oct 12, 2022
1 parent 4b8fc16 commit a212576
Show file tree
Hide file tree
Showing 13 changed files with 26 additions and 18 deletions.
7 changes: 0 additions & 7 deletions doc/help/kdb-spec-mount.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,6 @@ sudo kdb spec-mount /example/mountpoint # mounts /example/mountpoint according
This command writes into the `/etc` directory and as such it requires root permissions.
Use `kdb file system:/elektra/mountpoints` to find out where exactly it will write to.

Note that many specifications have globs like `_` and `#`. They will only work if
the `spec` plugin is present:

```
kdb global-mount
```

## OPTIONS

- `-H`, `--help`:
Expand Down
2 changes: 1 addition & 1 deletion doc/man/man1/kdb-qt-gui.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" generated with Ronn-NG/v0.10.1
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1.pre1
.TH "README" "" "January 2022" ""
.TH "README" "" "October 2022" ""
.SH "Introduction"
The tool \fBqt\-gui\fR offers a graphical interface for users of Elektra\. It allows users to create, manage, edit, and delete keys stored in the global key database (KDB)\.
.SH "Compiling and Installation"
Expand Down
9 changes: 1 addition & 8 deletions doc/man/man1/kdb-spec-mount.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" generated with Ronn-NG/v0.10.1
.\" http://github.com/apjanke/ronn-ng/tree/0.10.1.pre1
.TH "KDB\-SPEC\-MOUNT" "1" "November 2020" ""
.TH "KDB\-SPEC\-MOUNT" "1" "October 2022" ""
.SH "NAME"
\fBkdb\-spec\-mount\fR \- Mount a spec file to the key database
.SH "SYNOPSIS"
Expand Down Expand Up @@ -44,13 +44,6 @@ sudo kdb spec\-mount /example/mountpoint # mounts /example/mountpoint according
.IP "" 0
.SH "IMPORTANT"
This command writes into the \fB/etc\fR directory and as such it requires root permissions\. Use \fBkdb file system:/elektra/mountpoints\fR to find out where exactly it will write to\.
.P
Note that many specifications have globs like \fB_\fR and \fB#\fR\. They will only work if the \fBspec\fR plugin is present:
.IP "" 4
.nf
kdb global\-mount
.fi
.IP "" 0
.SH "OPTIONS"
.TP
\fB\-H\fR, \fB\-\-help\fR
Expand Down
2 changes: 2 additions & 0 deletions doc/tutorials/notifications.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Notification Tutorial

<!-- FIXME [new_backend]: outdated (global-mount)-->

## Preface

**The features described in this document are experimental.**
Expand Down
3 changes: 1 addition & 2 deletions scripts/docker/website/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,7 @@ RUN --mount=type=tmpfs,target=/tmp \
&& ldconfig

ARG URL=https://www.libelektra.org/
RUN kdb global-mount \
&& kdb mount-website-config \
RUN kdb mount-website-config \
&& kdb set system:/sw/elektra/websitefrontend/#0/current/website/url "${URL}" \
&& kdb build-website

Expand Down
1 change: 1 addition & 0 deletions src/plugins/conditionals/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ sudo kdb umount user:/tests/conditionals
Global plugin example:

<!-- FIXME [new_backend]: tests disabled -->
<!-- FIXME [new_backend]: outdated (global-mount) -->

```
# Backup old list of global plugins
Expand Down
2 changes: 2 additions & 0 deletions src/plugins/dbus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ Alternatively, (with the option announce=once) only a single message is send:

## Usage

<!-- FIXME [new_backend]: outdated -->

The recommended way is to globally mount the plugin:

```sh
Expand Down
4 changes: 4 additions & 0 deletions src/plugins/dbusrecv/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ The package is called `libelektra5-dbus`.

## Usage

<!-- FIXME [new_backend]: outdated -->

The recommended way is to globally mount the plugin together with the dbus plugin:

```sh
Expand All @@ -43,6 +45,8 @@ plugin is mounted globally.

# Transport Plugin

<!-- FIXME [new_backend]: outdated -->

Mount this plugin globally with default settings to use it as _receiving_
transport plugin for Elektra's notification feature:

Expand Down
2 changes: 2 additions & 0 deletions src/plugins/profile/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ The package is called `libelektra5-extra`.

## Example

<!-- FIXME [new_backend]: outdated -->

Suppose we have the configuration file `profile.ini` in `~/.config`:

```sh
Expand Down
2 changes: 2 additions & 0 deletions src/plugins/spec/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,8 @@ not individual keys' metakeys. It also applies to `kdbGet` and `kdbSet` calls.

## Examples

<!-- FIXME [new_backend]: outdated -->

Ni files can be found in [/examples/spec](/examples/spec) which should be PWD
so that the example works:

Expand Down
4 changes: 4 additions & 0 deletions src/plugins/zeromqrecv/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ The package is called `libelektra5-zeromq`.

## Usage

<!-- FIXME [new_backend]: outdated -->

The recommended way is to globally mount the plugin together with the zeromqsend plugin:

kdb global-mount zeromqsend zeromqrecv
Expand All @@ -42,6 +44,8 @@ provides these endpoints.

# Transport Plugin

<!-- FIXME [new_backend]: outdated -->

Mount this plugin globally with default settings to use it as _receiving_
transport plugin for Elektra's notification feature:

Expand Down
4 changes: 4 additions & 0 deletions src/plugins/zeromqsend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ The package is called `libelektra5-zeromq`.

## Usage

<!-- FIXME [new_backend]: outdated -->

The recommended way is to globally mount the plugin together with the zeromqrecv plugin:

> kdb global-mount zeromqsend zeromqrecv
Expand All @@ -42,6 +44,8 @@ provides these endpoints.

# Transport Plugin

<!-- FIXME [new_backend]: outdated -->

Mount this plugin globally with default settings to use it as _sending_
transport plugin for Elektra's notification feature:

Expand Down
2 changes: 2 additions & 0 deletions src/tools/qt-gui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ sudo apt-get install \

### Change Notification

<!-- FIXME [new_backend]: outdated -->

It is recommended to use the viewer mode if DBus notifications are expected.
Use "Settings -> Viewermode" to activate the viewermode.

Expand Down

0 comments on commit a212576

Please sign in to comment.