Commit Graph

175 Commits

Author SHA1 Message Date
Ricky Stewart
72d793d728 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
Sylvestre Ledru
f23398e021 no bug - Update the pylint doc r=andi DONTBUILD
Also do that to verify reviewbot

Differential Revision: https://phabricator.services.mozilla.com/D90075
2020-09-14 10:34:37 +00:00
Brian Grinstead
4edb87a680 Bug 1664507 - Add documentation for testing policy r=Gijs DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D89941
2020-09-11 19:19:29 +00:00
Andi-Bogdan Postelnicu
4e61a84966 no bug - Doc: document vscode integration. r=sylvestre DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D89716
2020-09-10 13:56:26 +00:00
Ricky Stewart
e559d0c65b 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
Sylvestre Ledru
62f7f8390f Bug 1663916 - mdn to in-tree: Import some Windows & Debugging info r=firefox-build-system-reviewers,rstewart
Differential Revision: https://phabricator.services.mozilla.com/D89592
2020-09-09 15:37:20 +00:00
Ricky Stewart
f339ca9f42 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
Emil Farisan
3997e86c02 Bug 1661434 - added imported message banner to imported pages.
Differential Revision: https://phabricator.services.mozilla.com/D88733
2020-08-31 12:13:53 +00:00
Emil Farisan
affc18cdb6 Bug 1661434 - added mozilla symbol server and source server page to in-tree. r=sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D88729
2020-08-31 11:51:58 +00:00
Emil Farisan
611d45c6ff Bug 1661434 - move some strings to an rst code block. r=sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D88728
2020-08-31 11:52:06 +00:00
Emil Farisan
7a87d13818 Bug 1661434 - made content changes to some of the pages. r=sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D88727
2020-08-31 11:50:47 +00:00
Emil Farisan
d68985630c Bug 1661434 - added debugging and taskcluster pages from MDN to in-tree. r=sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D88580
2020-08-31 11:16:52 +00:00
Sylvestre Ledru
da28d33f60 no bug - Fx doc: Replace the record/replay doc by rr DONTBUILD
This is a simple import from:
https://github.com/mozilla/rr/wiki/Recording-Firefox

Differential Revision: https://phabricator.services.mozilla.com/D87946
2020-08-22 15:08:37 +00:00
Chris H-C
5493409c18 Bug 1654339 - Add Glean metrics autodocs to moztreedocs r=janerik,ahal
Also define a scheme for storing the index of Glean definitions files in a file
separate from the build system for consumption by
* mach build
* mach doc
* (future) mozilla/probe-scraper

Differential Revision: https://phabricator.services.mozilla.com/D87600
2020-08-21 16:30:45 +00:00
Emil Farisan
e5378efe38 Bug 1658505 - updated links and updated some code blocks. r=sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D87443
2020-08-19 16:10:37 +00:00
Emil Farisan
1c3c4674f6 Bug 1658505 - added banner in migrated pages and added table. r=sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D86812
2020-08-19 10:12:39 +00:00
Emil Farisan
f7f16794c9 Bug 1658505 - renamed files from mozilla to firefox. r=sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D86811
2020-08-17 12:08:57 +00:00
Emil Farisan
bfa8dd8228 Bug 1658505 - fix codespell and rst errors and remove unused reference. r=sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D86810
2020-08-17 12:07:49 +00:00
Emil Farisan
8d75cc29fb Bug 1658505 - added debugging and memory sanitizer pages from MDN to in-tree. r=sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D86705
2020-08-17 12:07:18 +00:00
Bryce Seager van Dyk
0c45c50c1f Bug 1659726 - Fix mode line docs to use 2 space indents rather than 8. r=sylvestre DONTBUILD
Differential Revision: https://phabricator.services.mozilla.com/D87448
2020-08-19 07:51:42 +00:00
Sylvestre Ledru
5ea6c250c3 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
710be25312 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
Sylvestre Ledru
1bcabb9d34 Bug 1657926 - Move to sphinx 3.1.2 and sphinx-js 3.0.1 r=championshuttler
Hopefully, it will help with the intermittent issues.
And it seems that the warnings are better presented.

Differential Revision: https://phabricator.services.mozilla.com/D86361
2020-08-11 15:26:16 +00:00
Andi-Bogdan Postelnicu
60cc6f8d69 Bug 1656740 - Integrate clangd in vscode for C++ language support. r=froydnj
In order to have a cross platform ide for C++ language support we've added `clangd`
extenssion and artifact part of `vscode` suite.
To generate the configuration you simply run:
`./mach ide vscode `.

Differential Revision: https://phabricator.services.mozilla.com/D85416
2020-08-06 06:25:17 +00:00
Simon Giesecke
ee62debaab Bug 1653532 - Improve reference of Google Coding Style for C++ Code. r=sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D83923
2020-08-04 08:31:17 +00:00
Sylvestre Ledru
e06ff0dd5c no bug - doc - Import the 'Pocket Guide: Shipping Firefox' in tree r=RyanVM
Actual author: Thomas Elin

Differential Revision: https://phabricator.services.mozilla.com/D83930
2020-07-22 17:46:54 +00:00
Ricky Stewart
055da469b5 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
Mitchell Hentges
ccdcc211eb Bug 1653049: Docs support markdown tables r=championshuttler
Glean generates telemetry documentation in markdown and uses tables.

This revision adds support for rendering markdown tables using an extension.

Differential Revision: https://phabricator.services.mozilla.com/D83685
2020-07-17 17:11:33 +00:00
Ricky Stewart
f34f1b6153 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
Myeongjun Go
32cbdb3b33 Bug 1649497 - [perfdocs] Port mozperftest into Performance Testing r=sparky,perftest-reviewers
Differential Revision: https://phabricator.services.mozilla.com/D82207
2020-07-15 17:13:30 +00:00
Sylvestre Ledru
d9d0eda42a no bug - python CS doc - point to our linters r=marco
Differential Revision: https://phabricator.services.mozilla.com/D82897
2020-07-10 12:50:25 +00:00
Csoregi Natalia
2d34e224ae Backed out changeset 448679382b06 (bug 1649497) for linting failures on framework_gatherers.py. CLOSED TREE 2020-07-14 20:20:48 +03:00
Myeongjun Go
62777a18b5 Bug 1649497 - [perfdocs] Port mozperftest into Performance Testing r=sparky,perftest-reviewers
Differential Revision: https://phabricator.services.mozilla.com/D82207
2020-07-14 16:55:56 +00:00
Emma Humphries
b357621126 Bug 1649662 - Add examples to severity documentation r=sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D81805
2020-07-10 22:52:17 +00:00
Tom Prince
2244b1cc7c Bug 1651731: [lint] Only allow files that are typically executable to have shebang lines override permission check; r=linter-reviewers,sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D82949
2020-07-09 21:16:32 +00:00
Chris AtLee
d1fb386dae Bug 1555560: Add support for black formatting with mozlint; r=sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D33125
2020-07-08 22:08:08 +00:00
Mihai Alexandru Michis
5f385df474 Backed out 2 changesets (bug 1555560) for causing multiple lint failures.
CLOSED TREE

Backed out changeset bd9460ac6e48 (bug 1555560)
Backed out changeset f2896032ced6 (bug 1555560)
2020-07-09 01:04:18 +03:00
Chris AtLee
7f8f324f06 Bug 1555560: Add support for black formatting with mozlint; r=sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D33125
2020-07-08 19:35:49 +00:00
Sonia Singla
f20849d520 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
Gijs Kruitbosch
86a446c282 Bug 1650490 - clarify documentation about commit messages, reviewers and checkin-needed, r=sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D82238
2020-07-07 08:42:02 +00:00
Nicholas Nethercote
977d5b8a57 Bug 1648348 - Create "Writing Rust Code" docs. r=froydnj,zbraniecki,lina.
This patch includes content from the following places.

- Lina's "Getting Rusty: How to ship an XPCOM component in Firefox" slide deck.
- Zibi's "Rust <--> C/C++ FFI for newbies" gist.

It also links to Emilio's "FFI patterns #1 - Complex Rust data structures
exposed seamlessly to C++" blog post. I was going to include that content, but
it's very long, so I have omitted it for now.

Differential Revision: https://phabricator.services.mozilla.com/D81963
2020-07-07 07:38:27 +00:00
Sylvestre Ledru
4660b92c2b Bug 1645572 - doc: fix some redirects r=jorendorff
Differential Revision: https://phabricator.services.mozilla.com/D81664
2020-07-02 16:02:39 +00:00
David Major
81d6dc12a4 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
c9c5897a37 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
f2892793be 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
b42eda7890 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
Nicholas Nethercote
e671bf0673 Bug 1647987 - Create Rust testing docs. r=froydnj.
Some of the testing info is from the Oxidation wiki, and the logging info is
largely from a dev-platform email by Valentin. The other parts I wrote from
scratch.

The commit also makes some small improvements to the Rust build docs.

Differential Revision: https://phabricator.services.mozilla.com/D81017
2020-06-26 01:04:40 +00:00
Sylvestre Ledru
56fbafd822 Bug 1647265 - mozlint: when type is 'regex', add the capability to ignore the case r=ahal
Differential Revision: https://phabricator.services.mozilla.com/D80477
2020-06-23 21:45:16 +00:00
Sonia Singla
2d8647fd24 Bug 1643819 - Prevent Firefox Docs to copy $ while copying using copy button.r=championshuttler,ahal
Differential Revision: https://phabricator.services.mozilla.com/D80643
2020-06-23 15:03:30 +00:00
Dennis Schubert
34763d3a8c Bug 1647655 - Add documentation for the "webcompat-reviewers" review group. r=sylvestre
Differential Revision: https://phabricator.services.mozilla.com/D80616
2020-06-23 12:59:06 +00:00