Magic-Mirror/gecko-dev
1
0
Fork 0
mirror of https://github.com/mozilla/gecko-dev.git synced 2025-02-17 14:25:49 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Bug 1667831 - doc: refresh links as many pages moved in-tree r=firefox-source-docs-reviewers,ahal DONTBUILD

Browse Source 
Differential Revision: https://phabricator.services.mozilla.com/D91619
This commit is contained in:
Sylvestre Ledru 2020-09-29 17:53:54 +00:00
parent 1c31973d81
commit 6be67c14c4
23 changed files with 54 additions and 83 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/bug-mgmt/processes/fixing-security-bugs.rst
View File

@ -152,7 +152,7 @@ Essentials
Documentation & Contacts
------------------------
- `Normal process for submitting a patch <https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/How_to_Submit_a_Patch>`__
- :ref:`Normal process for submitting a patch <How to submit a patch>`
- `How to file a security bug <https://wiki.mozilla.org/Security/Fileabug>`__
- `Handling Mozilla security bugs (policy) <https://www.mozilla.org/en-US/about/governance/policies/security-group/bugs/>`__
- `Security Bug Approval Process <security-approval>`__

5
docs/code-quality/static-analysis.rst
View File

@ -249,8 +249,3 @@ By definition, there are currently false positives in the static
analyzer. A lot of these are due to the analyzer having difficulties
following the relatively complicated error handling in various
preprocessor macros.
.. See also
--------
- `Configuring Build Options </en/Configuring_Build_Options>`__
- `Developer Guide </En/Developer_Guide>`__

2
docs/contributing/build/artifact_builds.rst
View File

@ -11,7 +11,7 @@ with compiled code (see "Restrictions" below). Artifacts are typically
fetched from `mozilla-central <https://hg.mozilla.org/mozilla-central/>`__.
To automatically download and use pre-built binary artifacts, add the
following lines into your :ref:`mozconfig <Configuring Build Options#using-a-mozconfig-configuration-file>`
following lines into your :ref:`mozconfig <Configuring Build Options>`
file:
.. code-block:: shell

9
docs/contributing/contribution_quickref.rst
View File

@ -33,7 +33,7 @@ Firefox provides a mechanism to install all dependencies; in the source tree:
$ ./mach bootstrap
The default options are recommended.
If you're not planning to write C++ or Rust code, select :ref:`Artifact Mode <Artifact builds>`
If you're not planning to write C++ or Rust code, select :ref:`Artifact Mode <Understanding Artifact Builds>`
and follow the instructions at the end of the bootstrap for creating a mozconfig file.
More information :ref:`for Linux <Building Firefox On Linux>` and :ref:`for MacOS <Building Firefox On MacOS>`
@ -72,9 +72,9 @@ This will take a while; a few minutes to a few hours depending on your hardware.
.. note::
The default build is a compiled build with optimizations. Check out the
`mozconfig file documentation <https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Build_Instructions/Configuring_Build_Options>`__
:ref:`mozconfig file documentation <Configuring Build Options>`
to see other build options. If you don't plan to change C++ or Rust code,
an :ref:`artifact build <Artifact builds>` will be faster.
an :ref:`artifact build <Understanding Artifact Builds>` will be faster.
To run it:
@ -256,8 +256,7 @@ the reviewer identified, add the *Check-in Needed* tag to the review
The landing procedure will automatically close the review and the bug.
`More
information <https://developer.mozilla.org/docs/Mozilla/Developer_guide/How_to_Submit_a_Patch#Submitting_the_patch>`__
:ref:`More information <How to submit a patch>`
Contributing to GeckoView
-------------------------

5
docs/contributing/debugging/debugging_a_minidump.rst
View File

@ -114,9 +114,8 @@ build Breakpad, the binary will be at
``src/tools/linux/md2core/minidump-2-core``. Running the binary with the
path to a Linux minidump will generate a core file on stdout which can
then be loaded in gdb as usual. You will need to manually download the
matching Firefox binaries, but then you can use the `GDB Python
script <https://developer.mozilla.org/en/Using_the_Mozilla_symbol_server#Downloading_symbols_on_Linux_Mac_OS_X>`__
to download symbols.
matching Firefox binaries, but then you can use the :ref:`GDB Python
script <Downloading_symbols_on_Linux_Mac_OS_X>` to download symbols.
The ``minidump-2-core`` source does not currently handle processing
minidumps from a different CPU architecture than the system it was

8
docs/contributing/debugging/debugging_firefox_with_gdb.rst
View File

@ -28,13 +28,11 @@ How do I run Firefox under gdb?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The preferred method, is using the
`mach <https://developer.mozilla.org/en-US/docs/Developer_Guide/mach>`__ command-line tool to run the
:ref:`mach` command-line tool to run the
debugger, which can bypass several optional defaults. Use "mach help
run" to get more details. If inside the source directory, you would use
"./mach". If you have previously `added mach to your
path <https://developer.mozilla.org/en-US/docs/Developer_Guide/mach#Adding_mach_to_your_shell's_search_path>`__,
then just use "mach". Please note that `mach is aware of
mozconfigs <https://developer.mozilla.org/en-US/docs/Developer_Guide/mach#mach_and_mozconfigs>`__.
"./mach". If you have previously :ref:`added mach to your path <Adding_mach_to_your_shell>`,
then just use "mach". Please note that :ref:`mach is aware of mozconfigs <mach_and_mozconfigs>`.
.. code:: bash

5
docs/contributing/debugging/debugging_firefox_with_lldb.rst
View File

@ -22,9 +22,8 @@ post.
The in-tree ``.lldbinit`` should be loaded automatically in most cases
when running lldb from the command line (e.g. using
```mach`` <https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/mach>`__), but **not**
when using XCode. See `Debugging on Mac OS
X <https://developer.mozilla.org/en-US/docs/Debugging_on_Mac_OS_X>`__ for information on setting up
:ref:`mach`), but **not**
when using XCode. See :ref:`Debugging on Mac OS X` for information on setting up
XCode.
.. warning::

5
docs/contributing/debugging/debugging_on_mac_os_x.rst
View File

@ -20,13 +20,14 @@ this in your .mozconfig
.. code::
``--disable-optimize``\ ``--enable-debug-symbols``
--disable-optimize
--enable-debug-symbols
you can also add this flag if you want assertions etc. compiled in
.. code::
``--enable-debug``
--enable-debug
See :ref:`Building Firefox for macOS <Building Firefox On MacOS>`
if you need help creating your own build.

2
docs/contributing/pocket-guide-shipping-firefox.rst
View File

@ -91,7 +91,7 @@ Landing Code and Shipping Features
Mozillians (those employed by MoCo and the broader community) land lots
of code in the Mozilla repositories: fixes, enhancements, compatibility,
new features, etc. and is managed by :ref:`Mercurial <mercurial>` (aka
new features, etc. and is managed by :ref:`Mercurial <Mercurial Overview>` (aka
hg). All new code is tracked in :ref:`Bugzilla <bugzilla>`, reviewed
in :ref:`Phabricator <Phabricator>`, and then checked into the
mozilla-central repository using :ref:`Lando <Lando>`.

41
docs/contributing/vcs/mercurial.rst
View File

@ -9,8 +9,6 @@ Installation
See `Mercurial Page <https://www.mercurial-scm.org/downloads>`__ for installation.
`More information <https://developer.mozilla.org/docs/Mozilla/Mercurial/Installing_Mercurial>`__
Using `hg clone`
----------------
@ -112,6 +110,13 @@ previous releases).
URL: https://hg.mozilla.org/releases/mozilla-release/
autoland
--------
This is the integration tree for Firefox. Patches land in this repository first,
and then are merged by the sheriffs in mozilla-central.
URL: https://hg.mozilla.org/integration/autoland/
L10n repos
----------
@ -145,12 +150,10 @@ Building
--------
By default with no configuration a similar-to-release build is done. If
you wish you can
`configure <https://developer.mozilla.org/docs/Mozilla/Developer_guide/Build_Instructions/Configuring_Build_Options>`__
the build using a ``.mozconfig`` file and ``mach build``.
you wish you can :ref:`configure <Configuring Build Options>` the build using a ``.mozconfig`` file
and ``mach build``.
Different OSs have different prerequisites for a successful build,
please refer to the `build
documentation <https://developer.mozilla.org/docs/Mozilla/Developer_guide/Build_Instructions>`__
please refer to the :ref:`build documentation <Getting Set Up To Work On The Firefox Codebase>`
to verify they are available on your build machine.
Extensions
@ -198,31 +201,9 @@ Configuring the try repository
About `Try Server <Try Server>`__.
Further reading
---------------
The `Mercurial
tag <https://developer.mozilla.org/docs/tag/Mercurial>`__ lists
the Mercurial-related articles on MDN.
And on wiki.mozilla.org, these helpful pages:
- `Creating Mercurial User
Repositories <https://developer.mozilla.org/docs/Creating_Mercurial_User_Repositories>`__ , If you have a LDAP account that allows you to push to hg.mozilla.org
you can also create your own user repositories on the server to share
work.
Learning to use Mercurial
-------------------------
If you are new to Mercurial, you should start with the `official guide <https://www.mercurial-scm.org/guide>`__.
Then, move on to `Mercurial basics <https://developer.mozilla.org/docs/Mercurial_basics>`__ and the `version control tool docs <https://mozilla-version-control-tools.readthedocs.io/en/latest/hgmozilla/>`__ for Mozilla-centric Mercurial information.
More documentation about mercurial
----------------------------------
https://developer.mozilla.org/docs/Mozilla/Developer_guide/Source_Code/Mercurial
https://developer.mozilla.org/docs/Mozilla/Mercurial
https://developer.mozilla.org/docs/Mozilla/Mercurial/Basics
Then, move on to the `version control tool docs <https://mozilla-version-control-tools.readthedocs.io/en/latest/hgmozilla/>`__ for Mozilla-centric Mercurial information.

4
docs/setup/building_with_debug_symbols.rst
View File

@ -7,7 +7,7 @@ Building with Debug Symbols
By default, a release build of Firefox will not generate debug symbols
suitable for debugging or post-processing into the
`breakpad <https://developer.mozilla.org/docs/Mozilla/Projects/Crash_reporting>`__ symbol format. Use the
:ref:`breakpad <Crash reporting>` symbol format. Use the
following :ref:`mozconfig <Configuring Build Options>` settings
to do a build with symbols:
@ -36,7 +36,7 @@ Breakpad symbol files
~~~~~~~~~~~~~~~~~~~~~
After the build is complete, run the following command to generate an
archive of `Breakpad <https://developer.mozilla.org/docs/Mozilla/Projects/Crash_reporting>`__ symbol files:
archive of :ref:`Breakpad <Crash reporting>` symbol files:
.. code:: bash

10
docs/setup/linux_build.rst
View File

@ -58,7 +58,7 @@ You’re ready; now we can tie it all together. In your terminal:
If you are not working on the C/C++ files you can also opt for
:ref:`Artifact Builds <Understanding Artifact Builds>`
which are much faster. To enable artifact build set up a
`.mozconfig <https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Build_Instructions/Configuring_Build_Options>`_
:ref:`mozconfig <Configuring Build Options>`
file with the following options:
.. code-block:: shell
@ -71,7 +71,7 @@ file with the following options:
mk_add_options MOZ_OBJDIR=./objdir-frontend
If you plan to walk through code with a debugger, set up a
`.mozconfig <https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Build_Instructions/Configuring_Build_Options>`_
:ref:`.mozconfig <Configuring Build Options>`
file with the following options:
.. code-block:: shell
@ -230,8 +230,7 @@ Hoye <mailto:mhoye@mozilla.com>` directly for help. Please include the
error message and some details about your operating system.
If you have already checked out the source code via Mercurial or Git you
can also use `mach <https://developer.mozilla.org/en-US/docs/Developer_Guide/mach>`_ with the
bootstrap command:
can also use :ref:`mach` with the bootstrap command:
.. code-block:: shell
@ -280,5 +279,4 @@ More info
---------
The above bootstrap script supports popular Linux distributions. If it
doesn't work for you, see `Linux build
prerequisites <https://developer.mozilla.org/docs/Mozilla/Developer_guide/Build_Instructions/Linux_Prerequisites>`_ for more.
doesn't work for you, see :ref:`Linux build prerequisites <Building Firefox On Linux>` for more.

3
docs/setup/mach.rst
View File

@ -88,6 +88,8 @@ Check out the :ref:`linting` and :ref:`Static analysis` tools:
$ ./mach lint
$ ./mach static-analysis
.. _mach_and_mozconfigs:
mach and mozconfigs
~~~~~~~~~~~~~~~~~~~
@ -119,6 +121,7 @@ Here are some examples:
$ cd objdir-firefox
$ mach build
.. _Adding_mach_to_your_shell:
Adding mach to your shell's search path
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

3
docs/setup/windows_build.rst
View File

@ -402,8 +402,7 @@ Command prompt tips and caveats
Common problems, hints, and restrictions
----------------------------------------
- `Debugging Firefox on Windows
FAQ <https://developer.mozilla.org/docs/Mozilla/Debugging/Debugging_Mozilla_on_Windows_FAQ>`_:
- :ref:`Debugging Firefox on Windows FAQ <Debugging On Windows>`_:
Tips on how to debug Mozilla on Windows.
- Your installed MozillaBuild may be too old. The build system may
assume you have new features and bugfixes that are only present in

4
dom/docs/workersAndStorage/CodeStyle.rst
View File

@ -23,7 +23,7 @@ This code style currently applies to the components living in the following dire
* ``dom/workers``
In the long-term, the code is intended to use the
`Mozilla Coding Style <https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Coding_Style>`_,
:ref:`Mozilla Coding Style <Coding style>`,
which references the `Google C++ Coding Style <https://google.github.io/styleguide/cppguide.html>`_.
However, large parts of the code were written before rules and in particular
@ -62,7 +62,7 @@ Deviations from the Mozilla C++ Coding Style
| Mozilla style | Prevalent WAS style | Deviation scope | Evolution |
+========================================================================================================+============================================================================================+=================+=====================================================================================+
| `We prefer using "static", instead of anonymous C++ namespaces. | Place all symbols that should have internal linkage in a single anonymous | All files | Unclear. The recommendation in the Mozilla code style says this might change in the |
| <https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Coding_Style#Anonymous_namespaces>`_ | namespace block at the top of an implementation file, rather than declarating them static. | | future depending on debugger support, so this deviation might become obsolete. |
| | namespace block at the top of an implementation file, rather than declarating them static. | | future depending on debugger support, so this deviation might become obsolete. |
| | | | |
+--------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+-----------------+-------------------------------------------------------------------------------------+
| `All parameters passed by lvalue reference must be labeled const. [...] Input parameters may be const | Non-const reference parameters may be used. | All files | Unclear. Maybe at least restrict the use of non-const reference parameters to |

2
js/src/doc/build.rst
View File

@ -11,7 +11,7 @@ computer:**
This guide shows you how to build SpiderMonkey using ``mach``, which is Mozilla's multipurpose build tool.
For builds using ``configure && make``, and translations into other languages see
`these instructions on MDN <https://developer.mozilla.org/en-US/docs/Mozilla/Projects/SpiderMonkey/Build_Documentation>`__.
:ref:`these instructions on MDN <Building SpiderMonkey>`.
These instructions assume you have a clone of `mozilla-central` and are interested
in building the JS shell.

2
mobile/android/docs/geckoview/contributor/native-debugging.rst
View File

@ -211,7 +211,7 @@ Managing more debug tabs may require different approaches.
Using Android Studio on Windows
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can now use `artifact builds <https://developer.mozilla.org/docs/Mozilla/Developer_guide/Build_Instructions/Artifact_builds>`_
You can now use :ref:`artifact builds <Understanding Artifact Builds>`
mode on `MozillaBuild environment <https://wiki.mozilla.org/MozillaBuild>`_ even if you are
not using WSL. If you want to debug GeckoView using Android Studio on
Windows, you have to set an additional environment variable via the

2
taskcluster/docs/using-the-mozilla-symbol-server.rst
View File

@ -85,6 +85,8 @@ should be similar to:
SYMCHK: FAILED files = 4
SYMCHK: PASSED + IGNORED files = 179
.. _Downloading_symbols_on_Linux_Mac_OS_X:
Downloading symbols on Linux / Mac OS X
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

8
toolkit/components/telemetry/docs/internals/mentored-bugs.rst
View File

@ -11,14 +11,14 @@ Post it as a comment and add relevant steps in part 3.
To help Mozilla out with this bug, here's the steps:
1. Comment here on the bug that you want to volunteer to help. I (or someone else) will assign it to you.
2. [Download and build the Firefox source code](https://developer.mozilla.org/docs/Mozilla/Developer_guide/Build_Instructions/Simple_Firefox_build)
* If you have any problems, please ask on [Riot/Matrix](https://chat.mozilla.org/#/room/#introduction:mozilla.org) in the `introduction` channel. They're there to help you get started.
2. [Download and build the Firefox source code](https://firefox-source-docs.mozilla.org/contributing/contribution_quickref.html)
* If you have any problems, please ask on [Element/Matrix](https://chat.mozilla.org/#/room/#introduction:mozilla.org) in the `introduction` channel. They're there to help you get started.
* You can also read the [Developer Guide](https://developer.mozilla.org/docs/Mozilla/Developer_guide/Introduction), which has answers to most development questions:
3. Start working on this bug. <SPECIFIC STEPS RELEVANT TO THIS BUG>
* If you have any problems with this bug, please comment on this bug and set the needinfo flag for me. Also, you can find me and my teammates on the #telemetry channel on [IRC](https://wiki.mozilla.org/Irc) most hours of most days.
* If you have any problems with this bug, please comment on this bug and set the needinfo flag for me. Also, you can find me and my teammates on the #telemetry channel on [Element/Matrix](https://chat.mozilla.org/#/room/#telemetry:mozilla.org) most hours of most days.
4. Build your change with `mach build` and test your change with `mach test toolkit/components/telemetry/tests/`. Also check your changes for adherence to our style guidelines by using `mach lint`
5. Submit the patch (including an automated test, if applicable) for review. Mark me as a reviewer so I'll get an email to come look at your code.
* [How to Submit a Patch](https://developer.mozilla.org/docs/Mozilla/Developer_guide/How_to_Submit_a_Patch)
* [How to Submit a Patch](https://firefox-source-docs.mozilla.org/contributing/how_to_submit_a_patch.html)
6. After a series of reviews and changes to your patch, I'll mark it for checkin or push it to autoland. Your code will soon be shipping to Firefox users worldwide!
7. ...now you get to think about what kind of bug you'd like to work on next. Let me know what you're interested in and I can help you find your next contribution.

2
toolkit/components/telemetry/docs/internals/review.rst
View File

@ -50,7 +50,7 @@ Considerations for all changes
- Firefox Desktop:
- `The Mozilla coding style <https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Coding_Style>`_
- :ref:`The Mozilla coding style <Coding style>`
- `The toolkit code review guidelines <https://wiki.mozilla.org/Toolkit/Code_Review>`_
- Mobile:

3
tools/code-coverage/docs/index.rst
View File

@ -127,8 +127,7 @@ browser/config/mozconfigs/linux64/code-coverage,
browser/config/mozconfigs/win64/code-coverage,
browser/config/mozconfigs/macosx64/code-coverage.
Make sure you are not running with `artifact
builds <https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Build_Instructions/Artifact_builds>`__
Make sure you are not running with :ref:`artifact build <Understanding Artifact Builds>`
enabled, as it can prevent coverage artifacts from being created.
You can then create your build as usual. Once the build is complete, you

5
tools/sanitizer/docs/asan.rst
View File

@ -90,7 +90,7 @@ On Windows, ASan is supported only in 64-bit builds.
Run ``mach bootstrap`` to get an updated clang-cl in your
``~/.mozbuild`` directory, then use the following
`mozconfig <https://wiki.developer.mozilla.org/docs/Configuring_Build_Options>`__:
:ref:`mozconfig <Configuring Build Options>`:
::
@ -108,8 +108,7 @@ Run ``mach bootstrap`` to get an updated clang-cl in your
export MOZ_CLANG_RT_ASAN_LIB_PATH="${CLANG_LIB_DIR}/clang_rt.asan_dynamic-x86_64.dll"
export LIB=$LIB:$CLANG_LIB_DIR
If you want to use a different LLVM (see the `clang-cl
instructions <https://wiki.developer.mozilla.org/docs/Mozilla/Developer_guide/Build_Instructions/Building_Firefox_on_Windows_with_clang-cl>`__),
If you want to use a different LLVM (see the :ref:`clang-cl instructions <Building Firefox On Windows>`),
alter CLANG_LIB_DIR as appropriate.
If you launch an ASan build under WinDbg, you may see spurious

5
tools/sanitizer/docs/memory_sanitizer.rst
View File

@ -55,9 +55,8 @@ Building Firefox
Getting the source
^^^^^^^^^^^^^^^^^^
If you don't have a source code repository clone yet, you need to `get
yourself a clone of
Mozilla-central <https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Source_Code/Mercurial>`__.
If you don't have a source code repository clone yet, you need to :ref:`get
yourself a clone of Mozilla-central <Mercurial Overview>`.
Adjusting the build configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^