This is an archive of the discontinued LLVM Phabricator instance.

Update Bug report URL to Github Issues
ClosedPublic

Authored by ChuanqiXu on Dec 28 2021, 7:04 PM.

Details

Summary

I found that although we moved to Github Issues. The bug report message refers to Bugzilla still. This patch tries to update these URLs. I left FIXME for places where I am not sure how to do wording.

Diff Detail

Event Timeline

ChuanqiXu created this revision.Dec 28 2021, 7:04 PM
Herald added a reviewer: MaskRay. · View Herald Transcript
Herald added a project: Restricted Project. · View Herald Transcript
Herald added a reviewer: Restricted Project. · View Herald Transcript
ChuanqiXu requested review of this revision.Dec 28 2021, 7:04 PM
Herald added projects: Restricted Project, Restricted Project, Restricted Project, Restricted Project, Restricted Project. · View Herald TranscriptDec 28 2021, 7:04 PM
Herald added a reviewer: Restricted Project. · View Herald Transcript
MaskRay added inline comments.Dec 28 2021, 9:56 PM
llvm/docs/DeveloperPolicy.rst
64

You can drop this and let others fix this paragraph.

asl requested changes to this revision.Dec 28 2021, 11:09 PM
asl added a subscriber: tstellar.

Thanks for doing this! I added few notes on the way.

clang/www/c_status.html
76

The component got mapped to dedicated label in GitHub. So, it will be great to get rid of bugzilla-centric definition and switch to GitHub terms

clang/www/cxx_status.html
81

Ditto. Also, there are separate labels for C++11 / 14 / 20 / 23. It might make sense to mention them here

clang/www/get_involved.html
69

I think it would make sense to get rid of bz here. For new contributors everything should be GitHub-centric

libcxx/docs/index.rst
220

I'd remove bugzilla here

libunwind/docs/index.rst
101

And here

llvm/docs/HowToReleaseLLVM.rst
280

This is for @tstellar :)

This revision now requires changes to proceed.Dec 28 2021, 11:09 PM

Address comments.

asl requested changes to this revision.Dec 29 2021, 2:10 AM

Will you please check the comments and reword everything using proper terminology and new things we're having on GitHub?

clang/www/c_status.html
76

As I said – there is no "Clang C component" in github. We need to reword everything in terms of labels and mention correct label here.

clang/www/cxx_status.html
81

See above

This revision now requires changes to proceed.Dec 29 2021, 2:10 AM
ChuanqiXu updated this revision to Diff 396509.Dec 29 2021, 3:41 AM

Address comments.

ChuanqiXu marked 7 inline comments as done.Dec 29 2021, 3:43 AM
ChuanqiXu added inline comments.
clang/www/c_status.html
76

My bad. I didn't realize "Clang C Component" is specific to bugzilla.

clang/www/cxx_status.html
81

BTW, I checked that there isn't c++23 labels now.

ldionne accepted this revision as: Restricted Project, Restricted Project.Dec 29 2021, 6:04 AM
ldionne added a subscriber: ldionne.

Libc++ and libunwind changes LGTM

Quuxplusone accepted this revision.Dec 29 2021, 7:02 AM
Quuxplusone added a subscriber: Quuxplusone.

Tweaked English wording throughout. LGTM with all these modifications made.

Orthogonally, it does occur to me that one might save a lot of this churn (and also the next time the bug tracker moves, e.g. if we go from GitHub to something else) by simply HTTP-redirecting the front page of https://bugs.llvm.org/ to https://github.com/llvm/llvm-project/issues/ . Then we'd have a stable URL https://bugs.llvm.org/ for "reporting LLVM bugs, forever," and we could just use that stable URL everywhere. But OTOH, that's a devops task, whereas updating a bunch of documentation in the repo is easy. :)

clang-tools-extra/docs/clang-doc.rst
15

Please leave the English wording as "the LLVM bugtracker" (or "the LLVM bug tracker" — really it should be two words). There is no such noun in English as "an Issues," which means that the reader won't have any idea what you're talking about here unless they click on the link to see where it goes.

clang/www/c_status.html
75–78
clang/www/cxx_status.html
82–83

(I think , "C++17", "C++20", "C++23" would just be redundant/noise here, and would imply a thankless task for someone to go update this list every 3 years. Better to just cap it at one or two labels. The reader can be trusted to figure out that C++20 issues should be labeled with C++20.)

clang/www/get_involved.html
68–69
clang/www/get_started.html
22
libcxx/docs/index.rst
220–221
libunwind/docs/index.rst
101–102
lld/docs/_templates/indexsidebar.html
3–4
libunwind/docs/index.rst
101–102
lld/docs/_templates/indexsidebar.html
3–4

While here, mention the labels: lld:COFF lld:ELF lld:MachO lld:wasm.

llvm/docs/CommandGuide/llvm-objdump.rst
400
llvm/docs/CommandGuide/llvm-size.rst
194
llvm/docs/CommandGuide/llvm-strings.rst
126
llvm/docs/CommandGuide/llvm-strip.rst
197
MaskRay added inline comments.Dec 29 2021, 1:21 PM
libcxx/docs/index.rst
220–221

Would https://github.com/llvm/llvm-project/labels/libc++ be better?

Unfortunately "New issue" on that page does not apply the label automatically.

ChuanqiXu updated this revision to Diff 396589.Dec 29 2021, 6:13 PM
ChuanqiXu marked 2 inline comments as done.

Address comments.

ChuanqiXu marked 14 inline comments as done.Dec 29 2021, 6:15 PM
ChuanqiXu added inline comments.
clang/www/c_status.html
75–78

I use the lower-case 'c' to keep consistent with GitHub labels.

clang/www/cxx_status.html
82–83

I use the lower-case 'c' to keep consistent with GitHub labels.

lld/docs/_templates/indexsidebar.html
3–4

I found label lld would cover the sub-labels.

MaskRay added inline comments.Dec 30 2021, 12:48 AM
llvm/docs/CommandGuide/llvm-objcopy.rst
539

https://github.com/llvm/llvm-project/labels/tools:llvm-objcopy/strip

You need to check whether other tools have dedicated labels.

ChuanqiXu marked 2 inline comments as done.

Address comments.

ChuanqiXu marked an inline comment as done.Dec 30 2021, 12:59 AM
ChuanqiXu added inline comments.
llvm/docs/CommandGuide/llvm-objcopy.rst
539

Thanks for reminding me this. I have found there is a label for lldb too. But I don't find labels for other tools.

MaskRay accepted this revision.Dec 30 2021, 1:28 PM
xbolva00 added inline comments.
llvm/utils/gn/secondary/clang/include/clang/Config/BUILD.gn
10

This url should redirect to github - who maintains llvm website?

MaskRay added inline comments.Dec 30 2021, 1:35 PM
lld/docs/_templates/indexsidebar.html
3–4

You can drop changes to this file. I updated it separately.

ChuanqiXu updated this revision to Diff 396737.Dec 30 2021, 5:28 PM
ChuanqiXu marked an inline comment as done.

Drop the change in lld.

ChuanqiXu added inline comments.Dec 30 2021, 5:37 PM
llvm/utils/gn/secondary/clang/include/clang/Config/BUILD.gn
10

It redirects to the issue list correctly in my environment. Or you mean the url shouldn't refer to GitHub issues? I am a little bit confused.

ksyx added a subscriber: ksyx.Dec 30 2021, 6:20 PM
ksyx added inline comments.
libcxx/docs/index.rst
220–221

Adding parameter like in https://github.com/llvm/llvm-project/issues/new?labels=ABI could be the most direct way of doing this, given the label exists, so do assignee (untested)? Besides, the new
Issue Forms feature of GitHub is also a good idea that also unifys what to fill out in a request and what to automatically do with the issue.

libcxx/docs/index.rst
220–221

Given that you are using the "search for label" URLs in the other places now, I think (for consistency) it does make sense to change this one to https://github.com/llvm/llvm-project/labels/libc++/. (With or without the trailing slash, but be consistent.)

Please do not hard-code any links to https://github.com/llvm/llvm-project/issues/new-anything; IMHO that makes it far too likely that people (or robots) who click there will end up creating a new spam issue by accident. Someone who's found a bug to report should be taken to the search page (to search and see if it's already been filed). Taking them straight to "create a (probably spam) issue" is completely counterproductive.

MaskRay added inline comments.Dec 30 2021, 8:26 PM
libcxx/docs/index.rst
220–221

It's always important to check existing issues before filing a new one. I agree /new should be avoided.

@asl hi, do you feel good with this revision?

jhenderson added inline comments.Jan 5 2022, 5:39 AM
llvm/docs/CommandGuide/llvm-install-name-tool.rst
79

I believe llvm-install-name-tool is a variation of llvm-objcopy, so should probably reference the llvm-objcopy URL.

llvm/docs/CommandGuide/llvm-otool.rst
135

I believe llvm-otool is a variation of llvm-objdump, so should reference the llvm-objdump URL.

ChuanqiXu updated this revision to Diff 397763.Jan 5 2022, 6:18 PM

Address comments.

ChuanqiXu marked 2 inline comments as done.Jan 5 2022, 6:19 PM
jhenderson accepted this revision.Jan 6 2022, 12:29 AM

LGTM, from my point of view.

It looks like @asl isn't here and many experienced guys accepted this. So I think it might should be good to commit this one.

This revision was not accepted when it landed; it landed in state Needs Review.Jan 6 2022, 1:35 AM
This revision was landed with ongoing or failed builds.
This revision was automatically updated to reflect the committed changes.