Closed Bug 1619956 Opened 4 years ago Closed 4 years ago

./mach static-analysis --help should link to documentation

Categories

(Developer Infrastructure :: Source Code Analysis, enhancement)

enhancement
Not set
normal

Tracking

(firefox76 fixed)

RESOLVED FIXED
mozilla76
Tracking Status
firefox76 --- fixed

People

(Reporter: mbrodesser-Igalia, Assigned: bobyrobert3, Mentored)

Details

(Keywords: good-first-bug, Whiteboard: [lang=python])

Attachments

(1 file, 1 obsolete file)

For instance, ./mach static-analysis --help should link to https://firefox-source-docs.mozilla.org/code-quality/static-analysis.html. Or contain all necessary documentation.

Great idea!
We will do that (or a new volunteer can give it a try)

Mentor: sledru
Keywords: good-first-bug
Whiteboard: [lang=python]

Hey,
I would like to work on this bug. But since its my first time over here can I know what exactly needs to be done?

I've run the above command and it displayed the arguments details as expected.

See the first comment. the command should include a link to the doc ;)

See:
https://firefox-source-docs.mozilla.org/contributing/how_to_contribute_firefox.html
about the contribution path

So just to confirm when the command is entered the webpage should be opened as well.
Did I get that right?

nope, just show the link in the command help

Summary: ./mach --help should link to documentation → ./mach static-analysis --help should link to documentation
Assignee: nobody → bobyrobert3
Status: NEW → ASSIGNED
Attachment #9131816 - Attachment description: Bug 1619956: Linked documentation to ./mach static-analysis --help . r=sylvestre → Bug 1619956 : Added link to documentation without adding a new command. r=sylvestre
Attachment #9131828 - Attachment is obsolete: true
Pushed by sledru@mozilla.com:
https://hg.mozilla.org/integration/autoland/rev/d9225cc36d33
Added link to documentation without adding a new command. r=sylvestre
Status: ASSIGNED → RESOLVED
Closed: 4 years ago
Resolution: --- → FIXED
Target Milestone: --- → mozilla76
Product: Firefox Build System → Developer Infrastructure
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Creator:
Created:
Updated:
Size: