Bug 274848 - textproc/py-CommonMark: rename bin/cmark to bin/cmark-py for conflict avoidance
Summary: textproc/py-CommonMark: rename bin/cmark to bin/cmark-py for conflict avoidance
Status: Closed FIXED
Alias: None
Product: Ports & Packages
Classification: Unclassified
Component: Individual Port(s) (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Romain Tartière
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2023-11-01 11:18 UTC by John Hein
Modified: 2024-10-01 23:18 UTC (History)
1 user (show)

See Also:
bugzilla: maintainer-feedback? (romain)


Attachments
[patch] bin/cmark -> bin/cmark-py (1.12 KB, patch)
2023-11-01 11:24 UTC, John Hein
jcfyecrayz: maintainer-approval? (romain)
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description John Hein 2023-11-01 11:18:55 UTC
Nothing in the ports tree that I found depend on bin/cmark from textproc/py-CommonMark.

To avoid conflicts with textproc/cmark (and allow removal of secondary conflict marking like 'DOCS_CONFLICTS_BUILD=cmark' in devel/llvm*), renaming bin/cmark in textproc/py-CommonMark to bin/cmark-py seems like a reasonable option.

There is a (slight?) POLA concern that existing downstream users will be affected by this change.  Adjusting to the change by looking for cmark-py does not seem particularly onerous.  Encouraging the upstream project to do so is perhaps even better.  I will pursue that as well.

On github, commonmark/cmark (for textproc/cmark) and readthedocs/commonmark.py (for textproc/py-CommonMark) both started in 2014 with commonmark/cmark barely "winning" by a month or so. There's no clear "prior art" winner based on that distinction.  But I suspect most py-CommonMark users use it as a python module rather than the command line tool.  In the ports tree py-recommonmark uses py-CommonMark and certainly uses it purely as a python module rather than invoking bin/cmark.
Comment 1 John Hein 2023-11-01 11:24:09 UTC
Created attachment 246048 [details]
[patch] bin/cmark -> bin/cmark-py

Rename bin/cmark to bin/cmark-py.

This can be followed up with removal of CONFLICT markers in textproc/cmark and devel/llvm*.
Comment 2 Romain Tartière freebsd_committer freebsd_triage 2023-11-08 21:00:25 UTC
> I suspect most py-CommonMark users use it as a python module rather than the command line tool

Same


All this look reasonable!
Comment 3 commit-hook freebsd_committer freebsd_triage 2023-11-11 01:56:18 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/ports/commit/?id=2c93a03bbcd528fcdce6e06ef7f2b71017e07050

commit 2c93a03bbcd528fcdce6e06ef7f2b71017e07050
Author:     Romain Tartière <romain@FreeBSD.org>
AuthorDate: 2023-11-11 01:42:15 +0000
Commit:     Romain Tartière <romain@FreeBSD.org>
CommitDate: 2023-11-11 01:54:11 +0000

    textproc/py-CommonMark: Allow installation with textproc/cmark

    Both ports install bin/cmark.  Users of textproc/py-CommonMark are
    supposely more interested in the python module rather than the command
    line tool: nothing in the ports tree seems to use bin/cmark from this
    port.

    Rename the command to cmark-py to fix conflict

    PR:             274848
    Reported by:    jcfyecrayz@liamekaens.com

 textproc/cmark/Makefile                           |  2 --
 textproc/py-CommonMark/Makefile                   |  3 +--
 textproc/py-CommonMark/files/patch-setup.py (new) | 11 +++++++++++
 3 files changed, 12 insertions(+), 4 deletions(-)
Comment 4 commit-hook freebsd_committer freebsd_triage 2024-10-01 23:18:00 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/ports/commit/?id=78c7700b5c2bd7501137472e754fb640b486ee1a

commit 78c7700b5c2bd7501137472e754fb640b486ee1a
Author:     Brooks Davis <brooks@FreeBSD.org>
AuthorDate: 2024-10-01 23:11:09 +0000
Commit:     Brooks Davis <brooks@FreeBSD.org>
CommitDate: 2024-10-01 23:16:46 +0000

    devel/llvm19: 19.1.1 release

    Remove obsolete build conflict with cmark.

    PR:             239636, 274848

 devel/llvm19/Makefile | 3 +--
 devel/llvm19/distinfo | 6 +++---
 2 files changed, 4 insertions(+), 5 deletions(-)
Comment 5 commit-hook freebsd_committer freebsd_triage 2024-10-01 23:18:01 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/ports/commit/?id=7cea690fddbd4f6bb3ad3360e625754bde7ac4e6

commit 7cea690fddbd4f6bb3ad3360e625754bde7ac4e6
Author:     Brooks Davis <brooks@FreeBSD.org>
AuthorDate: 2024-10-01 23:15:29 +0000
Commit:     Brooks Davis <brooks@FreeBSD.org>
CommitDate: 2024-10-01 23:16:46 +0000

    devel.llvm[12345678]: remove cmark conflict [NFC]

    The build conflict with cmark is no longer needed.

    PR:             239636, 274848

 devel/llvm11/Makefile | 1 -
 devel/llvm12/Makefile | 1 -
 devel/llvm13/Makefile | 1 -
 devel/llvm14/Makefile | 1 -
 devel/llvm15/Makefile | 1 -
 devel/llvm16/Makefile | 1 -
 devel/llvm17/Makefile | 1 -
 devel/llvm18/Makefile | 1 -
 8 files changed, 8 deletions(-)