Closed
Bug 1591118
Opened 5 years ago
Closed 5 years ago
'./mach doc' should provide a clearer error message when jsdoc is missing ("./mach: jsdoc not found - please install from npm.")
Categories
(Developer Infrastructure :: Source Documentation, enhancement)
Developer Infrastructure
Source Documentation
Tracking
(firefox72 fixed)
RESOLVED
FIXED
mozilla72
| Tracking | Status | |
|---|---|---|
| firefox72 | --- | fixed |
People
(Reporter: jwatt, Assigned: jwatt)
References
Details
Attachments
(1 file)
When I first invoked mach doc I got:
$ ./mach doc
./mach: jsdoc not found - please install from npm.
So I ran:
$ npm install jsdoc
That installed successfully, but the same error persisted. I dug around a bit and recalled that we bundle our own node and npm under ~/.mozbuild, so I invoked:
~/.mozbuild/node/bin/npm install jsdoc
Still the same error.
After some more digging I ended up on:
https://github.com/mozilla/sphinx-js
where it says to consider using the -g flag.
Really this message should be clearer to save people wasting time.
|
Assignee | |
Updated•5 years ago
|
Summary: './mach doc' should provide a clearer error message when jsdoc is missing → './mach doc' should provide a clearer error message when jsdoc is missing ("./mach: jsdoc not found - please install from npm.")
|
|
Assignee | |
Comment 1•5 years ago
|
||
|
||
Comment 2•5 years ago
|
||
Thanks for working on it. I faced this same issue a few days ago and cried :)
Assignee: nobody → jwatt
Pushed by jwatt@jwatt.org: https://hg.mozilla.org/integration/autoland/rev/89674def7ffb Make 'mach doc' provide a clearer error message when jsdoc is missing. r=ahal
|
||
Comment 4•5 years ago
|
||
| bugherder | ||
Status: NEW → RESOLVED
Closed: 5 years ago
status-firefox72:
--- → fixed
Resolution: --- → FIXED
Target Milestone: --- → mozilla72
|
||
Comment 5•5 years ago
|
||
| bugherder landing | ||
|
||
Updated•2 years ago
|
Product: Firefox Build System → Developer Infrastructure
You need to log in
before you can comment on or make changes to this bug.
Description
•