[bug#43194] [PATCH] gnu: publicly define freedink-engine and freedink-data

[bug#43194] [PATCH] gnu: publicly define freedink-engine and freedink-data

[Jesse Gibbons]

[-- Attachment #1: Type: text/plain, Size: 214 bytes --]

The attached patch publicly defines freedink-engine and freedink-data. 
This resolves many of the issues described in #43061. This patch, 
combined with patch #43193(sent earlier today), can close #43061.

-Jesse


[-- Attachment #2: v1-0001-gnu-publicly-define-freedink-engine-and-freedink-.patch --]
[-- Type: text/x-patch, Size: 2194 bytes --]

From 583215aced9b557d6f4e54b290e788d33880c03c Mon Sep 17 00:00:00 2001
From: Jesse Gibbons <jgibbons2357+guix@gmail.com>
Date: Wed, 26 Aug 2020 21:38:24 -0600
Subject: [PATCH v1 1/1] gnu: publicly define freedink-engine and freedink-data

* gnu/packages/games.scm: (freedink-engine): make public
(freedink-data): make public
---
 gnu/packages/games.scm | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

diff --git a/gnu/packages/games.scm b/gnu/packages/games.scm
index ccdc47d5c7..7540cf4603 100644
--- a/gnu/packages/games.scm
+++ b/gnu/packages/games.scm
@@ -2859,7 +2859,7 @@ interface or via an external visual interface such as GNU XBoard.")
                   (ftp-directory . "/chess")))
     (license license:gpl3+)))
 
-(define freedink-engine
+(define-public freedink-engine
   (package
     (name "freedink-engine")
     (version "109.6")
@@ -2911,7 +2911,7 @@ game data files but it also supports user-produced game mods or \"D-Mods\".
 To that extent, it also includes a front-end for managing all of your D-Mods.")
     (license license:gpl3+)))
 
-(define freedink-data
+(define-public freedink-data
   (package
     (name "freedink-data")
     (version "1.08.20190120")
@@ -2963,8 +2963,10 @@ and its numerous D-Mods.")
 
 (define-public freedink
   ;; This is a wrapper that tells the engine where to find the data.
-  (package (inherit freedink-engine)
+  (package ;(inherit freedink-engine)
     (name "freedink")
+    (version (package-version freedink-engine))
+    (source #f)
     (build-system trivial-build-system)
     (arguments
      '(#:builder (begin
@@ -2987,7 +2989,13 @@ exec ~a/bin/freedink -refdir ~a/share/dink\n"
     (inputs `(("engine" ,freedink-engine)
               ("data" ,freedink-data)
               ("bash" ,bash)))
-    (native-inputs '())))
+    (native-inputs '())
+    (home-page (package-home-page freedink-engine))
+    (synopsis (package-synopsis freedink-engine))
+    (description (string-append (package-description freedink-engine)
+"\n\nThis package provides a wrapper that points the engine to
+the upstream \"vanilla\" data."))
+    (license license:gpl3+)))
 
 (define-public xboard
   (package
-- 
2.28.0

[bug#43194] [PATCH] gnu: publicly define freedink-engine and freedink-data

[Ludovic Courtès]

Hi,

Jesse Gibbons <jgibbons2357@gmail.com> skribis:

> The attached patch publicly defines freedink-engine and
> freedink-data. This resolves many of the issues described in
> #43061. This patch, combined with patch #43193(sent earlier today),
> can close #43061.

Now I’m confused: how does it help to make freedink-{engine,data}
public?

>>From 583215aced9b557d6f4e54b290e788d33880c03c Mon Sep 17 00:00:00 2001
> From: Jesse Gibbons <jgibbons2357+guix@gmail.com>
> Date: Wed, 26 Aug 2020 21:38:24 -0600
> Subject: [PATCH v1 1/1] gnu: publicly define freedink-engine and freedink-data
>
> * gnu/packages/games.scm: (freedink-engine): make public
> (freedink-data): make public

[...]

>  (define-public freedink
>    ;; This is a wrapper that tells the engine where to find the data.
> -  (package (inherit freedink-engine)
> +  (package ;(inherit freedink-engine)

Is it intended?  Looks like inheriting avoids duplicating fields, no?

Thanks,
Ludo’.

[bug#43194] [PATCH] gnu: publicly define freedink-engine and freedink-data

[Jesse Gibbons]

Thank you for reviewing.

On 9/7/20 7:46 AM, Ludovic Courtès wrote:
> Hi,
>
> Jesse Gibbons <jgibbons2357@gmail.com> skribis:
>
>> The attached patch publicly defines freedink-engine and
>> freedink-data. This resolves many of the issues described in
>> #43061. This patch, combined with patch #43193(sent earlier today),
>> can close #43061.
> Now I’m confused: how does it help to make freedink-{engine,data}
> public?
Other than making guix more consistent in publicly defining game data 
packages (0ad-data and megaglest-data are public, and I like that -- I 
could write a good article about why, which I think would be a worthy 
entry in the guix blog, especially after #43193 is applied), there are 4 
reasons for this change:

-> freedink-dfarc has problems locating the editor, installed in 
freedink-engine. I guess we could also fix this by making 
freedink-engine an input to freedink-dfarc and splicing a reference to 
it into the default configuration?

-> Unless freedink-data is public, `guix build --source freedink-data` 
fails, and `guix build --sources=all freedink` does not build a source 
for freedink-data. I think future users who want to alter the freedink 
data would appreciate the ability to use guix to get the data. Also, 
it's pointless to use the editor on the installed freedink-data because 
it's read-only when it's installed.

-> Back when I was fixing freedink, I found it difficult to debug 
without freedink-engine being public, because freedink does nothing with 
the freedink-engine source.

-> Freedink-engine installs desktop files to launch freedink without 
freedink-dfarc or the console. This is actually a new issue I will 
address in an updated patch: the desktop files fail because the data 
location is not hard-coded. I think the freedink desktop file can be 
patched if freedink-data is an input, but, like I said above, it's 
pointless to use dinkedit on a read-only directory, so I intend to 
remove it.

>
>> >From 583215aced9b557d6f4e54b290e788d33880c03c Mon Sep 17 00:00:00 2001
>> From: Jesse Gibbons <jgibbons2357+guix@gmail.com>
>> Date: Wed, 26 Aug 2020 21:38:24 -0600
>> Subject: [PATCH v1 1/1] gnu: publicly define freedink-engine and freedink-data
>>
>> * gnu/packages/games.scm: (freedink-engine): make public
>> (freedink-data): make public
> [...]
>
>>   (define-public freedink
>>     ;; This is a wrapper that tells the engine where to find the data.
>> -  (package (inherit freedink-engine)
>> +  (package ;(inherit freedink-engine)
> Is it intended?  Looks like inheriting avoids duplicating fields, no?

Oops! I did not intend to leave (inherit freedink-engine) in a comment. 
I initially commented it out because freedink does nothing with the 
source anyway, and I wanted to see what would happen if I removed the 
inheritance. I guess I forgot to remove the semicolon and other additions.

As noted above, it is easiest to use freedink-dfarc to launch the 
editor, but freedink-dfarc must be told what editor to use, and it is 
easier to identify it if the editor is installed in a profile (or 
included as an input). Also, freedink-engine includes (broken) desktop 
files. Since freedink just installs a wrapper script around the engine, 
and does not include the editor or any desktop files, perhaps it would 
be better to put the wrapper script in freedink-engine (thus fixing the 
desktop file), completely remove the freedink package, and rename 
"freedink-engine" to just "freedink"? But freedink-dfarc would still 
need to be able to launch freedink without pointing to any read-only 
data if a user wants to test the edited freedink data.

>
> Thanks,
> Ludo’.
-Jesse

[bug#43194] [PATCH] gnu: publicly define freedink-engine and freedink-data

[Ludovic Courtès]

Hi,

Jesse Gibbons <jgibbons2357@gmail.com> skribis:

>>> The attached patch publicly defines freedink-engine and
>>> freedink-data. This resolves many of the issues described in
>>> #43061. This patch, combined with patch #43193(sent earlier today),
>>> can close #43061.
>> Now I’m confused: how does it help to make freedink-{engine,data}
>> public?
> Other than making guix more consistent in publicly defining game data
> packages (0ad-data and megaglest-data are public, and I like that -- I
> could write a good article about why, which I think would be a worthy
> entry in the guix blog, especially after #43193 is applied), there are
> 4 reasons for this change:
>
> -> freedink-dfarc has problems locating the editor, installed in
> freedink-engine. I guess we could also fix this by making
> freedink-engine an input to freedink-dfarc and splicing a reference to
> it into the default configuration?
>
> -> Unless freedink-data is public, `guix build --source freedink-data`
> fails, and `guix build --sources=all freedink` does not build a source
> for freedink-data. I think future users who want to alter the freedink
> data would appreciate the ability to use guix to get the data. Also,
> it's pointless to use the editor on the installed freedink-data
> because it's read-only when it's installed.
>
> -> Back when I was fixing freedink, I found it difficult to debug
> without freedink-engine being public, because freedink does nothing
> with the freedink-engine source.
>
> -> Freedink-engine installs desktop files to launch freedink without
> freedink-dfarc or the console. This is actually a new issue I will
> address in an updated patch: the desktop files fail because the data
> location is not hard-coded. I think the freedink desktop file can be
> patched if freedink-data is an input, but, like I said above, it's
> pointless to use dinkedit on a read-only directory, so I intend to
> remove it.

OK, makes sense—thanks for explaining.

>>> >From 583215aced9b557d6f4e54b290e788d33880c03c Mon Sep 17 00:00:00 2001
>>> From: Jesse Gibbons <jgibbons2357+guix@gmail.com>
>>> Date: Wed, 26 Aug 2020 21:38:24 -0600
>>> Subject: [PATCH v1 1/1] gnu: publicly define freedink-engine and freedink-data
>>>
>>> * gnu/packages/games.scm: (freedink-engine): make public
>>> (freedink-data): make public
>> [...]
>>
>>>   (define-public freedink
>>>     ;; This is a wrapper that tells the engine where to find the data.
>>> -  (package (inherit freedink-engine)
>>> +  (package ;(inherit freedink-engine)
>> Is it intended?  Looks like inheriting avoids duplicating fields, no?
>
> Oops! I did not intend to leave (inherit freedink-engine) in a
> comment. I initially commented it out because freedink does nothing
> with the source anyway, and I wanted to see what would happen if I
> removed the inheritance. I guess I forgot to remove the semicolon and
> other additions.

OK.  If you send an updated patch, I’ll happily apply it, then!

> As noted above, it is easiest to use freedink-dfarc to launch the
> editor, but freedink-dfarc must be told what editor to use, and it is
> easier to identify it if the editor is installed in a profile (or
> included as an input). Also, freedink-engine includes (broken) desktop
> files. Since freedink just installs a wrapper script around the
> engine, and does not include the editor or any desktop files, perhaps
> it would be better to put the wrapper script in freedink-engine (thus
> fixing the desktop file), completely remove the freedink package, and
> rename "freedink-engine" to just "freedink"? But freedink-dfarc would
> still need to be able to launch freedink without pointing to any
> read-only data if a user wants to test the edited freedink data.

Maybe, sounds like a reasonable option.

Thank you,
Ludo’.

[bug#43194] [PATCH] gnu: publicly define freedink-engine and freedink-data

[Ludovic Courtès]

Ping!  :-)

Ludovic Courtès <ludo@gnu.org> skribis:

> Hi,
>
> Jesse Gibbons <jgibbons2357@gmail.com> skribis:
>
>>>> The attached patch publicly defines freedink-engine and
>>>> freedink-data. This resolves many of the issues described in
>>>> #43061. This patch, combined with patch #43193(sent earlier today),
>>>> can close #43061.
>>> Now I’m confused: how does it help to make freedink-{engine,data}
>>> public?
>> Other than making guix more consistent in publicly defining game data
>> packages (0ad-data and megaglest-data are public, and I like that -- I
>> could write a good article about why, which I think would be a worthy
>> entry in the guix blog, especially after #43193 is applied), there are
>> 4 reasons for this change:
>>
>> -> freedink-dfarc has problems locating the editor, installed in
>> freedink-engine. I guess we could also fix this by making
>> freedink-engine an input to freedink-dfarc and splicing a reference to
>> it into the default configuration?
>>
>> -> Unless freedink-data is public, `guix build --source freedink-data`
>> fails, and `guix build --sources=all freedink` does not build a source
>> for freedink-data. I think future users who want to alter the freedink
>> data would appreciate the ability to use guix to get the data. Also,
>> it's pointless to use the editor on the installed freedink-data
>> because it's read-only when it's installed.
>>
>> -> Back when I was fixing freedink, I found it difficult to debug
>> without freedink-engine being public, because freedink does nothing
>> with the freedink-engine source.
>>
>> -> Freedink-engine installs desktop files to launch freedink without
>> freedink-dfarc or the console. This is actually a new issue I will
>> address in an updated patch: the desktop files fail because the data
>> location is not hard-coded. I think the freedink desktop file can be
>> patched if freedink-data is an input, but, like I said above, it's
>> pointless to use dinkedit on a read-only directory, so I intend to
>> remove it.
>
> OK, makes sense—thanks for explaining.
>
>>>> >From 583215aced9b557d6f4e54b290e788d33880c03c Mon Sep 17 00:00:00 2001
>>>> From: Jesse Gibbons <jgibbons2357+guix@gmail.com>
>>>> Date: Wed, 26 Aug 2020 21:38:24 -0600
>>>> Subject: [PATCH v1 1/1] gnu: publicly define freedink-engine and freedink-data
>>>>
>>>> * gnu/packages/games.scm: (freedink-engine): make public
>>>> (freedink-data): make public
>>> [...]
>>>
>>>>   (define-public freedink
>>>>     ;; This is a wrapper that tells the engine where to find the data.
>>>> -  (package (inherit freedink-engine)
>>>> +  (package ;(inherit freedink-engine)
>>> Is it intended?  Looks like inheriting avoids duplicating fields, no?
>>
>> Oops! I did not intend to leave (inherit freedink-engine) in a
>> comment. I initially commented it out because freedink does nothing
>> with the source anyway, and I wanted to see what would happen if I
>> removed the inheritance. I guess I forgot to remove the semicolon and
>> other additions.
>
> OK.  If you send an updated patch, I’ll happily apply it, then!
>
>> As noted above, it is easiest to use freedink-dfarc to launch the
>> editor, but freedink-dfarc must be told what editor to use, and it is
>> easier to identify it if the editor is installed in a profile (or
>> included as an input). Also, freedink-engine includes (broken) desktop
>> files. Since freedink just installs a wrapper script around the
>> engine, and does not include the editor or any desktop files, perhaps
>> it would be better to put the wrapper script in freedink-engine (thus
>> fixing the desktop file), completely remove the freedink package, and
>> rename "freedink-engine" to just "freedink"? But freedink-dfarc would
>> still need to be able to launch freedink without pointing to any
>> read-only data if a user wants to test the edited freedink data.
>
> Maybe, sounds like a reasonable option.
>
> Thank you,
> Ludo’.

[bug#43194] [PATCH] gnu: publicly define freedink-engine and freedink-data

[Jesse Gibbons]

[-- Attachment #1: Type: text/plain, Size: 2338 bytes --]

Sorry it took so long. Updated patch is attached.

-Jesse.

On 9/24/20 9:18 AM, Ludovic Courtès wrote:
> Ping!  :-)
>
> Ludovic Courtès <ludo@gnu.org> skribis:
>
>
...
>>> -> Freedink-engine installs desktop files to launch freedink without
>>> freedink-dfarc or the console. This is actually a new issue I will
>>> address in an updated patch: the desktop files fail because the data
>>> location is not hard-coded. I think the freedink desktop file can be
>>> patched if freedink-data is an input, but, like I said above, it's
>>> pointless to use dinkedit on a read-only directory, so I intend to
>>> remove it.
The patch removes both desktop files.
>> OK, makes sense—thanks for explaining.

>>>>>    (define-public freedink
>>>>>      ;; This is a wrapper that tells the engine where to find the data.
>>>>> -  (package (inherit freedink-engine)
>>>>> +  (package ;(inherit freedink-engine)
>>>> Is it intended?  Looks like inheriting avoids duplicating fields, no?
>>> Oops! I did not intend to leave (inherit freedink-engine) in a
>>> comment. I initially commented it out because freedink does nothing
>>> with the source anyway, and I wanted to see what would happen if I
>>> removed the inheritance. I guess I forgot to remove the semicolon and
>>> other additions.
The patch fixes this.

>>> As noted above, it is easiest to use freedink-dfarc to launch the
>>> editor, but freedink-dfarc must be told what editor to use, and it is
>>> easier to identify it if the editor is installed in a profile (or
>>> included as an input). Also, freedink-engine includes (broken) desktop
>>> files. Since freedink just installs a wrapper script around the
>>> engine, and does not include the editor or any desktop files, perhaps
>>> it would be better to put the wrapper script in freedink-engine (thus
>>> fixing the desktop file), completely remove the freedink package, and
>>> rename "freedink-engine" to just "freedink"? But freedink-dfarc would
>>> still need to be able to launch freedink without pointing to any
>>> read-only data if a user wants to test the edited freedink data.
>> Maybe, sounds like a reasonable option.
The patch does not do this. For now, I don't have the time (and probably 
won't have much time until late December), so I'll leave it as a to-do 
item for anyone who wants to accomplish this.

-Jesse


[-- Attachment #2: 0001-gnu-publicly-define-freedink-engine-and-freedink-dat.patch --]
[-- Type: text/x-patch, Size: 2462 bytes --]

From 438c2044f23e36fc1ddc07b388624194caebb077 Mon Sep 17 00:00:00 2001
From: Jesse Gibbons <jgibbons2357+guix@gmail.com>
Date: Wed, 26 Aug 2020 21:38:24 -0600
Subject: [PATCH 1/1] gnu: publicly define freedink-engine and freedink-data

* gnu/packages/games.scm: (freedink-engine): make public
(freedink-data): make public
---
 gnu/packages/games.scm | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

diff --git a/gnu/packages/games.scm b/gnu/packages/games.scm
index 126539825c..8182bbbe6c 100644
--- a/gnu/packages/games.scm
+++ b/gnu/packages/games.scm
@@ -2861,7 +2861,7 @@ interface or via an external visual interface such as GNU XBoard.")
                   (ftp-directory . "/chess")))
     (license license:gpl3+)))
 
-(define freedink-engine
+(define-public freedink-engine
   (package
     (name "freedink-engine")
     (version "109.6")
@@ -2891,7 +2891,16 @@ interface or via an external visual interface such as GNU XBoard.")
 	     (invoke "autoreconf")
 	     ;; Build fails when autom4te.cache exists.
 	     (delete-file-recursively "autom4te.cache")
-             #t)))))
+             #t))
+         (add-after 'install 'delete-freedinkedit-desktop
+           (lambda* (#:key outputs #:allow-other-keys)
+             (let ((out (assoc-ref outputs "out")))
+             ;; freedinkedit does not know where to find freedink data
+             ;; freedink data is read-only, so it cannot be edited anyway.
+             ;; TODO: fix freedink.desktop
+             (delete-file-recursively (string-append
+                            out "/share/applications"))
+             #t))))))
     (native-inputs `(("autoconf" ,autoconf)
                      ("automake" ,automake)
                      ("cxxtest" ,cxxtest)
@@ -2913,7 +2922,7 @@ game data files but it also supports user-produced game mods or \"D-Mods\".
 To that extent, it also includes a front-end for managing all of your D-Mods.")
     (license license:gpl3+)))
 
-(define freedink-data
+(define-public freedink-data
   (package
     (name "freedink-data")
     (version "1.08.20190120")
@@ -2971,7 +2980,6 @@ and its numerous D-Mods.")
     (arguments
      '(#:builder (begin
                    (use-modules (guix build utils))
-
                    (let* ((output     (assoc-ref %outputs "out"))
                           (bin        (string-append output "/bin"))
                           (executable (string-append bin "/freedink")))
-- 
2.28.0

bug#43194: [PATCH] gnu: publicly define freedink-engine and freedink-data

[Ludovic Courtès]

Jesse Gibbons <jgibbons2357@gmail.com> skribis:

> From 438c2044f23e36fc1ddc07b388624194caebb077 Mon Sep 17 00:00:00 2001
> From: Jesse Gibbons <jgibbons2357+guix@gmail.com>
> Date: Wed, 26 Aug 2020 21:38:24 -0600
> Subject: [PATCH 1/1] gnu: publicly define freedink-engine and freedink-data
>
> * gnu/packages/games.scm: (freedink-engine): make public
> (freedink-data): make public

I tweaked the commit log and applied, thanks!

Ludo’.