FS#76417 - [asciidoc] Rename package to asciidoc-py

Attached to Project: Community Packages
Opened by Jouke Witteveen (jouke) - Friday, 04 November 2022, 12:30 GMT
Last edited by Buggy McBugFace (bugbot) - Saturday, 25 November 2023, 20:04 GMT
Task Type Bug Report
Category Packages
Status Closed
Assigned To Caleb Maclennan (alerque)
Levente Polyak (anthraxx)
Architecture All
Severity Low
Priority Normal
Reported Version
Due in Version Undecided
Due Date Undecided
Percent Complete 100%
Votes 0
Private No

Details

Description:

AciiDoc is turning into a markup language specification [1]. That is good news. The Python implementation of the parser/converter is now known as asciidoc-py and the following lines should be changed in the asciidoc PKGBUILD:

pkgname=asciidoc-py
replaces=('asciidoc')
url='https://asciidoc-py.github.io/'

Additionally, the description could use an update, but I don't know of a good replacement. The GitHub blurb says "Legacy python processor for AsciiDoc" but this is selling the project short [2]. More correct would be "Python processor for legacy rendition of AsciiDoc" [3], but the stated goal of the project is to support modern syntax so that could be misleading too. Maybe the following?

pkgdesc='Python processor for the AsciiDoc text document format'

Note that "provides=('asciidoc')" would be incorrect, as AsciiDoc processors are not interchangeable.

[1] https://projects.eclipse.org/projects/asciidoc.asciidoc-lang
[2] https://github.com/asciidoc-py/asciidoc-py/issues/262
[3] https://gitlab.eclipse.org/eclipse-wg/asciidoc-wg/asciidoc.org/-/blob/main/awesome-asciidoc.adoc#user-content-convert
[4] https://github.com/asciidoc-py/asciidoc-py/issues/173
This task depends upon

Closed by  Buggy McBugFace (bugbot)
Saturday, 25 November 2023, 20:04 GMT
Reason for closing:  Moved
Additional comments about closing:  https://gitlab.archlinux.org/archlinux/p ackaging/packages/asciidoc/issues/1
Comment by Levente Polyak (anthraxx) - Friday, 04 November 2022, 12:58 GMT
Looking at the established dist name across distros, this will be an annoying change for users while fragmenting the name across various distros: https://repology.org/project/asciidoc/versions
Comment by Jouke Witteveen (jouke) - Friday, 04 November 2022, 13:35 GMT
Another chance for Arch to lead the pack. Although asciidoc-py is an excellent piece of software, most of the AsciiDoc (the language) activity comes from the _Asciidoctor_ lead developer, Dan Allen. The name AsciiDoc is trademarked nowadays and the trademark is held (if I'm not mistaken) by the AsciiDoc language group as part of the Eclipse foundation. AsciiDoc-py has a right to use the name, but is not the owner of it. In light of these developments, I think a rename of the package will eventually be unavoidable. Besides, replaces= will aid in the transition, right?
Comment by Caleb Maclennan (alerque) - Thursday, 01 December 2022, 09:11 GMT
Is there another package that would now or ever be considered as a de-facto 'asciidoc' package? This rename doesn't seem to be necessary to me either: all pain for very little gain. It's doable, but "the language is trademarked" doesn't seem to override the years of history and naming across distros.

Also if we did rename it, why would we not prefer `python-asciidoc`?
Comment by Jouke Witteveen (jouke) - Thursday, 01 December 2022, 18:14 GMT
> Is there another package that would now or ever be considered as a de-facto 'asciidoc' package

Most AsciiDoc momentum is currently behind asciidoctor, but it is not a drop-in replacement for the current package, so as far as I can tell: no, there is no other asciidoc package.

> Also if we did rename it, why would we not prefer `python-asciidoc`?

Looking at the homepage [1] and GitHub page [2], the package should really be called AsciiDoc.py since that is the name used by the project! As that is a troublesome name in many instances, I think asciidoc-py is a good choice, as it is also the name of the github project.

[1] https://asciidoc-py.github.io/ [Regardless of a rename, we should update the url to this]
[2] https://github.com/asciidoc-py/asciidoc-py/

Loading...