Closed (fixed)
Project:
Drupal core
Version:
7.x-dev
Component:
other
Priority:
Normal
Category:
Bug report
Assigned:
Unassigned
Issue tags:
Reporter:
Created:
21 Feb 2012 at 16:27 UTC
Updated:
6 Dec 2013 at 17:30 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #1
jhodgdonOh and this should have tests in the api_link_documentation test and the web test.
Comment #2
jhodgdonWell, 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.
Comment #3
drumm<http://...>looks like HTML to _filter_url(), so it avoids it. We can update MAINTAINERS.txt to use different punctuation, or just remove punctuation.Comment #4
jhodgdonYeah, 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.
Comment #5
anavarreD8 MAINTAINERS.txt updated without <> punctuation.
Comment #6
jhodgdonThe patch looks fine to me. When you upload a patch, you need to set the issue status to "needs review" by the way. :)
Comment #7
anavarreBackport to D6 and D7. Sorry about the "needs review" status :-)
Comment #9
Tor Arne Thune commentedComment #10
jhodgdonanavarre: 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.
Comment #11
sunMAINTAINERS.txt is a text file. If your editor is not able to understand
<http://example.com>like it should, fix your editor.Comment #12
jhodgdonIt 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?
Comment #13
sunMuch 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)
Comment #14
jhodgdon1) 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.
Comment #15
star-szrReroll/new version of #5 that applies cleanly to D8 HEAD.
Comment #16
devin carlson commentedThe 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.
Comment #17
webchickSeems like this is fixing a legitimate bug for API module, so re-classifying.
Committed and pushed to 8.x. Thanks!
Comment #18
webchickSorry! This was meant to be backported.
Comment #19
jibranpatches for d7 and d6
Comment #21
star-szrThanks @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.
Comment #22
webchickCommitted and pushed to 7.x. One more time... :)
Comment #23
jibrand6 patch
Comment #24
jhodgdonThanks! This patch appears to be complete and correct.
Comment #25
jhodgdonI just noticed this very old issue. The patch does not apply now and needs a reroll. Sorry for not getting it committed earlier!
Comment #26
jibranPFA
Comment #27
parthipanramesh commentedThe latest patch (d6-1448326-26.patch) is working fine!
Comment #28
jhodgdonI 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.
Comment #29
star-szrAgreed.