Firefox Contributors’ Quick Reference should use bootstrap.py
Categories
(Firefox Build System :: Build Documentation, task)
Tracking
(firefox101 fixed)
| Tracking | Status | |
|---|---|---|
| firefox101 | --- | fixed |
People
(Reporter: arai, Assigned: manisha270417)
References
Details
Attachments
(1 file, 2 obsolete files)
"Firefox Contributors’ Quick Reference" has "Clone the sources" step and "Install dependencies" step, that does clone and bootstrap separately:
https://firefox-source-docs.mozilla.org/contributing/contribution_quickref.html#clone-the-sources
hg clone https://hg.mozilla.org/mozilla-central/
...
./mach bootstrap
But the build document has "Bootstrap a copy of the Firefox source code", that does clone and bootstrap at the same time, with different commands
https://firefox-source-docs.mozilla.org/setup/windows_build.html#bootstrap-a-copy-of-the-firefox-source-code
cd c:/
mkdir mozilla-source
cd mozilla-source
wget https://hg.mozilla.org/mozilla-central/raw-file/default/python/mozboot/bin/bootstrap.py
python3 bootstrap.py
This causes confusion for newcomers.
The quickref should align with build document, with adding note that the step can be skipped if it's already done.
|
Assignee | |
Comment 1•2 years ago
|
||
How can I work on this issue? Or this is only for reference?
|
Reporter | |
Comment 2•2 years ago
|
||
the document is generated from the following file
https://searchfox.org/mozilla-central/source/docs/contributing/contribution_quickref.rst
that maps to mozilla-unified/docs/contributing/contribution_quickref.rst in your local file.
You need to fix the Clone the sources and Install dependencies (non-Windows) sections to match the build documents
- https://firefox-source-docs.mozilla.org/setup/windows_build.html#bootstrap-a-copy-of-the-firefox-source-code
- https://firefox-source-docs.mozilla.org/setup/macos_build.html#bootstrap-a-copy-of-the-firefox-source-code
- https://firefox-source-docs.mozilla.org/setup/linux_build.html#bootstrap-a-copy-of-the-firefox-source-code
The steps are slightly different for each OS, but basically what needs to be done there are:
- download bootstrap.py script
- run it
That effectively does the same thing as hg clone ... and ./mach bootstrap.
|
|
Assignee | |
Comment 3•2 years ago
|
||
|
||
Updated•2 years ago
|
|
|
||
Updated•2 years ago
|
|
|
Assignee | |
Comment 4•2 years ago
|
||
Depends on D143323
|
|
Assignee | |
Comment 5•2 years ago
|
||
Depends on D143874
|
|
||
Updated•2 years ago
|
|
|
||
Updated•2 years ago
|
|
|
||
Updated•2 years ago
|
|
|
||
Updated•2 years ago
|
|
|
||
Updated•2 years ago
|
|
|
||
Updated•2 years ago
|
Pushed by sledru@mozilla.com: https://hg.mozilla.org/integration/autoland/rev/48f9ca60b08b Bootstrap Section added as per required OS. r=arai,sylvestre DONTBUILD
|
||
Comment 7•2 years ago
|
||
| bugherder | ||
Description
•