Closed Bug 1484925 Opened 2 years ago Closed 2 years ago

UseCounter documentation links to non-existing file

Categories

(Toolkit :: Telemetry, enhancement, P3)

enhancement

Tracking

()

RESOLVED FIXED
mozilla63
Tracking Status
firefox63 --- fixed

People

(Reporter: janerik, Assigned: arshadkazmi42, Mentored)

Details

(Whiteboard: [good first bug][lang=rst])

Attachments

(1 file)

Currently the Use Counter documentation[1] links to a file called `nsCSSPropList.h`[2].
However this file does not exist anymore.

I think the generated `ServoCSSPropList.h` is its replacement (however, that file is not available in searchfox or dxr)

We should fix the link.


[1]: https://firefox-source-docs.mozilla.org/toolkit/components/telemetry/telemetry/collection/use-counters.html#css-properties
[2]: https://dxr.mozilla.org/mozilla-central/source/layout/style/nsCSSPropList.h
Mentor: jrediger
Whiteboard: [good first bug][lang=rst]
Priority: -- → P3
ServoCSSPropList.h is available here: https://searchfox.org/mozilla-central/source/__GENERATED__/layout/style/ServoCSSPropList.h

:emilio: Is that the best file to link to from the documentation?
Flags: needinfo?(emilio)
Yeah, that one should work. Thanks!
Flags: needinfo?(emilio)
Is it open for grab? I am interested to take this up.
Flags: needinfo?(jrediger)
Yes, I just assigned the bug to you.

The task is rather simple:
Exchange the link in the use counter documentation[1]  with the above link to the ServoCSSPropList.h file.

Once you've done that, compile the documentation with `./mach doc`, open it in a browser, go to the Use Counter documentation and check that the link works and everything is correct.

[1]: https://searchfox.org/mozilla-central/rev/e126996d9b0a3d7653de205898517f4f5b632e7f/toolkit/components/telemetry/docs/collection/use-counters.rst#52

Please ping me if you need any additional help.
Assignee: nobody → arshadkazmi42
Flags: needinfo?(jrediger)
Below searchfox url needs to be updated in that?

`https://searchfox.org/mozilla-central/source/__GENERATED__/layout/style/ServoCSSPropList.h`

Or is there any other production URL which needs to be used?
Flags: needinfo?(jrediger)
So. I found a similar type of url for other link. So adding this file and pushing code to Phabricator for review.

Let me know if that url is different & needs to be changed
Pushed code to Phabricator. And added you as reviewer

https://phabricator.services.mozilla.com/D4363
Flags: needinfo?(jrediger)
Comment on attachment 9004317 [details]
Bug 1484925 - UseCounter Broken Link Fixed.

Jan-Erik Rediger [:janerik] has approved the revision.
Attachment #9004317 - Flags: review+
Pushed by jrediger@mozilla.com:
https://hg.mozilla.org/integration/autoland/rev/d214235eef08
UseCounter Broken Link Fixed. r=janerik
https://hg.mozilla.org/mozilla-central/rev/d214235eef08
Status: NEW → RESOLVED
Closed: 2 years ago
Resolution: --- → FIXED
Target Milestone: --- → mozilla63
You need to log in before you can comment on or make changes to this bug.