From 3b298e6ddde2a988a82039db9ce45eaf66d89a3f Mon Sep 17 00:00:00 2001 From: Paul Barker Date: Tue, 22 Dec 2020 15:30:32 +0000 Subject: documentation: Use https links where possible (From yocto-docs rev: cd4c5e9928866f910ac97cf3e0612e6245da30bd) Signed-off-by: Paul Barker Signed-off-by: Richard Purdie --- documentation/README | 8 ++-- documentation/boilerplate.rst | 2 +- documentation/brief-yoctoprojectqs/index.rst | 2 +- documentation/dev-manual/common-tasks.rst | 2 +- .../overview-manual/development-environment.rst | 22 +++++------ documentation/overview-manual/yp-intro.rst | 4 +- documentation/profile-manual/usage.rst | 44 +++++++++++----------- documentation/ref-manual/classes.rst | 4 +- documentation/ref-manual/faq.rst | 6 +-- documentation/ref-manual/images.rst | 4 +- documentation/ref-manual/kickstart.rst | 4 +- documentation/ref-manual/migration-2.1.rst | 2 +- documentation/ref-manual/migration-2.3.rst | 2 +- documentation/ref-manual/migration-2.7.rst | 2 +- documentation/ref-manual/qa-checks.rst | 2 +- documentation/ref-manual/resources.rst | 4 +- documentation/ref-manual/variables.rst | 20 +++++----- documentation/sdk-manual/intro.rst | 2 +- documentation/toaster-manual/reference.rst | 4 +- 19 files changed, 70 insertions(+), 70 deletions(-) (limited to 'documentation') diff --git a/documentation/README b/documentation/README index b0a3cb1dc0..be03bb119a 100644 --- a/documentation/README +++ b/documentation/README @@ -2,7 +2,7 @@ documentation ============= This is the directory that contains the Yocto Project documentation. The Yocto -Project source repositories at http://git.yoctoproject.org/cgit.cgi have two +Project source repositories at https://git.yoctoproject.org/cgit.cgi have two instances of the "documentation" directory. You should understand each of these instances. @@ -47,12 +47,12 @@ Folders exist for individual manuals as follows: Each folder is self-contained regarding content and figures. If you want to find HTML versions of the Yocto Project manuals on the web, -go to http://www.yoctoproject.org and click on the "Documentation" tab. From +go to https://www.yoctoproject.org and click on the "Documentation" tab. From there you have access to archived documentation from previous releases, current documentation for the latest release, and "Docs in Progress" for the release currently being developed. -In general, the Yocto Project site (http://www.yoctoproject.org) is a great +In general, the Yocto Project site (https://www.yoctoproject.org) is a great reference for both information and downloads. poky.yaml @@ -228,7 +228,7 @@ content: Variables can be nested, like it was the case for DocBook: - YOCTO_HOME_URL : "http://www.yoctoproject.org" + YOCTO_HOME_URL : "https://www.yoctoproject.org" YOCTO_DOCS_URL : "&YOCTO_HOME_URL;/docs" Note directive diff --git a/documentation/boilerplate.rst b/documentation/boilerplate.rst index ddffdac242..2ad60eb8b9 100644 --- a/documentation/boilerplate.rst +++ b/documentation/boilerplate.rst @@ -8,7 +8,7 @@ Permission is granted to copy, distribute and/or modify this document under the terms of the `Creative Commons Attribution-Share Alike 2.0 UK: England & Wales -`_ as published by Creative +`_ as published by Creative Commons. To report any inaccuracies or problems with this (or any other Yocto Project) diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst index f077ee843d..63083cb13d 100644 --- a/documentation/brief-yoctoprojectqs/index.rst +++ b/documentation/brief-yoctoprojectqs/index.rst @@ -397,7 +397,7 @@ information including the website, wiki pages, and user manuals: Development Community into which you can tap. - **Developer Screencast:** The `Getting Started with the Yocto Project - - New Developer Screencast Tutorial `__ + New Developer Screencast Tutorial `__ provides a 30-minute video created for users unfamiliar with the Yocto Project but familiar with Linux build hosts. While this screencast is somewhat dated, the introductory and fundamental diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 30761c3c60..e1dee8ecdd 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst @@ -6043,7 +6043,7 @@ the Internet: Botnet - *"*\ `Security Issues for Embedded - Devices `__\ *"* + Devices `__\ *"* by Jake Edge When securing your image is of concern, there are steps, tools, and diff --git a/documentation/overview-manual/development-environment.rst b/documentation/overview-manual/development-environment.rst index 9a2997d9fc..011a479578 100644 --- a/documentation/overview-manual/development-environment.rst +++ b/documentation/overview-manual/development-environment.rst @@ -40,7 +40,7 @@ project is the Windows family of operating systems developed by Microsoft Corporation. Wikipedia has a good historical description of the Open Source -Philosophy `here `__. You can +Philosophy `here `__. You can also find helpful information on how to participate in the Linux Community `here `__. @@ -291,7 +291,7 @@ While each development environment is unique, there are some best practices or methods that help development run smoothly. The following list describes some of these practices. For more information about Git workflows, see the workflow topics in the `Git Community -Book `__. +Book `__. - *Make Small Changes:* It is best to keep the changes you commit small as compared to bundling many disparate changes into a single commit. @@ -368,12 +368,12 @@ commands. .. note:: - For more information on Git, see - http://git-scm.com/documentation. + https://git-scm.com/documentation. - If you need to download Git, it is recommended that you add Git to your system through your distribution's "software store" (e.g. for Ubuntu, use the Ubuntu Software feature). For the Git download - page, see http://git-scm.com/download. + page, see https://git-scm.com/download. - For information beyond the introductory nature in this section, see the ":ref:`dev-manual/start:locating yocto project source files`" @@ -507,7 +507,7 @@ you can manage with a small set of basic operations and workflows once you understand the basic philosophy behind Git. You do not have to be an expert in Git to be functional. A good place to look for instruction on a minimal set of Git commands is -`here `__. +`here `__. The following list of Git commands briefly describes some basic Git operations as a way to get started. As with any set of commands, this @@ -614,10 +614,10 @@ and Free Software has an interesting history. If you are interested in this history, you can find basic information here: - `Open source license - history `__ + history `__ - `Free software license - history `__ + history `__ In general, the Yocto Project is broadly licensed under the Massachusetts Institute of Technology (MIT) License. MIT licensing @@ -626,9 +626,9 @@ license is distributed with that software. MIT is also compatible with the GNU General Public License (GPL). Patches to the Yocto Project follow the upstream licensing scheme. You can find information on the MIT license -`here `__. You can +`here `__. You can find information on the GNU GPL -`here `__. +`here `__. When you build an image using the Yocto Project, the build process uses a known list of licenses to ensure compliance. You can find this list in @@ -646,11 +646,11 @@ the developer to resolve potential licensing issues. The base list of licenses used by the build process is a combination of the Software Package Data Exchange (SPDX) list and the Open Source -Initiative (OSI) projects. `SPDX Group `__ is a working +Initiative (OSI) projects. `SPDX Group `__ is a working group of the Linux Foundation that maintains a specification for a standard format for communicating the components, licenses, and copyrights associated with a software package. -`OSI `__ is a corporation dedicated to the Open +`OSI `__ is a corporation dedicated to the Open Source Definition and the effort for reviewing and approving licenses that conform to the Open Source Definition (OSD). diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst index 4da55a83d5..0ec7e2b961 100644 --- a/documentation/overview-manual/yp-intro.rst +++ b/documentation/overview-manual/yp-intro.rst @@ -368,7 +368,7 @@ activities using the Yocto Project: - *Patchwork:* `Patchwork `__ is a fork of a project originally started by - `OzLabs `__. The project is a web-based tracking + `OzLabs `__. The project is a web-based tracking system designed to streamline the process of bringing contributions into a project. The Yocto Project uses Patchwork as an organizational tool to handle patches, which number in the thousands for every @@ -400,7 +400,7 @@ activities using the Yocto Project: Historically, cross-prelink is a variant of prelink, which was conceived by `Jakub - Jelínek `__ a number of + Jelínek `__ a number of years ago. Both prelink and cross-prelink are maintained in the same repository albeit on separate branches. By providing an emulated runtime dynamic linker (i.e. ``glibc``-derived ``ld.so`` emulation), diff --git a/documentation/profile-manual/usage.rst b/documentation/profile-manual/usage.rst index 0da4084430..b401cf9040 100644 --- a/documentation/profile-manual/usage.rst +++ b/documentation/profile-manual/usage.rst @@ -39,7 +39,7 @@ other tools when it seems useful to do so. The coverage below details some of the most common ways you'll likely want to apply the tool; full documentation can be found either within the tool itself or in the man pages at -`perf(1) `__. +`perf(1) `__. Perf Setup ---------- @@ -860,7 +860,7 @@ the right kind of trace data, higher-level profiling-type summaries can be derived from it. Documentation on using the `'perf script' python -binding `__. +binding `__. System-Wide Tracing and Profiling ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1136,23 +1136,23 @@ Perf Documentation Online versions of the man pages for the commands discussed in this section can be found here: -- The `'perf stat' manpage `__. +- The `'perf stat' manpage `__. - The `'perf record' - manpage `__. + manpage `__. - The `'perf report' - manpage `__. + manpage `__. -- The `'perf probe' manpage `__. +- The `'perf probe' manpage `__. - The `'perf script' - manpage `__. + manpage `__. - Documentation on using the `'perf script' python - binding `__. + binding `__. -- The top-level `perf(1) manpage `__. +- The top-level `perf(1) manpage `__. Normally, you should be able to invoke the man pages via perf itself e.g. 'perf help' or 'perf help record'. @@ -1718,7 +1718,7 @@ events': The tool is pretty self-explanatory, but for more detailed information on navigating through the data, see the `kernelshark -website `__. +website `__. ftrace Documentation -------------------- @@ -1736,19 +1736,19 @@ Documentation directory: :: There is a nice series of articles on using ftrace and trace-cmd at LWN: - `Debugging the kernel using Ftrace - part - 1 `__ + 1 `__ - `Debugging the kernel using Ftrace - part - 2 `__ + 2 `__ - `Secrets of the Ftrace function - tracer `__ + tracer `__ - `trace-cmd: A front-end for Ftrace `__ There's more detailed documentation kernelshark usage here: -`KernelShark `__ +`KernelShark `__ An amusing yet useful README (a tracing mini-HOWTO) can be found in ``/sys/kernel/debug/tracing/README``. @@ -1763,7 +1763,7 @@ gather/print/aggregate data extracted from the context they end up being invoked under. For example, this probe from the `SystemTap -tutorial `__ simply prints a +tutorial `__ simply prints a line every time any process on the system open()s a file. For each line, it prints the executable name of the program that opened the file, along with its PID, and the name of the file it opened (or tried to open), @@ -1936,11 +1936,11 @@ systemtap Documentation ----------------------- The SystemTap language reference can be found here: `SystemTap Language -Reference `__ +Reference `__ Links to other SystemTap documents, tutorials, and examples can be found here: `SystemTap documentation -page `__ +page `__ Sysprof ======= @@ -2214,7 +2214,7 @@ developers who are working in a Linux environment and are interested in efficient software tracing. For information on LTTng in general, visit the `LTTng -Project `__ site. You can find a "Getting +Project `__ site. You can find a "Getting Started" link on this site that takes you to an LTTng Quick Start. blktrace @@ -2365,7 +2365,7 @@ first part of the filenames: :: The report shows each event that was found in the blktrace data, along with a summary of the overall block I/O traffic during the run. You can look at the -`blkparse `__ manpage to learn the +`blkparse `__ manpage to learn the meaning of each field displayed in the trace listing. Live Mode @@ -2564,11 +2564,11 @@ blktrace Documentation Online versions of the man pages for the commands discussed in this section can be found here: -- http://linux.die.net/man/8/blktrace +- https://linux.die.net/man/8/blktrace -- http://linux.die.net/man/1/blkparse +- https://linux.die.net/man/1/blkparse -- http://linux.die.net/man/8/btrace +- https://linux.die.net/man/8/btrace The above manpages, along with manpages for the other blktrace utilities (btt, blkiomon, etc) can be found in the /doc directory of the blktrace diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index d049ca7018..a152dcac77 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst @@ -278,7 +278,7 @@ The ``ccache`` class enables the C/C++ Compiler Cache for the build. This class is used to give a minor performance boost during the build. However, using the class can lead to unexpected side-effects. Thus, it is recommended that you do not use this class. See -http://ccache.samba.org/ for information on the C/C++ Compiler +https://ccache.samba.org/ for information on the C/C++ Compiler Cache. .. _ref-classes-chrpath: @@ -2581,7 +2581,7 @@ the :term:`SYSTEMD_BOOT_CFG`, :term:`SYSTEMD_BOOT_TIMEOUT` variables. You can also see the `Systemd-boot -documentation `__ +documentation `__ for more information. .. _ref-classes-terminal: diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst index f67c53824b..34b26ee3ef 100644 --- a/documentation/ref-manual/faq.rst +++ b/documentation/ref-manual/faq.rst @@ -55,9 +55,9 @@ Yocto Project is fairly straightforward. **Q:** Are there any products built using the OpenEmbedded build system? **A:** The software running on the `Vernier -LabQuest `__ is built using the +LabQuest `__ is built using the OpenEmbedded build system. See the `Vernier -LabQuest `__ website +LabQuest `__ website for more information. There are a number of pre-production devices using the OpenEmbedded build system and the Yocto Project team announces them as soon as they are released. @@ -273,7 +273,7 @@ OpenEmbedded build system to use its internally built toolchain (i.e. particular, "external-\*" refers to external toolchains. One example is the Sourcery G++ Toolchain. The support for this toolchain resides in the separate ``meta-sourcery`` layer at -http://github.com/MentorEmbedded/meta-sourcery/. +https://github.com/MentorEmbedded/meta-sourcery/. In addition to the toolchain configuration, you also need a corresponding toolchain recipe file. This recipe file needs to package diff --git a/documentation/ref-manual/images.rst b/documentation/ref-manual/images.rst index 5e9374eae7..cf5cc1109f 100644 --- a/documentation/ref-manual/images.rst +++ b/documentation/ref-manual/images.rst @@ -37,9 +37,9 @@ Following is a list of supported recipes: all the pieces required to run builds using the build system as well as the build system itself. You can boot and run the image using either the `VMware - Player `__ or + Player `__ or `VMware - Workstation `__. + Workstation `__. For more information on this image, see the :yocto_home:`Build Appliance ` page on the Yocto Project website. diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst index bb9c0460f3..472820f165 100644 --- a/documentation/ref-manual/kickstart.rst +++ b/documentation/ref-manual/kickstart.rst @@ -24,7 +24,7 @@ The information lists the commands, their syntax, and meanings. Kickstart commands are based on the Fedora kickstart versions but with modifications to reflect Wic capabilities. You can see the original documentation for those commands at the following link: -http://pykickstart.readthedocs.io/en/latest/kickstart-docs.html +https://pykickstart.readthedocs.io/en/latest/kickstart-docs.html Command: part or partition ========================== @@ -164,7 +164,7 @@ the ``part`` and ``partition`` commands: - ``--part-type``: This option is a Wic-specific option that specifies the partition type globally unique identifier (GUID) for GPT partitions. You can find the list of partition type GUIDs at - http://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs. + https://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs. - ``--use-uuid``: This option is a Wic-specific option that causes Wic to generate a random GUID for the partition. The generated diff --git a/documentation/ref-manual/migration-2.1.rst b/documentation/ref-manual/migration-2.1.rst index e8b3ada264..861d04861b 100644 --- a/documentation/ref-manual/migration-2.1.rst +++ b/documentation/ref-manual/migration-2.1.rst @@ -89,7 +89,7 @@ package-specific nesting should be done by the package itself. Finally, having ``libexecdir`` change between recipes makes it very difficult for different recipes to invoke binaries that have been installed into ``libexecdir``. The Filesystem Hierarchy Standard (i.e. -http://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch04s07.html) now +https://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch04s07.html) now recognizes the use of ``${prefix}/libexec/``, giving distributions the choice between ``${prefix}/lib`` or ``${prefix}/libexec`` without breaking FHS. diff --git a/documentation/ref-manual/migration-2.3.rst b/documentation/ref-manual/migration-2.3.rst index a52178b0c4..04b11daa7d 100644 --- a/documentation/ref-manual/migration-2.3.rst +++ b/documentation/ref-manual/migration-2.3.rst @@ -274,7 +274,7 @@ The following package management changes took place: fixed. For more information, see the `DNF - Documentation `__. + Documentation `__. - Rpm 5.x is replaced with Rpm 4.x. This is done for two major reasons: diff --git a/documentation/ref-manual/migration-2.7.rst b/documentation/ref-manual/migration-2.7.rst index 7e628fc3ec..5af5947fff 100644 --- a/documentation/ref-manual/migration-2.7.rst +++ b/documentation/ref-manual/migration-2.7.rst @@ -159,7 +159,7 @@ The following miscellaneous changes occurred: from the top-level ``scripts`` directory. - Perl now builds for the target using - `perl-cross `_ for better + `perl-cross `_ for better maintainability and improved build performance. This change should not present any problems unless you have heavily customized your Perl recipe. diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst index 54977dcb21..6cb767d934 100644 --- a/documentation/ref-manual/qa-checks.rst +++ b/documentation/ref-manual/qa-checks.rst @@ -227,7 +227,7 @@ Errors and Warnings CFLAGS_append = " -fPIC " For more information on text relocations at runtime, see - http://www.akkadia.org/drepper/textrelocs.html. + https://www.akkadia.org/drepper/textrelocs.html.   .. _qa-check-ldflags: diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst index 2c49c4e87c..7554164d11 100644 --- a/documentation/ref-manual/resources.rst +++ b/documentation/ref-manual/resources.rst @@ -52,7 +52,7 @@ against the Yocto Project, see the following: - The Yocto Project :yocto_wiki:`Bugzilla wiki page ` -For information on Bugzilla in general, see http://www.bugzilla.org/about/. +For information on Bugzilla in general, see https://www.bugzilla.org/about/. .. _resources-mailinglist: @@ -193,5 +193,5 @@ Here is a list of resources you might find helpful: available for Yocto Project and Poky discussions: ``#yocto`` and ``#poky``, respectively. -- `Quick EMUlator (QEMU) `__\ *:* An +- `Quick EMUlator (QEMU) `__\ *:* An open-source machine emulator and virtualizer. diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index c68e1c1b7b..c8e28fd321 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -2662,7 +2662,7 @@ system and gives an overview of their function and contents. GROUPADD_PARAM_${PN} = "-r netdev" For information on the standard Linux shell command - ``groupadd``, see http://linux.die.net/man/8/groupadd. + ``groupadd``, see https://linux.die.net/man/8/groupadd. :term:`GROUPMEMS_PARAM` When inheriting the :ref:`useradd ` class, @@ -2671,7 +2671,7 @@ system and gives an overview of their function and contents. of a group when the package is installed. For information on the standard Linux shell command ``groupmems``, - see http://linux.die.net/man/8/groupmems. + see https://linux.die.net/man/8/groupmems. :term:`GRUB_GFXSERIAL` Configures the GNU GRand Unified Bootloader (GRUB) to have graphics @@ -4694,7 +4694,7 @@ system and gives an overview of their function and contents. See the :term:`KERNEL_MODULE_AUTOLOAD` variable for more information. module_conf - Specifies `modprobe.d `_ + Specifies `modprobe.d `_ syntax lines for inclusion in the ``/etc/modprobe.d/modname.conf`` file. @@ -7619,7 +7619,7 @@ system and gives an overview of their function and contents. SYSTEMD_BOOT_CFG ?= "${:term:`S`}/loader.conf" For information on Systemd-boot, see the `Systemd-boot - documentation `__. + documentation `__. :term:`SYSTEMD_BOOT_ENTRIES` When :term:`EFI_PROVIDER` is set to @@ -7633,7 +7633,7 @@ system and gives an overview of their function and contents. SYSTEMD_BOOT_ENTRIES ?= "" For information on Systemd-boot, see the `Systemd-boot - documentation `__. + documentation `__. :term:`SYSTEMD_BOOT_TIMEOUT` When :term:`EFI_PROVIDER` is set to @@ -7646,7 +7646,7 @@ system and gives an overview of their function and contents. SYSTEMD_BOOT_TIMEOUT ?= "10" For information on Systemd-boot, see the `Systemd-boot - documentation `__. + documentation `__. :term:`SYSTEMD_PACKAGES` When inheriting the :ref:`systemd ` class, @@ -7677,7 +7677,7 @@ system and gives an overview of their function and contents. When using :ref:`SysVinit `, specifies a space-separated list of the virtual terminals that should - run a `getty `__ + run a `getty `__ (allowing login), assuming :term:`USE_VT` is not set to "0". @@ -7901,7 +7901,7 @@ system and gives an overview of their function and contents. toolchain. One example is the Sourcery G++ Toolchain. The support for this toolchain resides in the separate Mentor Graphics ``meta-sourcery`` layer at - http://github.com/MentorEmbedded/meta-sourcery/. + https://github.com/MentorEmbedded/meta-sourcery/. The layer's ``README`` file contains information on how to use the Sourcery G++ Toolchain as an external toolchain. In summary, you must @@ -8597,7 +8597,7 @@ system and gives an overview of their function and contents. When using :ref:`SysVinit `, determines whether or not to run a - `getty `__ on any + `getty `__ on any virtual terminals in order to enable logging in through those terminals. @@ -8708,7 +8708,7 @@ system and gives an overview of their function and contents. For information on the standard Linux shell command ``useradd``, see - http://linux.die.net/man/8/useradd. + https://linux.die.net/man/8/useradd. :term:`USERADD_UID_TABLES` Specifies a password file to use for obtaining static user diff --git a/documentation/sdk-manual/intro.rst b/documentation/sdk-manual/intro.rst index 66b12cdff9..e4b9b05ba6 100644 --- a/documentation/sdk-manual/intro.rst +++ b/documentation/sdk-manual/intro.rst @@ -210,7 +210,7 @@ You just need to follow these general steps: 3. *Develop and Test your Application:* At this point, you have the tools to develop your application. If you need to separately install and use the QEMU emulator, you can go to `QEMU Home - Page `__ to download and learn about + Page `__ to download and learn about the emulator. See the ":doc:`/dev-manual/qemu`" chapter in the Yocto Project Development Tasks Manual for information on using QEMU within the Yocto Project. diff --git a/documentation/toaster-manual/reference.rst b/documentation/toaster-manual/reference.rst index 34a1f39cff..d2ab14c8e6 100644 --- a/documentation/toaster-manual/reference.rst +++ b/documentation/toaster-manual/reference.rst @@ -29,7 +29,7 @@ layer index's web application at :yocto_git:`/layerindex-web/`. When you tie a layer source into Toaster, it can query the layer source through a -`REST `__ +`REST `__ API, store the information about the layers in the Toaster database, and then show the information to users. Users are then able to view that information and build layers from Toaster itself without worrying about @@ -370,7 +370,7 @@ Remote Toaster Monitoring Toaster has an API that allows remote management applications to directly query the state of the Toaster server and its builds in a machine-to-machine manner. This API uses the -`REST `__ +`REST `__ interface and the transfer of JSON files. For example, you might monitor a build inside a container through well supported known HTTP ports in order to easily access a Toaster server inside the container. In this -- cgit v1.2.3-54-g00ecf