Commit Graph

50 Commits

Author SHA1 Message Date
Tooru Fujisawa
19957fd576 Bug 1735058 - Use absolute path to mozilla-unified after possible restart of shell. r=mhentges,glandium
bootstrap.py may ask the restart of shell to reflect the change to login script.
Given the step 2 lets user to move to c:/mozilla-source instead of home,
the document should explicitly specify the absolute path in step 3.

Differential Revision: https://phabricator.services.mozilla.com/D128024
2021-10-13 06:42:08 +00:00
Tooru Fujisawa
977ada4fc0 Bug 1735307 - Move "rm bootstrap.py" into bootstrap step. r=glandium,mhentges
Differential Revision: https://phabricator.services.mozilla.com/D128184
2021-10-13 06:42:07 +00:00
Tooru Fujisawa
433891f37c Bug 1734983 - Use mozilla-unified in Building Firefox On Windows doc. r=sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D128010
2021-10-09 10:43:15 +00:00
Mike Hommey
779df1bdd5 Bug 1729383 - Advertize MOZ_PARALLEL_BUILD=n rather than MOZ_MAKE_FLAGS=-jn in docs. r=firefox-build-system-reviewers,mhentges
Both work, but the former is preferred. Also remove MOZ_MAKE_FLAGS
in the mozconfig example for msan, because it's irrelevant.

Differential Revision: https://phabricator.services.mozilla.com/D124726
2021-09-08 00:10:21 +00:00
surajeet310
6cf624ea47 Bug 1714788 - Fixed more Sphinx warnings in 'mach doc' r=sylvestre DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D117419
2021-06-10 19:33:53 +00:00
Sylvestre Ledru
f7403d55d6 Bug 1714434 - Doc/contribution: Rename the file about Mozilla contributions r=gsvelto DONTBUILD
and set up a redirect

Differential Revision: https://phabricator.services.mozilla.com/D116820
2021-06-06 14:36:52 +00:00
Pier-Luc Thériault
927e68f764 Bug 1711824 - Removing documentation on MOZ_BUILD_PROJECTS because it is obsolete r=firefox-build-system-reviewers,mhentges
Differential Revision: https://phabricator.services.mozilla.com/D115440
2021-05-19 14:17:25 +00:00
byron jones
3e7e3e6082 Bug 1704426 - Document supported build hosts. r=glob
Define "build host" support tiers, and their relationship
to existing "target" tiers.

Differential Revision: https://phabricator.services.mozilla.com/D111578
2021-05-18 14:57:50 +00:00
Gijs Kruitbosch
863737dfee Bug 1702526 - suggest people use wget instead of curl for downloading the bootstrap script on Windows DONTBUILD r=glob
Differential Revision: https://phabricator.services.mozilla.com/D110568
2021-04-01 17:23:05 +00:00
Jan Odvarko
78711e11bc Bug 1658876 - [devtools] Avoid including its own cloning and build instructions in docs. r=nchevobbe
Removing DevTools specific build instructions in favor of https://firefox-source-docs.mozilla.org/setup/index.html

Differential Revision: https://phabricator.services.mozilla.com/D108182
2021-03-15 11:41:14 +00:00
Nikita Sen
2b0ae429f8 Bug 1696813 - Path of mach changed from mozilla-unified to project repository, i.e. mozilla-central. r=gsvelto DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D107887
2021-03-11 13:36:35 +00:00
Mitchell Hentges
b046fbcaf4 Bug 1696225: Remove "Processor" requirement in Mac quick-start r=firefox-build-system-reviewers,glandium
The linked ARM wiki docs are obsolete, and will soon be unnecessary.
Additionally, the "processor" requirement is entirely redundant since we
support all processors compatible with macOS 10.12 or later.

Differential Revision: https://phabricator.services.mozilla.com/D107098
2021-03-09 16:27:03 +00:00
Mitchell Hentges
e856ec2003 Bug 1687980: Remove obsolete Fedora 19/20 32bit setup docs r=sylvestre
Fedora 19 and 20 were released in 2013. If these docs haven't been
adjusted for modern Fedora, they're probably out-of-date.

Differential Revision: https://phabricator.services.mozilla.com/D104733
2021-02-16 17:48:12 +00:00
Mitchell Hentges
477f8ec781 Bug 1687980: Simplify "Getting Set Up" page r=mhoye,firefox-build-system-reviewers,glandium,sylvestre,andi
When a user is at the top-level "Getting Set Up" page, they should be
shown which path to take (Windows/Mac/Linux) without redundantly showing
the platform-specific technicalities.

Differential Revision: https://phabricator.services.mozilla.com/D104099
2021-02-16 17:48:12 +00:00
Mitchell Hentges
96eb9b05df Bug 1687980: Make Linux quickstart docs more concise r=mhoye,sylvestre
* Removes duplicated information
* Removes unnecessary extra details (e.g.: how pyenv works - that's
  documented in pyenv docs)
* Recommends the standalone bootstrap script
* Removes unnecessary mozconfig instructions
* Removes unnecessary per-distro information

Differential Revision: https://phabricator.services.mozilla.com/D102975
2021-02-16 17:48:12 +00:00
Mitchell Hentges
5e75f3fda3 Bug 1687980: Make Windows quickstart docs more concise r=mhoye,sylvestre,andi
* Puts the docs in order, so that contributors aren't jumping to the
  middle of the page to install system tools, then back to the top to
  clone Firefox.
* Removes docs on MacPorts since it's being removed in bug 1688263.
* Removes step to manually install brew packages since that happens
   automatically in bootstrap now.
* Simplifies mercurial installation docs
* Removes unnecessary mozconfig-tweaking instructions
* Removes almost-always-unnecessary DEFINE and troubleshooting
  information.

Differential Revision: https://phabricator.services.mozilla.com/D102974
2021-02-16 17:48:11 +00:00
Mitchell Hentges
382cfbe476 Bug 1687980: Make macOS quickstart docs more concise r=sylvestre,mhoye
* Puts the docs in order, so that contributors aren't jumping to the
  middle of the page to install system tools, then back to the top to
  clone Firefox.
* Removes docs on MacPorts since it's being removed in bug 1688263.
* Removes step to manually install brew packages since that happens
   automatically in bootstrap now.
* Simplifies mercurial installation docs
* Removes unnecessary mozconfig-tweaking instructions
* Removes almost-always-unnecessary DEFINE and troubleshooting
  information.

Differential Revision: https://phabricator.services.mozilla.com/D102973
2021-02-16 17:48:11 +00:00
Sylvestre Ledru
a975098829 Bug 1690785 - Update of the contribution doc wrt check-in needed r=jwalker,aryx DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D104057
2021-02-04 21:52:38 +00:00
Daniel Le
fb46886140 Bug 1684672 - Update mentions of macOS SDK v10.11 to v10.12. r=glandium DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D100591
2021-01-21 12:47:01 +00:00
Ricky Stewart
b14a34ba88 Bug 1675875 - Document --enable-release and RUSTC_OPT_LEVEL r=sylvestre DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D96858
2020-11-16 16:47:46 +00:00
Emilio Cobos Álvarez
10ae1478ab Bug 1676307 - Provide concrete instructions to enable sccache. r=sylvestre
And also, don't output that message if already using sccache.

Differential Revision: https://phabricator.services.mozilla.com/D96497
2020-11-10 17:58:30 +00:00
Zac Svoboda
a496819c0d no bug - Update IRC reference to Matrix r=sylvestre,championshuttler DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D96334
2020-11-09 14:12:13 +00:00
Stephen A Pohl
2bc812c193 Bug 1668941: Update build and debugging documentation for macOS. r=haik DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D92293
2020-10-13 17:58:50 +00:00
Dhairya Bahl
44a6adbf9f Bug 1669921 - Fixed a typo in windows_build.rst r=championshuttler,sylvestre DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D92896
2020-10-08 11:54:45 +00:00
Ricky Stewart
7feb0e887b Bug 1667436 - Merge content of docs/setup/mach.rst into existing documentation r=firefox-build-system-reviewers,mhentges DONTBUILD
This document was imported from MDN and contained very outdated/incorrect information, and much of the information here is duplicated from the existing `mach` documentation. For the little content that isn't already expressed in the existing documentation in a better way, merge it into `python/mach/docs`.

The unique content is mainly in the FAQ, so I added a new page for that.

Differential Revision: https://phabricator.services.mozilla.com/D91455
2020-10-05 16:51:41 +00:00
Sylvestre Ledru
af5e653325 Bug 1667831 - doc: fix more pygments r=firefox-source-docs-reviewers,championshuttler DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D91868
2020-09-30 07:03:41 +00:00
Sylvestre Ledru
e256974131 Bug 1667831 - doc: fix more warnings r=firefox-source-docs-reviewers,ahal DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D91642
2020-09-29 18:48:17 +00:00
Sylvestre Ledru
527e1fbebf Bug 1667831 - doc: refresh links as many pages moved in-tree r=firefox-source-docs-reviewers,ahal DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D91619
2020-09-29 17:53:54 +00:00
Sylvestre Ledru
3c9dd32ad9 no bug - fx doc - Fix some rst warnings
Depends on D90832

Differential Revision: https://phabricator.services.mozilla.com/D90864
2020-09-22 06:26:42 +00:00
Sylvestre Ledru
40027ba8a0 Bug 1665854 - fx doc: Various improvements + configuration + fixes in the doc r=firefox-build-system-reviewers,rstewart
Depends on D90831

Differential Revision: https://phabricator.services.mozilla.com/D90832
2020-09-22 06:26:17 +00:00
Sylvestre Ledru
36de28c12e Bug 1665854 - fx doc: Update the contributions docs from MDN r=firefox-build-system-reviewers,rstewart
Depends on D90664

Differential Revision: https://phabricator.services.mozilla.com/D90665
2020-09-21 19:31:16 +00:00
Sylvestre Ledru
d3d8620ad1 Bug 1665854 - Import more contributions docs from MDN r=firefox-build-system-reviewers,rstewart
Differential Revision: https://phabricator.services.mozilla.com/D90664
2020-09-21 17:57:22 +00:00
Sylvestre Ledru
3a3185c6c3 Bug 1666244 - Update of the wording + url at the end of the build r=mhoye
Differential Revision: https://phabricator.services.mozilla.com/D90855
2020-09-21 13:43:52 +00:00
Ricky Stewart
8f70b08b00 Bug 1664581 - Specifically recommend installing version control systems in documentation r=nalexander
This is a requirement anyway, and the bootstrap script will yell at you if it can't find `hg` (or `git`, if it's necessary), but we can be more specific about this requirement here so people don't waste any more time than necessary.

Differential Revision: https://phabricator.services.mozilla.com/D90172
2020-09-14 21:30:21 +00:00
Ricky Stewart
9af91979fb Bug 1663959 - Remove references to autoconf from build documentation r=dmajor
As of bug 1663863, we vendor this in-tree, so installing/configuring it is no longer necessary.

Differential Revision: https://phabricator.services.mozilla.com/D89614
2020-09-09 15:44:50 +00:00
Ricky Stewart
2949509f6b Bug 1660831 - Reference the standalone bootstrap.py script in windows_build.rst and prefer mozilla-unified to mozilla-central where relevant r=mhentges,froydnj
Today the docs tell you to directly clone `mozilla-central`, which is a weird departure from what we do in the other per-platform documents for no real reason. Instead, reference the standalone `bootstrap.py` script as we do for Linux and macOS.

Also, do a little scan and replace references to `mozilla-central` with `mozilla-unified` where appropriate.

Differential Revision: https://phabricator.services.mozilla.com/D88051
2020-08-31 17:51:14 +00:00
Sylvestre Ledru
fb390e82f9 Bug 1657926 - firefox doc: fix some warnings r=championshuttler
Differential Revision: https://phabricator.services.mozilla.com/D86732
2020-08-11 23:20:25 +00:00
Mitchell Hentges
6610733390 Bug 1655361: Prints a warning if Windows Defender is watching the Firefox checkout directory r=firefox-build-system-reviewers,rstewart
There's a Windows Defender CLI (`Get-MpComputerStatus`) available, but MozillaBuild
can't (easily) access PowerShell. So, instead, we find Windows Defender status and path exclusions
by checking the registry at HKLM\SOFTWARE\Microsoft\Windows Defender.

Determining if Windows Defender is "on" or not is a surprisingly vague task.
Not only does it encompass a lot of components (of which Ricky and I believe "Real-time protection"
is the part slowing down the build), but there's (at least?) two different kinds of "disabled"
states that it can be in:
* If "disabled" via Settings, it will turn itself back on after a reboot
* If an antivirus is installed, it will turn itself off permanently

Unfortunately, disabling "Real-time protection" in Settings doesn't affect any registry keys, but
I'm opting to ignore this because I doubt many users are manually disabling this protection before
each build. The repercussion of this is that users may be incorrectly warned "your Firefox
directory isn't excluded from Windows Defender!".

Focusing on the antivirus use case and querying the registry I found that:
* Querying the `IsServiceRunning` value wasn't sufficient because new Windows installations didn't have that key
* Querying the `DisableRealtimeMonitoring` value was inconsistent - it can be missing, and not always because an antivirus removed it
* Querying the `DisableAntiVirus` value doesn't _sound_ accurate (we care about Real-time Protection), but it's consistently "off" for non-AV machines, and "on" for machines with an AV installed. So, this is our winner!

TL;DR: there may be some "false positive" warnings about excluding the Firefox srcdir, but they're
accurate for my test cases and workaround-able (just add the exclusion to Windows Defender).

Also, this patch updates our Windows Defender docs to make them:
* More easily link-able
* Have direct advice to resolve the issue

Differential Revision: https://phabricator.services.mozilla.com/D85952
2020-08-11 20:59:40 +00:00
Ricky Stewart
ce2340fc5e Bug 1647806 - Document Python installation steps r=firefox-source-docs-reviewers,sylvestre,froydnj
`bootstrap` won't be able to install them for you forever (and it isn't really properly capable of installing it for you at this very moment), and installing Python 3 as well as Python 2 is increasingly non-trivial on arbitrary OS'es, so we need to document things properly here.

Specific guidance on how to use `brew` to install Python 2 on macOS is included here. I also go into more depth on the situation on Linux and explicitly point people to the existence of `pyenv` with basic usage information, which should fill in the gaps left by the OS package managers.

Also, update some documentation to prefer the `python3` binary to the `python` binary (which is often Python 2), and fix some broken links.

Differential Revision: https://phabricator.services.mozilla.com/D82611
2020-07-20 18:15:39 +00:00
Ricky Stewart
23ac6ab739 Bug 1648555 - mach bootstrap installs libdrm-dev package on Ubuntu/Debian r=dmajor
Also delete a bunch of dead code that was apparently meant to be useful for subclassing, but there's no subclasses of `DebianBootstrapper` in tree.

Differential Revision: https://phabricator.services.mozilla.com/D82073
2020-07-16 13:49:59 +00:00
Sonia Singla
5ed6843d47 Bug 1651099 - Broken link to contributor reference. r=rstewart,championshuttler,sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D82562
2020-07-08 07:32:17 +00:00
David Major
79af755d17 Bug 1649193 - Update the package list in linux_32bit_build_on_64bit_OS.rst r=padenot
On a new machine the instructions didn't fully work for me. I suspect that `libpulse-dev:i686` -> `i386` might have been a typo, and I also needed `libx11-xcb-dev:i386`.

Differential Revision: https://phabricator.services.mozilla.com/D81560
2020-06-30 09:02:17 +00:00
Paul Adenot
7e68677828 Bug 1648393 - Link it from the main Linux build page. r=firefox-source-docs-reviewers,sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D81044
2020-06-26 12:52:39 +00:00
Paul Adenot
be3c5a555c Bug 1648393 - Update this document for Ubuntu and remove obsolete section. r=firefox-source-docs-reviewers,sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D81043
2020-06-26 12:52:31 +00:00
Paul Adenot
e8ba008695 Bug 1648393 - Import Compiling_32-bit_Firefox_on_a_Linux_64-bit_OS from MDN. r=firefox-source-docs-reviewers,sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D81042
2020-06-26 12:52:25 +00:00
Sylvestre Ledru
9e24410e89 Bug 1642898 - Remove most of the references of black/whitelist within the doc r=Gijs
Differential Revision: https://phabricator.services.mozilla.com/D78000
2020-06-03 09:34:12 +00:00
Sylvestre Ledru
4ace2b8383 no bug - typo fixes - Remove duplicated doc docs/contributing/build/supported_configurations.rst
The right one is here:
build/docs/supported-configurations.rst

Differential Revision: https://phabricator.services.mozilla.com/D77645
2020-06-01 09:53:22 +00:00
Sylvestre Ledru
fd766c28c8 Bug 1641182 - doc: Add a link to the quick reference doc
Differential Revision: https://phabricator.services.mozilla.com/D77054
2020-05-28 13:04:02 +00:00
Sylvestre Ledru
75b60525b9 Bug 1641182 - doc: fix links and remove some deprecated infos r=championshuttler
Differential Revision: https://phabricator.services.mozilla.com/D77053
2020-05-28 13:04:00 +00:00
mhoye
85c128b218 Bug 1179358 - Consolidation of documentation patches into MC r=sylvestre
Depends on D68835

Differential Revision: https://phabricator.services.mozilla.com/D76398
2020-05-25 07:26:51 +00:00