In MAINTAINERS.txt files we have a lot of lines like this:

- Dries Buytaert 'dries' <http://drupal.org/user/1>

The URLs in these lines are not turning into links. They should.

Comments

jhodgdon’s picture

Oh and this should have tests in the api_link_documentation test and the web test.

jhodgdon’s picture

Status: Active » Closed (won't fix)

Well, it turns out that we are using the core function _filter_url() to turn URLs into links, so the issue is there. I think this is a won't fix.

drumm’s picture

Title: <URL> should turn into link » MAINTAINERS.txt should use different punctuation around URLs
Project: API » Drupal core
Version: 6.x-1.x-dev » 8.x-dev
Component: Parser » other
Status: Closed (won't fix) » Active
Issue tags: +Novice

<http://...> looks like HTML to _filter_url(), so it avoids it. We can update MAINTAINERS.txt to use different punctuation, or just remove punctuation.

jhodgdon’s picture

Yeah, true, good idea. I'd be in favor of removing the <> around the URLs. It doesn't add to readability. Good Novice project (oh, drumm already tagged, good). And I think we should also similarly patch D6 and D7.

anavarre’s picture

StatusFileSize
new14.51 KB

D8 MAINTAINERS.txt updated without <> punctuation.

jhodgdon’s picture

Status: Active » Reviewed & tested by the community

The patch looks fine to me. When you upload a patch, you need to set the issue status to "needs review" by the way. :)

anavarre’s picture

Status: Reviewed & tested by the community » Needs review
StatusFileSize
new13.59 KB
new2.17 KB

Backport to D6 and D7. Sorry about the "needs review" status :-)

Status: Needs review » Needs work

The last submitted patch, D7-Punctuation-1448326-7.patch, failed testing.

Tor Arne Thune’s picture

Status: Needs work » Reviewed & tested by the community
jhodgdon’s picture

anavarre: if you upload a patch for a different version, see the help text under the "attachments" field to find out how to name it to avoid the "needs work" problem above.

Anyway, I'd like to leave this for a day or two to see if anyone objects, then commit this.

sun’s picture

Status: Reviewed & tested by the community » Closed (works as designed)

MAINTAINERS.txt is a text file. If your editor is not able to understand <http://example.com> like it should, fix your editor.

jhodgdon’s picture

Status: Closed (works as designed) » Reviewed & tested by the community

It is not "your editor" that is the problem. It is the Drupal 6 URL filter, which is being used to display the URL when the file is displayed on api.drupal.org -- it isn't turning into a link.

Is there really a reason why we shouldn't remove the <> in order to accommodate the limitations of this filter, since at this point there is probably no way it will be improved? Personally, I don't think this punctuation improves the readability of the MAINTAINERS.txt file, and if we need some punctuation, perhaps we can find some alternative punctuation that would keep the readability while still allowing the URL to be displayed as a link on api.drupal.org?

sun’s picture

Status: Reviewed & tested by the community » Needs review

Much better questions are:

1) Why does a text file appear on api.d.o in the first place?

2) Why do we attempt to parse a text file in any way?

3) How were you able to find and access MAINTAINERS.txt on api.d.o at all? (it shouldn't be linked anywhere)

jhodgdon’s picture

1) We have had .txt files on api.drupal.org for quite a while. Some, such as robots.txt and INSTALL.txt, are arguably part of the Drupal code/documentation base. If MAINTAINERS.txt is not, then why would we include it in the Drupal distribution? We could just maintain it as a page on drupal.org in that case.

2) Not sure historically why are are parsing text files. I've committed a patch to the API module recently that reduces the "parsing" to just turning things into links (e.g., names of files/functions in the Drupal code base, and full URLs).

3) You can find it by typing it into a search.

star-szr’s picture

StatusFileSize
new14.85 KB

Reroll/new version of #5 that applies cleanly to D8 HEAD.

devin carlson’s picture

Status: Needs review » Reviewed & tested by the community

The patch in #15 applied cleanly and removed every occurrence of <> around the URLs (verified manually and by performing a search for both characters against the text in maintainers.txt).

Reviewing the patch, I also didn't find any mistakes which might have modified a maintainers name or d.o profile URL.

webchick’s picture

Category: feature » bug
Status: Reviewed & tested by the community » Fixed

Seems like this is fixing a legitimate bug for API module, so re-classifying.

Committed and pushed to 8.x. Thanks!

webchick’s picture

Version: 8.x-dev » 7.x-dev
Status: Fixed » Patch (to be ported)

Sorry! This was meant to be backported.

jibran’s picture

Status: Patch (to be ported) » Needs review
StatusFileSize
new2.17 KB
new14.34 KB

patches for d7 and d6

Status: Needs review » Needs work

The last submitted patch, d6-1448326-19.patch, failed testing.

star-szr’s picture

Status: Needs work » Reviewed & tested by the community

Thanks @jibran! D7 patch looks good.

Since this issue is now against 7.x, to have the D6 patch skip testing (and avoid testbot setting this issue to needs work), end the patch filename with -do-not-test.patch. See https://drupal.org/node/1092232.

webchick’s picture

Version: 7.x-dev » 6.x-dev
Status: Reviewed & tested by the community » Patch (to be ported)

Committed and pushed to 7.x. One more time... :)

jibran’s picture

Status: Patch (to be ported) » Needs review
StatusFileSize
new2.17 KB

d6 patch

jhodgdon’s picture

Status: Needs review » Reviewed & tested by the community

Thanks! This patch appears to be complete and correct.

jhodgdon’s picture

Status: Reviewed & tested by the community » Needs work
Issue tags: +Needs reroll

I just noticed this very old issue. The patch does not apply now and needs a reroll. Sorry for not getting it committed earlier!

jibran’s picture

Status: Needs work » Needs review
Issue tags: -Needs reroll
StatusFileSize
new2.19 KB

PFA

parthipanramesh’s picture

Issue summary: View changes
Status: Needs review » Reviewed & tested by the community

The latest patch (d6-1448326-26.patch) is working fine!

jhodgdon’s picture

Version: 6.x-dev » 7.x-dev
Status: Reviewed & tested by the community » Fixed
Issue tags: -Needs backport to D6

I am not convinced that we really need those email addresses to turn into links in the D6 maintainers file. We should not really have email addresses in there at all... Actually... maybe we should not bother to fix this for Drupal 6 at this point? I'm just going to set this back to 7.x/fixed.

star-szr’s picture

Agreed.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.