[PATCH] home: services: Add home-zathura-service-type.

Open

Details

4 participants

Oleg Pykhalov
lgcoelho
Ludovic Courtès
Sergey Trofimov

Owner: unassigned

Submitted by: lgcoelho

Severity: normal

lgcoelho wrote on 24 Dec 2023 19:26

Recipients:(address . guix-patches@gnu.org)

Message-ID:a4e1ffea3e66951afff930078db97976@disroot.org

This service enables a declarative configuration of zathura, the

customizable document viewer.

Attachment: file

Attachment: 0001-home-services-Add-home-zathura-service-type.patch (.02 MiB)

Sergey Trofimov wrote on 26 Dec 2023 10:33

Recipients:(address . lgcoelho@disroot.org)

Message-ID:874jg5gvfn.fsf@sarg.org.ru

lgcoelho@disroot.org writes:

Toggle quote (3 lines)

> This service enables a declarative configuration of zathura, the

> customizable document viewer.

I have mixed feelings about pulling 3rd-party software 
configurations in guix:
- adding it to guix increases maintenance burden: new versions 
  could add or remove config options
- it bloats guix: imagine if we add configs for every 
  user-configurable app
- such configs are not easily transferrable: if I were to use the 
  same app in non-guix env, I'd have to maintain 2 configs

Another recent example is `oci-container-configuration` which 
defines a subset of docker-cli startup arguments. The problem is 
that `docker run` command has 96 options and the configuration 
only uses a handful, lacking a way to provide the remaining ones.

I think guix should not embed config generators for user software. 
The only need I see for such generators is when there are options 
which should be the same among multiple applications (e.g. color 
schemes or shared directories). For such usecase guix should 
provide better text manipulation tools which home owners could use 
to parameterise configs.

Oleg Pykhalov wrote on 26 Dec 2023 13:11

Recipients:(name . Sergey Trofimov)(address . sarg@sarg.org.ru)(address . 68010@debbugs.gnu.org)

Message-ID:87edf94102.fsf@gmail.com

Hi Sergey,

Sergey Trofimov <sarg@sarg.org.ru> writes:

Toggle quote (18 lines)> I have mixed feelings about pulling 3rd-party software configurations in guix:
> - adding it to guix increases maintenance burden: new versions   could add or
>  remove config options
> - it bloats guix: imagine if we add configs for every   user-configurable app
> - such configs are not easily transferrable: if I were to use the   same app
>  in non-guix env, I'd have to maintain 2 configs
>
> Another recent example is `oci-container-configuration` which defines a subset
> of docker-cli startup arguments. The problem is that `docker run` command has
> 96 options and the configuration only uses a handful, lacking a way to provide
> the remaining ones.
>
> I think guix should not embed config generators for user software. The only
> need I see for such generators is when there are options which should be the
> same among multiple applications (e.g. color schemes or shared
> directories). For such usecase guix should provide better text manipulation
> tools which home owners could use to parameterise configs.

It's a bit too off-topic to dive into general configurations in Guix

within the context of the current patch series and should probably be

discussed in a ‘guix-devel’ mailing list or ‘#guix’ IRC channel.

Regards,

Oleg.

Ludovic Courtès wrote on 8 Jan 09:46 +0100

Recipients:(name . Sergey Trofimov)(address . sarg@sarg.org.ru)

Message-ID:87wmsk6wlh.fsf@inria.fr

Hello,

Sergey Trofimov <sarg@sarg.org.ru> skribis:

Toggle quote (26 lines)> lgcoelho@disroot.org writes:
>
>> This service enables a declarative configuration of zathura, the
>> customizable document viewer.
>
> I have mixed feelings about pulling 3rd-party software configurations
> in guix:
> - adding it to guix increases maintenance burden: new versions   could
>  add or remove config options
> - it bloats guix: imagine if we add configs for every
>   user-configurable app
> - such configs are not easily transferrable: if I were to use the
>   same app in non-guix env, I'd have to maintain 2 configs
>
> Another recent example is `oci-container-configuration` which defines
> a subset of docker-cli startup arguments. The problem is that `docker
> run` command has 96 options and the configuration only uses a handful,
> lacking a way to provide the remaining ones.
>
> I think guix should not embed config generators for user software. The
> only need I see for such generators is when there are options which
> should be the same among multiple applications (e.g. color schemes or
> shared directories). For such usecase guix should provide better text
> manipulation tools which home owners could use to parameterise
> configs.

I guess it’s a tradeoff. The usual approach for System/Home services

has been to provide “bindings” (a record type) for the config, *plus* an

“escape hatch” (letting users pass raw config as a string).

But you’re right, the expected maintenance burden should be taken into

account. For well-established software and config formats such as Git,

it’s probably okay to have bindings; for things that are more

recent/changing, it’s less obvious. Also, we currently don’t have tests

for Home services, except for those mapped from System services, which

means breakage isn’t automatically detected.

I don’t know whether Zathura falls in the “okay” category or rather in

the “let’s do write bindings” one.

Ludo’.

Oleg Pykhalov wrote on 23 Jan 14:09 +0100

Recipients:(address . lgcoelho@disroot.org)(address . 68010@debbugs.gnu.org)

Message-ID:875xzk8adm.fsf@gmail.com

Hello, Luis.

Apologies for delay.

Could you send a new patch with applied following suggestions, please?

lgcoelho@disroot.org writes:

Toggle quote (9 lines)

> This service enables a declarative configuration of zathura, the customizable

> document viewer.

> commit 76954ed7dc32ac86ee22566cc03cadc5f9fc1864

> Author: Luis Guilherme Coelho <lgcoelho@disroot.org>

> Date: Sun Dec 24 15:16:43 2023 -0300

> home: services: Add home-zathura-service-type

The commit message should look like:

Toggle snippet (6 lines)

home: services: Add zathura service.

* gnu/home/services/zathura.scm: New file.

* doc/guix.texi (SPECIFY SECTION HERE): Document this.

Toggle quote (6 lines)

> diff --git a/gnu/home/services/zathura.scm b/gnu/home/services/zathura.scm

> new file mode 100644

> index 0000000000..0695ce1614

> --- /dev/null

> +++ b/gnu/home/services/zathura.scm

[…]

Toggle quote (12 lines)> +(define home-zathura-service-type
> +  (service-type
> +   (name 'zathura-service)
> +   (extensions
> +    (list (service-extension
> +            home-xdg-configuration-files-service-type
> +            zathura-xdg-configuration-file-service)))
> +   (compose identity)
> +   (extend home-zathura-extensions)
> +   (default-value (home-zathura-configuration))
> +   (description "Set ~/.config/zathura.conf")))

Description should mention that the service configures the Zathura PDF

viewer, e.g.:

Configure the Zathura PDF viewer by providing a

@file{~/.config/zathura.conf} file.

Toggle quote (3 lines)

> +(define (generate-doc)

> + (configuration->documentation 'home-zathura-configuration))

The service documentation should be added to doc/guix.texi file.

See ZNC home service as an example.

Fields documentation could be generated with:

Toggle snippet (14 lines)

~/src/git.savannah.gnu.org/git/guix$ ./pre-inst-env guix repl

GNU Guile 3.0.9

Guile comes with ABSOLUTELY NO WARRANTY; for details type `,show w'.

This program is free software, and you are welcome to redistribute it

under certain conditions; type `,show c' for details.

Enter `,help' for help.

scheme@(guix-user)> ,m(gnu home services zathura)

scheme@(gnu home services zathura)> (generate-doc)

Thanks,

Oleg.

Oleg Pykhalov wrote on 23 Jan 14:13 +0100

Recipients:(address . lgcoelho@disroot.org)(address . 68010@debbugs.gnu.org)

Message-ID:8734uo8a6u.fsf@gmail.com

Oleg Pykhalov <go.wigust@gmail.com> writes:

Toggle quote (2 lines)

> Could you send a new patch with applied following suggestions, please?

Also, the gnu/local.mk file should include gnu/home/services/zathura.scm
and it should be noted in the Git commit message accordingly, see
‘git log gnu/local.mk’ for an example message.

Your comment

Commenting via the web interface is currently disabled.

To comment on this conversation send an email to 68010@debbugs.gnu.org

is:open	open issues
is:done	closed issues
submitter:<who>	search issue submitter
author:<who>	search by message author
date:yesterday..now	search by issue date
mdate:3m..2d	search by message date