From 3c813005a134cec12fd2b4913d09b4e033074eb8 Mon Sep 17 00:00:00 2001 From: Sylvestre Ledru Date: Tue, 29 Sep 2020 18:48:17 +0000 Subject: [PATCH] Bug 1667831 - doc: fix more warnings r=firefox-source-docs-reviewers,ahal DONTBUILD Differential Revision: https://phabricator.services.mozilla.com/D91642 --- docs/code-quality/index.rst | 30 ++++++++++----------- docs/code-quality/lint/linters/perfdocs.rst | 4 +-- docs/setup/macos_build.rst | 28 +++++++++---------- docs/setup/windows_build.rst | 10 +++---- 4 files changed, 36 insertions(+), 36 deletions(-) diff --git a/docs/code-quality/index.rst b/docs/code-quality/index.rst index 74b45da4a2ba..97939211dfa7 100644 --- a/docs/code-quality/index.rst +++ b/docs/code-quality/index.rst @@ -30,17 +30,17 @@ In this document, we try to list these all tools. - * - Clang-Tidy - Yes - - `bug 712350 `_ + - `bug 712350 `__ - :ref:`Static analysis ` - https://clang.llvm.org/extra/clang-tidy/checks/list.html * - Clang analyzer - - - `bug 712350 `_ + - `bug 712350 `__ - - https://clang-analyzer.llvm.org/ * - Coverity - - - `bug 1230156 `_ + - `bug 1230156 `__ - - * - cpp virtual final @@ -50,12 +50,12 @@ In this document, we try to list these all tools. - * - Semmle/LGTM - - - `bug 1458117 `_ + - `bug 1458117 `__ - - * - clang-format - Yes - - `bug 1188202 `_ + - `bug 1188202 `__ - :ref:`Formatting C++ Code With clang-format` - https://clang.llvm.org/docs/ClangFormat.html @@ -70,17 +70,17 @@ In this document, we try to list these all tools. - Upstream * - Eslint - Yes - - `bug 1229856 `_ + - `bug 1229856 `__ - :ref:`ESLint` - https://eslint.org/ * - Mozilla ESLint - - - `bug 1229856 `_ + - `bug 1229856 `__ - :ref:`Mozilla ESLint Plugin` - * - Prettier - Yes - - `bug 1558517 `_ + - `bug 1558517 `__ - :ref:`JavaScript Coding style` - https://prettier.io/ @@ -97,22 +97,22 @@ In this document, we try to list these all tools. - Upstream * - Flake8 - Yes (with `autopep8 `_) - - `bug 1155970 `_ + - `bug 1155970 `__ - :ref:`Flake8` - http://flake8.pycqa.org/ * - black - Yes - - `bug 1555560 `_ + - `bug 1555560 `__ - :ref:`black` - https://black.readthedocs.io/en/stable * - pylint - - - `bug 1623024 `_ + - `bug 1623024 `__ - :ref:`pylint` - https://www.pylint.org/ * - Python 2/3 compatibility check - - - `bug 1496527 `_ + - `bug 1496527 `__ - :ref:`Python 2/3 compatibility check` - @@ -128,12 +128,12 @@ In this document, we try to list these all tools. - Upstream * - Rustfmt - Yes - - `bug 1454764 `_ + - `bug 1454764 `__ - :ref:`Rustfmt` - https://github.com/rust-lang/rustfmt * - Clippy - - - `bug 1361342 `_ + - `bug 1361342 `__ - :ref:`clippy` - https://github.com/rust-lang/rust-clippy @@ -148,7 +148,7 @@ In this document, we try to list these all tools. - Upstream * - Infer - - - `bug 1175203 `_ + - `bug 1175203 `__ - - https://github.com/facebook/infer diff --git a/docs/code-quality/lint/linters/perfdocs.rst b/docs/code-quality/lint/linters/perfdocs.rst index f7e548139e00..851c920987da 100644 --- a/docs/code-quality/lint/linters/perfdocs.rst +++ b/docs/code-quality/lint/linters/perfdocs.rst @@ -80,5 +80,5 @@ Note that there needs to be a FrameworkGatherer implemented for the framework be Sources ------- -* `Configuration `_ -* `Source `_ +* `Configuration `__ +* `Source `__ diff --git a/docs/setup/macos_build.rst b/docs/setup/macos_build.rst index d0760955a2a1..4242a3f11ae9 100644 --- a/docs/setup/macos_build.rst +++ b/docs/setup/macos_build.rst @@ -27,8 +27,8 @@ You will need administrator permissions on your machine to install these prerequisites. (You can verify that you have these permissions in System Preferences -> Users & Groups.) -See `1.1 Install Xcode and Xcode command line tools <#xcode>`_ and `1.2 -Get the local macOS SDK <#macossdk>`_ for more information on how to +See :ref:`1.1 Install Xcode and Xcode command line tools ` and :ref:`1.2 +Get the local macOS SDK ` for more information on how to install these prerequisites. .. rubric:: Getting the source @@ -46,8 +46,8 @@ that will do the rest: # download the bootstrap script curl https://hg.mozilla.org/mozilla-central/raw-file/default/python/mozboot/bin/bootstrap.py -o bootstrap.py -If you don't have Python 3.6 or later or Mercurial installed, see `2.1a Install -dependencies via Homebrew <#install-via-homebrew>`_ for more information on how +If you don't have Python 3.6 or later or Mercurial installed, see :ref:`2.1a Install +dependencies via Homebrew <#install-via-homebrew>` for more information on how to do so. Then in your terminal from above start the bootstrapper like this: .. code-block:: shell @@ -62,7 +62,7 @@ source code. If you prefer to work with git, use this command instead: python3 bootstrap.py --vcs=git If you don't have `Homebrew `_ or -`Ports `_ installed - software package +`Ports `__ installed - software package managers that will let us install some programs we'll need - you'll be asked to pick one. Either will work, but most Mozilla developers use Homebrew. @@ -130,20 +130,20 @@ You first need to install Xcode, for which you have two options but both require you to sign in with an Apple ID: - From Apple Developer Download page - `direct - link `_. Install the + link `__. Install the latest **release** (non-beta) version of Xcode, open ``Xcode.xip``, and then **before** **running the extracted Xcode.app, move it from the download folder to /Applications**. (Running it from another location may screw up various build paths, homebrew builds, etc. Fix by running ``sudo xcode-select -switch /Applications/Xcode.app`` ) - From the Mac App Store - `direct - link `_. + link `__. Open /Applications/Xcode.app and let it do its initial first run and setup stuff. Install the Xcode command line tools by -running \ ``xcode-select --install`` in your terminal. +running ``xcode-select --install`` in your terminal. .. _macossdk: @@ -159,7 +159,7 @@ other SDKs and that's why we recommend this specific version. To get the 10.11 SDK, first download Xcode 7.3.1 from the `More Downloads for Apple -Developers `_ page. Once +Developers `__ page. Once downloaded, mount the .dmg file. Then in the Terminal run the following: .. code-block:: shell @@ -186,7 +186,7 @@ whatever package manager you prefer. 2.1a Install dependencies via Homebrew ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -`Homebrew `_ is "the missing package manager for +`Homebrew `__ is "the missing package manager for macOS." It provides a simple command-line interface to install packages, typically by compiling them from source. @@ -402,13 +402,13 @@ Software requirements - **Development Environment:** Xcode. You can obtain from the App Store. - **Package Management:** Either - *`MacPorts `_* or Homebrew. + *`MacPorts `__* or Homebrew. These options are specific to Mozilla builds for macOS. For a more general overview of build options and the ``mozconfig`` file, see :ref:`Configuring Build Options`. For specific information on configuring to build a universal binary, see -`Mac OS X Universal Binaries `_. +`Mac OS X Universal Binaries `__. - **Compiler:** Firefox releases are no longer built with gcc-4.8 or earlier. A recent copy of clang is needed. @@ -420,7 +420,7 @@ specific information on configuring to build a universal binary, see (Xcode 6.4 is based on pre-release of clang 3.6, that doesn't match to requirement.) - Following the instructions in the `clang - website `_ for + website `__ for information on how to get it. - Using some of the package managers (see above). @@ -436,7 +436,7 @@ are intended to be added to your ``mozconfig`` file. Selecting an SDK with this option overrides the default headers and libraries in ``/usr/include``, ``/usr/lib``, and ``/System/Library``. Mac macOS SDKs are installed in ``/Developer/SDKs`` during the `Xcode - installation <#Software_Requirements>`_ by selecting the **Cross + installation <#Software_Requirements>` by selecting the **Cross Development** category in the installer’s **Customize** screen. .. code-block:: shell diff --git a/docs/setup/windows_build.rst b/docs/setup/windows_build.rst index 42395741ba8b..87b59dec7ec2 100644 --- a/docs/setup/windows_build.rst +++ b/docs/setup/windows_build.rst @@ -87,7 +87,7 @@ MozillaBuild ^^^^^^^^^^^^ Finally, download the `MozillaBuild -Package `_ +Package `__ from Mozilla. Accept the default settings, in particular the default installation directory: ``c:\mozilla-build\``. On some versions of Windows an error dialog will give you the option to ‘reinstall with the @@ -253,7 +253,7 @@ successfully. There are notes on these software requirements below. android-emulator", or run talos tests locally, you should install it for building psutil. #. Download and install the - `MozillaBuild `_ + `MozillaBuild `__ package, containing additional build tools. If you have Cygwin installed, read the note in the tips section. If you see a Windows error dialog giving you the option to re-install with the 'correct @@ -301,8 +301,8 @@ Installing Visual Studio in a different language than the system can cause issue contains spaces. It is strongly recommended that you accept the default settings for all installation locations. -MozillaBuild -~~~~~~~~~~~~ +MozillaBuild package +~~~~~~~~~~~~~~~~~~~~ The MozillaBuild package contains other software prerequisites necessary for building Mozilla, including the MSYS build environment, @@ -402,7 +402,7 @@ Command prompt tips and caveats Common problems, hints, and restrictions ---------------------------------------- -- :ref:`Debugging Firefox on Windows FAQ `_: +- :ref:`Debugging Firefox on Windows FAQ `: 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