Rename ghc-pandoc to pandoc

  • Done
  • quality assurance status badge
Details
7 participants
  • Efraim Flashner
  • Pierre Neidhardt
  • Tobias Geerinckx-Rice
  • Mike Gerwitz
  • Ricardo Wurmus
  • swedebugia
  • zimoun
Owner
unassigned
Submitted by
swedebugia
Severity
normal
S
S
swedebugia wrote on 23 Dec 2018 09:46
(address . bug-guix@gnu.org)
9251b0f558ee90be48420e76d7c4d326@riseup.net
Reason: it is used standalone to convert between formats.

--
Cheers
Swedebugia
P
P
Pierre Neidhardt wrote on 26 Feb 2020 11:06
(address . swedebugia@riseup.net)
878skpacih.fsf@ambrevar.xyz
swedebugia@riseup.net writes:

Toggle quote (2 lines)
> Reason: it is used standalone to convert between formats.

I agree. What do other people think?

--
Pierre Neidhardt
-----BEGIN PGP SIGNATURE-----

iQEzBAEBCAAdFiEEUPM+LlsMPZAEJKvom9z0l6S7zH8FAl5WQyYACgkQm9z0l6S7
zH/jtgf+JprorQh9b1COXDW+J5TvgauJXv6tZULqxL/tqBxNs3nt9zLVUZEtTrXv
PslBKNQ6b6/9MjXs2raGVaNAQOD12mDYX+GBFDYQYBaCIkbGo+7rDir2QZAf4tWT
VEdi+N6mQWhUlu1VWzdjHfgZqHZCU3VVpb3rz3VTL8TRT7lPdaqiw5nERLBJBvyi
MMG1H1B9gkJMr+sOKffK+C2sjUEZRLpCeKxT+VHvgJQ8bNAyHIHDl15YxeEr4Mla
2kzWBnoDUzxLnE51lyqcULspIId9kEalPm3eVY3E7cXS0MuSSRci8u5Nep+mg632
M0DtB3OkFK+9AnEOhCoDcJcGcSR5Uw==
=Qh/9
-----END PGP SIGNATURE-----

T
T
Tobias Geerinckx-Rice wrote on 26 Feb 2020 11:23
875zftk5q2.fsf@nckx
Pierre Neidhardt ???
Toggle quote (4 lines)
>> Reason: it is used standalone to convert between formats.
>
> I agree. What do other people think?

[Thumbs-up emoji]

Kind regards,

T G-R
-----BEGIN PGP SIGNATURE-----

iQIzBAEBCgAdFiEEfo+u0AlEeO9y5k0W2Imw8BjFSTwFAl5WRxcACgkQ2Imw8BjF
STyl0BAAkvUyfxV22onlouSKZuA3KAuBVZMuHNuPLMQIP+gU6AhkJTTTgJzqFLV3
ykb40K0hpT/U1nEt15p6XoWlJxuP9Sw2oVH+12Sfz0SjZ7HyqtYlR4t4QId38HkG
mjZcKyb3eD/STu5iDu0V8s3MbCERJ5mN6H+F8wcq5BiYYFK+hOh91ZJgb0JqVSwj
GX3WsdPlbbkgWVtLD1wzmCWEKUiHekUljJgTNzKnAZRxXi9DJq28tV6omHevWPUF
x37YQXa3nX37d0Ffdx403c4oh4erYpWXF09X1tjDO9y18nqFZNLWEyGXJBkZSqiZ
SeXaaH5n/9WXlmY5gRKAszt/ZiRcLcBMHojjpSTPFWjlTUnNjk+ss2UmL0H7UMGF
zpkEIW9QjYiHH4RpVtzVb4MtJqxxwkLC/U+xJucZq30mS82rsnbGUg0hVInOBsDg
G4j2FSXQWhCHscrvkyBgLFQQQp3wm2LgsAcBW0kmvmpA//qcVT6oXsomnJl/mFm9
Wt5EXz75sPcLvIKVdR07h03uNhbmGSa9QsfZWAzUCQ4qEMJaIbi8FuhLVhCHlBuq
0tDOHU+HzM3pGue7gEmY2XYvDkMeEpNKWRwC7VA0SBn+s+QFeZ672JZQOMH+nxGF
amVI424wPhiap2LDKYw2XzL5XlW0ZqbsmluM3DPsizuSN35fUME=
=SKBq
-----END PGP SIGNATURE-----

E
E
Efraim Flashner wrote on 26 Feb 2020 11:23
(name . Pierre Neidhardt)(address . mail@ambrevar.xyz)
20200226102314.GE12956@E5400
On Wed, Feb 26, 2020 at 11:06:30AM +0100, Pierre Neidhardt wrote:
Toggle quote (6 lines)
> swedebugia@riseup.net writes:
>
> > Reason: it is used standalone to convert between formats.
>
> I agree. What do other people think?

This is language specific, but like other language-specific packages
this is a package people would specifically search for as 'pandoc' and I
agree, it should be renamed.


--
Efraim Flashner <efraim@flashner.co.il> ????? ?????
GPG key = A28B F40C 3E55 1372 662D 14F7 41AA E7DC CA3D 8351
Confidentiality cannot be guaranteed on emails sent or received unencrypted
-----BEGIN PGP SIGNATURE-----

iQIzBAABCgAdFiEEoov0DD5VE3JmLRT3Qarn3Mo9g1EFAl5WRw8ACgkQQarn3Mo9
g1HXTBAAqwMY8iVqOBut84i3co6oZJIDBxhpmf5LaF74igqNEhyPXezi/S8sL0EJ
4ZLELIqgcUYqS9nIN9c46kuXtXZFZgYUrQj9pxJdVALWJtJKrJuLRbwj4ZXpgFQJ
8fjx+x58vbUAgAxB3mbK1FIuVcvuosAFOcLMnYMWUlS02NHPKwnrrke0VbiaMG3a
AYQ3zNkZiuVIYrdxyNJNHA8r27lN/yMvypQjGrOdboi0Qg8OS6Myb1p6rWUTHe0W
vHibaXgmlCOW72YqSHx+Ygst3MMxWI7qbHIdsJ9y6M18V9T/Aq11n/pFyNfBgwSl
nSNBQ/a9kOHKHfoJJa1w4obDLTMtRW5sVI3GcAcJlf3/idTfxhhETNnwLwvI1fB9
i9GegMylTwVpx6JUQWNViyRJ0sUNKVYC/V4NvxO4SHcYJhWlxzAdt3YdnJOT8p9F
a/yzGW37uzWU+TTzVr9wNw0UA9DLJofvcVVwe/qjKr2CRtQngjBkOd7C/slaHuTw
edWDyxdrq74oFjV7RJOHiRNEcHI/WEMvElM1Z3aPcw+ddU8RF3rTVnyiJGJw7A0S
jCBNtAzs1bIBH3H7rXmu25BMON2pzBNdHMRAqyKeXmRF4DkvoWk3v8V/OXxzIrTW
WxpI3UsqE5f6iMuXY+5bLSv4X19NucyIZpT3qDIwVkBY/zmme0E=
=1G+t
-----END PGP SIGNATURE-----


R
R
Ricardo Wurmus wrote on 26 Feb 2020 12:57
(name . Pierre Neidhardt)(address . mail@ambrevar.xyz)
87wo89imsx.fsf@elephly.net
Pierre Neidhardt <mail@ambrevar.xyz> writes:

Toggle quote (6 lines)
> swedebugia@riseup.net writes:
>
>> Reason: it is used standalone to convert between formats.
>
> I agree. What do other people think?

I agree.

We should also rename all uses of ghc-pandoc in the same patch.

--
Ricardo
P
P
Pierre Neidhardt wrote on 26 Feb 2020 13:17
(name . Ricardo Wurmus)(address . rekado@elephly.net)
87wo898rv3.fsf@ambrevar.xyz
Ricardo Wurmus <rekado@elephly.net> writes:

Toggle quote (2 lines)
> We should also rename all uses of ghc-pandoc in the same patch.

Oops! I'll resend patch 39798.

--
Pierre Neidhardt
-----BEGIN PGP SIGNATURE-----

iQEzBAEBCAAdFiEEUPM+LlsMPZAEJKvom9z0l6S7zH8FAl5WYfAACgkQm9z0l6S7
zH8CcQf/f8ufge0/kPXlhJSuGJi2EKkTRsxlevBsUjFeXzj7ejTngk7VPTkjxB/s
HB6qrF16ufNOk0M3hGrbwwI6JU5U9tVbKXPOC0nPGQdYrLFiso7mGd5VfWRa98Te
FZL/bjG6c74wEKjAnTBv0kNyzEz1VkL/UPfkvASv0FnsTrG3j6ytidjG9CcKmFt3
yY9twLDzXNKQItZpA3z4GJ4LK6ZOYW29cVRSJdxW7XHV9Uaz6tgb2xdNjmR/9yTa
pppzmIm0qs5I9DrMGbuWb8HwDjpAr2cAvIlLh51Drv7C2TKqvdOALYYkEvL1eam2
TEITje4Iw884byNp70P+LsSIdBGBhg==
=bOPh
-----END PGP SIGNATURE-----

P
P
Pierre Neidhardt wrote on 26 Feb 2020 13:52
(name . Ricardo Wurmus)(address . rekado@elephly.net)
87tv3d8q9m.fsf@ambrevar.xyz
Done.
See patch patch 39798.

--
Pierre Neidhardt
-----BEGIN PGP SIGNATURE-----

iQEzBAEBCAAdFiEEUPM+LlsMPZAEJKvom9z0l6S7zH8FAl5WagUACgkQm9z0l6S7
zH/xdggAnUPuLLMeHS+7YbRskMNusWIn714FB90jicp6bBMjddpbMKnx6wynhfQt
kPIt3oDgsRfIfcOWv2CwEVAyE7DUvqVcN5U1OxcTfyjofVGDnrOHFPAOtUteBVA2
yQJ5Ei2HLC03PIwjerZcdHIo/eP9QCpbQn3b1v8Ue8ZUsJRE8etkKEEmezV1baeX
T4JpDnDZfEv2DT5L4dgDkecQ0OHQPxEQ3U8LMQdP5v9TUikAiaPWNGulY3Rqpp96
j5bxexPoVdPZvsmx5cwtPv6uLT4pdE0vqgBM9oQnGMUjY6io82tKElBdTH1FtElH
Pe3cmSFPiMtHxuKJoMYB/syki+UENw==
=b4Xu
-----END PGP SIGNATURE-----

M
M
Mike Gerwitz wrote on 27 Feb 2020 02:23
(name . Efraim Flashner)(address . efraim@flashner.co.il)
87pne0q0wb.fsf@gnu.org
On Wed, Feb 26, 2020 at 12:23:14 +0200, Efraim Flashner wrote:
Toggle quote (11 lines)
> On Wed, Feb 26, 2020 at 11:06:30AM +0100, Pierre Neidhardt wrote:
>> swedebugia@riseup.net writes:
>>
>> > Reason: it is used standalone to convert between formats.
>>
>> I agree. What do other people think?
>
> This is language specific, but like other language-specific packages
> this is a package people would specifically search for as 'pandoc' and I
> agree, it should be renamed.

Ah, for the record, I had searched for pandoc using `guix package -s
pandoc` in the past and didn't find what I was looking for, and so fell
back to a Debian system. It turns out what I wanted was ghc-pandoc
after all.

But if I would have put a little bit more effort into looking, perhaps I
would have figured that out; I was in a hurry.

Thanks for making this change!

--
Mike Gerwitz
Free Software Hacker+Activist | GNU Maintainer & Volunteer
GPG: D6E9 B930 028A 6C38 F43B 2388 FEF6 3574 5E6F 6D05
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2

iQIcBAEBCgAGBQJeVxoIAAoJEIyRe39dxRuid10QAIE0j4vhLt7B1/mKgfvJj4OI
/5eOFAeEdX2uFW1excxQczOa7H5cKmimH/Xb9+i3b/v2pnlNpk83tHDd0zvzOzii
bPWm3M9rvjxJCxBS0qxU26gQjszWnxFgRhpCjc76yT+KnkNGD60s4h/VK8UVZsCW
kaUurQkRxdX5UrqH0YDxfv9kAUsYrqdnrayaB3PQcnmSbzVpP/+3OxN6WCRlCKYu
f/OYtFz9t1366joOnIoViRsAb+7vD2UlTWUkwlyznrqHw400D2sWL9J9Mc9pBduJ
zUs2DZe/7/46dIIcMsj/vzJOcHZRFbE3uwDB4sVZayWbqegwAndUkivzVdRRBNOV
+MGRrnog/1BpGfEev9jDKaEE9SEvMHFrrMXf8SfZkHwbtaalmEVSdwTE+un2IF5h
xTWEvUiPKS9URT3GBa4NBd4YU3VzkMBlUkcnTx0w9Ed5oky8H/z6wraTwNSKyjlF
hpVXqSdgAbyVn3ECpScxifux9uac+u0ZJr0bdJrRaxzhzCEj7mGD3HYJArPdhCkW
kCgDFYpUMRM/Q0PoX1RGh1H0ItCpoQAIm0TxehSwSU2v8UXiVUCQ19P57phSWhVb
WCuM05oohDyujBMbLn1YYi5n9UXmAvD4+4sKP+w0k7Aduc+FBSAxBc5fVptyXeaI
3SyMZr02xKkBTrINOF3p
=LBpP
-----END PGP SIGNATURE-----

Z
Z
zimoun wrote on 27 Feb 2020 14:10
(name . Mike Gerwitz)(address . mtg@gnu.org)
CAJ3okZ2-Mz=Bh6dbg7BEcH54Vc0RMRDfCOkqTJzP=cW4S2wAJg@mail.gmail.com
Hi Mike,

On Thu, 27 Feb 2020 at 02:23, Mike Gerwitz <mtg@gnu.org> wrote:

Toggle quote (5 lines)
> Ah, for the record, I had searched for pandoc using `guix package -s
> pandoc` in the past and didn't find what I was looking for, and so fell
> back to a Debian system. It turns out what I wanted was ghc-pandoc
> after all.

Thank you for pointing the issue.

My remark is *not* about the rename which seems fine. For the very
same reason than the "git-annex" software is named 'git-annex' and not
'ghc-git-annex'.


Well, your comment is pointing: a) that the description is badly
written and b) the 'relevance' score is too rough.

The command "guix search pandoc" returns as the highest ranked
package: ghc-pandoc-citeproc with the relevance score of 17. The
package of interest 'ghc-pandoc' appears at the 6th position with a
relevance score of 8. (And after emacs-pandoc-mode, ghc-pandoc-types,
emacs-ox-pandoc and python-pandocfilters; well less relevant packages,
IMO.)
Why? Because the number of occurrences of the term 'pandoc' in
synopsis+description+name.
ghc-pandoc-citeproc: 1+5+1
ghc-pandoc: 0+2+1

To be precise, the score uses weights and so it reads:

ghc-pandoc-citeproc: 3*1 + 2*5 + 4*1 = 17
ghc-pandoc: 3*0 + 2*2 + 4*1 = 8

And the rename bumps the score because there is an additional weight
(5) for exact match (which normally happens only for the 'name'
field).

ghc-pandoc-citeproc: 3*1 + 2*5 + 4*1 = 17
pandoc: 3*0 + 2*2 + 4*1*5 = 24

It apparently fixes the issue and now the package named 'pandoc' will
show up first. But it is an artefact because it is easy* to find other
weights that invalidate this expected ranking; and the current weights
are a working rule of thumbs but not deeply thought, AFAIK.


*For example instead of 5, let choose 2, then the score becomes:
3*0+2*2+4*1*2=12 which is less than 17. Well, not so easy because 2 is
the same as 'description' and it seems less natural; i.e., it appears
more natural to have a high weight for an exact match. But the point
is: it is possible to find another working rule of thumb which will
not return the expected result for all the packages.


The real problem is not the non-obvious name (ghc-pandoc instead of
simply pandoc) but it is: a) some descriptions are badly written and
b) the 'relevance' scoring function is not enough "smart" to detect
them.



All the best,
simon
M
M
Mike Gerwitz wrote on 28 Feb 2020 06:03
(name . zimoun)(address . zimon.toutoune@gmail.com)
87wo87e22d.fsf@gnu.org
On Thu, Feb 27, 2020 at 14:10:15 +0100, zimoun wrote:
Toggle quote (3 lines)
> Well, your comment is pointing: a) that the description is badly
> written and b) the 'relevance' score is too rough.

[...]

Toggle quote (5 lines)
> The real problem is not the non-obvious name (ghc-pandoc instead of
> simply pandoc) but it is: a) some descriptions are badly written and
> b) the 'relevance' scoring function is not enough "smart" to detect
> them.

Thank you for taking the time to explain this.

--
Mike Gerwitz
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2

iQIcBAEBCgAGBQJeWJ8KAAoJEIyRe39dxRuilUYP/02KD5oQ7q5/fdh2cffwIPzU
wBxvrHvF8Jc3Z0oRhlD+E4rKtzicTjxU3Uc6dG3v+TFH4GMu9+gXhXj5Qtyhkdcf
4oDZBoQYAnZ/9rQkJg5NvHDLa8meaSOTYo2UQ+EtKheBXLumNFOI2NgQOlsPPqdq
DxUegeW89qjBw6Q39l1/cCeOemIyHFmr0YjBf046SmBbYeYwYqmeaidpBGtkyHJ7
AsXZBggZghbn7KCB8jEWVp4V9Xy2la3zMNNI/3cgTal492NqPDQI9v706lGoeoFR
kSPvMoD0JijDZ1N2sl0VenOZnaJPyCh0NsP3nXx5j/oY2De653bmdvATp6oXK2w5
U//Q/EgrKJaOgc5kc2KYCsjlM1CGrZRajo7sEFoW4zcMFZbRZ34NV0nNqWOqEtWN
GNLIjljMehWmsZnlBJqAsAjMz1CIENkv7o0zF4a8RuA4t0lvGqvEpnohHIgNq6gB
HpvBcZX8oVqjmCBK4URFXsUwf2tJlPoop5u7PIlnqoAg6CUQ3CcRoVSV2+/fvxlf
u9ZEhdwa3xXi2METFlSxNKWwij6WWljCDhup1bpofleN/8B0ZkncWEIJX2ogj6WG
ctWx+k9EdgmAgnos+gci7upH4nGLoQrpXMtbZuRWv6l6bl64damYKaT1kcNeYxVa
HEf1Z4fx79RL6E0UrRyq
=AcLV
-----END PGP SIGNATURE-----

Z
Z
zimoun wrote on 9 Sep 2020 18:08
(name . Ricardo Wurmus)(address . rekado@elephly.net)
871rjbue4k.fsf@gmail.com
Hi,

On Wed, 26 Feb 2020 at 12:57, Ricardo Wurmus <rekado@elephly.net> wrote:

Toggle quote (2 lines)
> We should also rename all uses of ghc-pandoc in the same patch.

Commit d4e4a3824d380e576b56a74aa714db205fcc59a4 adds pandoc.

The packages:

- ruby-pandoc-ruby
- rapicorn
- ganeti
- manuskript
- emacs-org-web-tools
- emacs-ox-pandoc

do not use pandoc instead of ghc-pandoc; I do not know if it matters or
if they need to also switch. More all Haskell packages in
haskell-xyz.scm.


Since ghc-pandoc is still here and even pandoc inherits from it, I
propose to close.

All the best,
simon
R
R
Ricardo Wurmus wrote on 9 Sep 2020 18:11
(name . zimoun)(address . zimon.toutoune@gmail.com)
87y2lj53r9.fsf@elephly.net
zimoun <zimon.toutoune@gmail.com> writes:

Toggle quote (21 lines)
> Hi,
>
> On Wed, 26 Feb 2020 at 12:57, Ricardo Wurmus <rekado@elephly.net> wrote:
>
>> We should also rename all uses of ghc-pandoc in the same patch.
>
> Commit d4e4a3824d380e576b56a74aa714db205fcc59a4 adds pandoc.
>
> The packages:
>
> - ruby-pandoc-ruby
> - rapicorn
> - ganeti
> - manuskript
> - emacs-org-web-tools
> - emacs-ox-pandoc
>
> do not use pandoc instead of ghc-pandoc; I do not know if it matters or
> if they need to also switch. More all Haskell packages in
> haskell-xyz.scm.

If these packages only use the “pandoc” executable they should use the
“pandoc” package instead of “ghc-pandoc”. “ghc-pandoc” is only meant
for Haskell packages that use Pandoc as a library. This is a much rarer
case, so we can assume that most packages should use “pandoc” instead of
“ghc-pandoc”.

--
Ricardo
Z
Z
zimoun wrote on 7 Oct 2020 17:27
(name . Ricardo Wurmus)(address . rekado@elephly.net)
87o8le83a3.fsf@gmail.com
Dear,

On Wed, 09 Sep 2020 at 18:11, Ricardo Wurmus <rekado@elephly.net> wrote:
Toggle quote (4 lines)
> zimoun <zimon.toutoune@gmail.com> writes:

>>> We should also rename all uses of ghc-pandoc in the same patch.

The packages: …

Toggle quote (7 lines)
>> - rapicorn
>> - ganeti
>> - manuskript
>> - emacs-org-web-tools
>> - emacs-ox-pandoc
>> - ruby-pandoc-ruby

… now uses ’pandoc’ instead of ’ghc-pandoc’, see:

c22c6de453 gnu: rapicorn: Use pandoc instead of ghc-pandoc.
885332832c gnu: ganeti: Use pandoc instead of ghc-pandoc.
5dc5a3116b gnu: manuskript: Use pandoc instead of ghc-pandoc.
991c61678b gnu: emacs-org-web-tools: Use pandoc instead of ghc-pandoc.
d37279ee1e gnu: emacs-ox-pandoc: Use pandoc instead of ghc-pandoc.
8cc8e584ab gnu: ruby-pandoc-ruby: Use pandoc instead of ghc-pandoc.


Toggle quote (6 lines)
> If these packages only use the “pandoc” executable they should use the
> “pandoc” package instead of “ghc-pandoc”. “ghc-pandoc” is only meant
> for Haskell packages that use Pandoc as a library. This is a much rarer
> case, so we can assume that most packages should use “pandoc” instead of
> “ghc-pandoc”.

The only non-Haskell package remaining is ’gnu/packages/mail.scm
(muchsync)’. Once this package is done (see #43848 [1]), we should be
able to close this bug, I guess.



All the best,
simon
Z
Z
zimoun wrote on 19 Dec 2020 01:03
(name . Ricardo Wurmus)(address . rekado@elephly.net)
86sg82slup.fsf@gmail.com
On Wed, 07 Oct 2020 at 17:27, zimoun <zimon.toutoune@gmail.com> wrote:
Toggle quote (36 lines)
> Dear,
>
> On Wed, 09 Sep 2020 at 18:11, Ricardo Wurmus <rekado@elephly.net> wrote:
>> zimoun <zimon.toutoune@gmail.com> writes:
>
>>>> We should also rename all uses of ghc-pandoc in the same patch.
>
> The packages: …
>
>>> - rapicorn
>>> - ganeti
>>> - manuskript
>>> - emacs-org-web-tools
>>> - emacs-ox-pandoc
>>> - ruby-pandoc-ruby
>
> … now uses ’pandoc’ instead of ’ghc-pandoc’, see:
>
> c22c6de453 gnu: rapicorn: Use pandoc instead of ghc-pandoc.
> 885332832c gnu: ganeti: Use pandoc instead of ghc-pandoc.
> 5dc5a3116b gnu: manuskript: Use pandoc instead of ghc-pandoc.
> 991c61678b gnu: emacs-org-web-tools: Use pandoc instead of ghc-pandoc.
> d37279ee1e gnu: emacs-ox-pandoc: Use pandoc instead of ghc-pandoc.
> 8cc8e584ab gnu: ruby-pandoc-ruby: Use pandoc instead of ghc-pandoc.
>
>
>> If these packages only use the “pandoc” executable they should use the
>> “pandoc” package instead of “ghc-pandoc”. “ghc-pandoc” is only meant
>> for Haskell packages that use Pandoc as a library. This is a much rarer
>> case, so we can assume that most packages should use “pandoc” instead of
>> “ghc-pandoc”.
>
> The only non-Haskell package remaining is ’gnu/packages/mail.scm
> (muchsync)’. Once this package is done (see #43848 [1]), we should be
> able to close this bug, I guess.


Closing.

Thanks,
simon
Closed
?