aboutsummaryrefslogtreecommitdiff
path: root/documentation
diff options
context:
space:
mode:
authorStefan Eßer <se@FreeBSD.org>2022-09-07 07:02:39 +0000
committerStefan Eßer <se@FreeBSD.org>2022-09-07 19:20:42 +0000
commit35df6b4e1343805fd26940f493f2dc9dc6b9a1be (patch)
treeb9eca242ee36163dab847f565abad5afe6a0a916 /documentation
parentcdc7bf43fe7d33f904b6d78eef466bc25e59cb7c (diff)
downloaddoc-35df6b4e1343805fd26940f493f2dc9dc6b9a1be.tar.gz
doc-35df6b4e1343805fd26940f493f2dc9dc6b9a1be.zip
porters-handbook: fix example URLs
The format of URLs requested in this handbook had not been applied to all the example URLs, e.g. with regard to preferring HTTPS over HTTP and to add a skash "/" at the end of host and directory URLs. Update the example URLs to follow the specified format rules, where possible.
Diffstat (limited to 'documentation')
-rw-r--r--documentation/content/en/books/porters-handbook/keeping-up/_index.adoc10
-rw-r--r--documentation/content/en/books/porters-handbook/makefiles/_index.adoc54
-rw-r--r--documentation/content/en/books/porters-handbook/order/_index.adoc1
-rw-r--r--documentation/content/en/books/porters-handbook/security/_index.adoc14
-rw-r--r--documentation/content/en/books/porters-handbook/special/_index.adoc12
-rw-r--r--documentation/content/en/books/porters-handbook/uses/_index.adoc4
6 files changed, 48 insertions, 47 deletions
diff --git a/documentation/content/en/books/porters-handbook/keeping-up/_index.adoc b/documentation/content/en/books/porters-handbook/keeping-up/_index.adoc
index 9061a38d2b..f1b4eed690 100644
--- a/documentation/content/en/books/porters-handbook/keeping-up/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/keeping-up/_index.adoc
@@ -53,7 +53,7 @@ Here is some information on how to keep up.
[[freshports]]
== FreshPorts
-One of the easiest ways to learn about updates that have already been committed is by subscribing to http://www.FreshPorts.org/[FreshPorts].
+One of the easiest ways to learn about updates that have already been committed is by subscribing to https://www.FreshPorts.org/[FreshPorts].
Multiple ports can be monitored.
Maintainers are strongly encouraged to subscribe, because they will receive notification of not only their own changes, but also any changes that any other FreeBSD committer has made.
(These are often necessary to keep up with changes in the underlying ports framework-although it would be most polite to receive an advance heads-up from those committing such changes, sometimes this is overlooked or impractical.
@@ -71,7 +71,7 @@ If subscribed to this service, a committer will receive notifications of any err
== The Web Interface to the Source Repository
It is possible to browse the files in the source repository by using a web interface.
-Changes that affect the entire port system are now documented in the https://cgit.freebsd.org/ports/tree/CHANGES[CHANGES] file.
+Changes that affect the entire port system are now documented in the https://cgit.FreeBSD.org/ports/tree/CHANGES[CHANGES] file.
Changes that affect individual ports are now documented in the https://cgit.FreeBSD.org/ports/tree/UPDATING[UPDATING] file.
However, the definitive answer to any question is undoubtedly to read the source code of https://cgit.FreeBSD.org/ports/tree/Mk/bsd.port.mk[bsd.port.mk], and associated files.
@@ -97,7 +97,7 @@ Ports that are marked with `BROKEN` will still be attempted, to see if the under
The build cluster is dedicated to building the latest release of each port with distfiles that have already been fetched.
However, as the Internet continually changes, distfiles can quickly go missing.
-http://portscout.FreeBSD.org[Portscout], the FreeBSD Ports distfile scanner, attempts to query every download site for every port to find out if each distfile is still available.
+https://portscout.FreeBSD.org/[Portscout], the FreeBSD Ports distfile scanner, attempts to query every download site for every port to find out if each distfile is still available.
Portscout can generate HTML reports and send emails about newly available ports to those who request them.
Unless not otherwise subscribed, maintainers are asked to check periodically for changes, either by hand or using the RSS feed.
@@ -107,6 +107,6 @@ The search function allows for searching by email address for a specific maintai
Upon clicking on a maintainer's email address, a list of all of their ports is displayed, along with port category, current version number, whether or not there is a new version, when the port was last updated, and finally when it was last checked.
A search function on this page allows the user to search for a specific port.
-Clicking on a port name in the list displays the http://freshports.org[FreshPorts] port information.
+Clicking on a port name in the list displays the https://freshports.org/[FreshPorts] port information.
-Additional documentation is available in the https://github.com/freebsd/portscout[Portscout repository].
+Additional documentation is available in the https://github.com/freebsd/portscout/[Portscout repository].
diff --git a/documentation/content/en/books/porters-handbook/makefiles/_index.adoc b/documentation/content/en/books/porters-handbook/makefiles/_index.adoc
index 005eb99dfb..ea3e033f70 100644
--- a/documentation/content/en/books/porters-handbook/makefiles/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/makefiles/_index.adoc
@@ -643,7 +643,7 @@ For non-virtual categories, there is a one-line description in `COMMENT` in that
|
|[.filename]#afterstep#`*`
-|Ports to support the http://www.afterstep.org[AfterStep] window manager.
+|Ports to support the http://www.afterstep.org/[AfterStep] window manager.
|
|[.filename]#arabic#
@@ -751,7 +751,7 @@ For non-virtual categories, there is a one-line description in `COMMENT` in that
|
|[.filename]#gnome#`*`
-|Ports from the http://www.gnome.org[GNOME] Project.
+|Ports from the https://www.gnome.org/[GNOME] Project.
|
|[.filename]#gnustep#`*`
@@ -791,19 +791,19 @@ For non-virtual categories, there is a one-line description in `COMMENT` in that
|The [.filename]#java# category must not be the only one for a port. Save for ports directly related to the Java language, porters are also encouraged not to use [.filename]#java# as the main category of a port.
|[.filename]#kde#`*`
-|Ports from the http://www.kde.org[KDE] Project (generic).
+|Ports from the https://www.kde.org/[KDE] Project (generic).
|
|[.filename]#kde-applications#`*`
-|Applications from the http://www.kde.org[KDE] Project.
+|Applications from the https://www.kde.org/[KDE] Project.
|
|[.filename]#kde-frameworks#`*`
-|Add-on libraries from the http://www.kde.org[KDE] Project for programming with Qt.
+|Add-on libraries from the https://www.kde.org/[KDE] Project for programming with Qt.
|
|[.filename]#kde-plasma#`*`
-|Desktop from the http://www.kde.org[KDE] Project.
+|Desktop from the https://www.kde.org/[KDE] Project.
|
|[.filename]#kld#`*`
@@ -887,7 +887,7 @@ For non-virtual categories, there is a one-line description in `COMMENT` in that
|
|[.filename]#plan9#`*`
-|Various programs from http://www.cs.bell-labs.com/plan9dist/[Plan9].
+|Various programs from https://9p.io/wiki/plan9/Download/index.html[Plan9].
|
|[.filename]#polish#
@@ -907,15 +907,15 @@ For non-virtual categories, there is a one-line description in `COMMENT` in that
|Desktop publishing tools (previewers, etc.) belong here too.
|[.filename]#python#`*`
-|Software related to the http://www.python.org/[Python] language.
+|Software related to the https://www.python.org/[Python] language.
|
|[.filename]#ruby#`*`
-|Software related to the http://www.ruby-lang.org/[Ruby] language.
+|Software related to the https://www.ruby-lang.org/[Ruby] language.
|
|[.filename]#rubygems#`*`
-|Ports of http://www.rubygems.org/[RubyGems] packages.
+|Ports of https://www.rubygems.org/[RubyGems] packages.
|
|[.filename]#russian#
@@ -1015,11 +1015,11 @@ For non-virtual categories, there is a one-line description in `COMMENT` in that
|
|[.filename]#xfce#`*`
-|Ports related to the http://www.xfce.org/[Xfce] desktop environment.
+|Ports related to the https://www.xfce.org/[Xfce] desktop environment.
|
|[.filename]#zope#`*`
-|http://www.zope.org/[Zope] support.
+|https://www.zope.org/[Zope] support.
|
|===
@@ -1438,7 +1438,7 @@ MASTER_SITE_SUBDIR= stardict/WyabdcRealPeopleTTS/${PORTVERSION}
[[makefile-master_sites-github]]
=== `USE_GITHUB`
-If the distribution file comes from a specific commit or tag on https://github.com[GitHub] for which there is no officially released file,
+If the distribution file comes from a specific commit or tag on https://github.com/[GitHub] for which there is no officially released file,
there is an easy way to set the right `DISTNAME` and `MASTER_SITES` automatically.
These variables are available:
@@ -1480,7 +1480,7 @@ Do not use `GH_TUPLE` for the default distribution file, as it has no default.
[example]
====
-While trying to make a port for version `1.2.7` of pkg from the FreeBSD user on github, at https://github.com/freebsd/pkg[], The [.filename]#Makefile# would end up looking like this (slightly stripped for the example):
+While trying to make a port for version `1.2.7` of pkg from the FreeBSD user on github, at https://github.com/freebsd/pkg/[], The [.filename]#Makefile# would end up looking like this (slightly stripped for the example):
[.programlisting]
....
@@ -1498,7 +1498,7 @@ It will automatically have `MASTER_SITES` set to `GH` and `WRKSRC` to `${WRKDIR}
.More Complete Use of `USE_GITHUB`
[example]
====
-While trying to make a port for the bleeding edge version of pkg from the FreeBSD user on github, at https://github.com/freebsd/pkg[], the [.filename]#Makefile# ends up looking like this (slightly stripped for the example):
+While trying to make a port for the bleeding edge version of pkg from the FreeBSD user on github, at https://github.com/freebsd/pkg/[], the [.filename]#Makefile# ends up looking like this (slightly stripped for the example):
[.programlisting]
....
@@ -1755,7 +1755,7 @@ See man:git-submodule[1] for more information.
The problem with submodules is that each is a separate repository.
As such, they each must be fetched separately.
-Using package:finance/moneymanagerex[] as an example, its GitHub repository is https://github.com/moneymanagerex/moneymanagerex[].
+Using package:finance/moneymanagerex[] as an example, its GitHub repository is https://github.com/moneymanagerex/moneymanagerex/[].
It has a https://github.com/moneymanagerex/moneymanagerex/blob/master/.gitmodules[.gitmodules] file at the root.
This file describes all the submodules used in this repository, and lists additional repositories needed.
This file will tell what additional repositories are needed:
@@ -1841,7 +1841,7 @@ GH_TUPLE= utelle:wxsqlite3:v3.4.0:wxsqlite3/lib/wxsqlite3 \
[[makefile-master_sites-gitlab]]
=== `USE_GITLAB`
-Similar to GitHub, if the distribution file comes from https://gitlab.com[gitlab.com] or is hosting the GitLab software, these variables are available for use and might need to be set.
+Similar to GitHub, if the distribution file comes from https://gitlab.com/[gitlab.com] or is hosting the GitLab software, these variables are available for use and might need to be set.
[[makefile-master_sites-gitlab-description]]
.`USE_GITLAB` Description
@@ -1853,7 +1853,7 @@ Similar to GitHub, if the distribution file comes from https://gitlab.com[gitlab
|`GL_SITE`
|Site name hosting the GitLab project
-|https://gitlab.com
+|https://gitlab.com/
|`GL_ACCOUNT`
|Account name of the GitLab user hosting the project
@@ -1879,7 +1879,7 @@ Similar to GitHub, if the distribution file comes from https://gitlab.com[gitlab
.Simple Use of `USE_GITLAB`
[example]
====
-While trying to make a port for version `1.14` of libsignon-glib from the accounts-sso user on gitlab.com, at https://gitlab.com/accounts-sso/libsignon-glib[], The [.filename]#Makefile# would end up looking like this for fetching the distribution files:
+While trying to make a port for version `1.14` of libsignon-glib from the accounts-sso user on gitlab.com, at https://gitlab.com/accounts-sso/libsignon-glib/[], The [.filename]#Makefile# would end up looking like this for fetching the distribution files:
[.programlisting]
....
@@ -1891,7 +1891,7 @@ GL_ACCOUNT= accounts-sso
GL_COMMIT= e90302e342bfd27bc8c9132ab9d0ea3d8723fd03
....
-It will automatically have `MASTER_SITES` set to https://gitlab.com[gitlab.com] and `WRKSRC` to `${WRKDIR}/libsignon-glib-e90302e342bfd27bc8c9132ab9d0ea3d8723fd03-e90302e342bfd27bc8c9132ab9d0ea3d8723fd03`.
+It will automatically have `MASTER_SITES` set to https://gitlab.com/[gitlab.com] and `WRKSRC` to `${WRKDIR}/libsignon-glib-e90302e342bfd27bc8c9132ab9d0ea3d8723fd03-e90302e342bfd27bc8c9132ab9d0ea3d8723fd03`.
====
[[makefile-master_sites-gitlab-ex2]]
@@ -1899,7 +1899,7 @@ It will automatically have `MASTER_SITES` set to https://gitlab.com[gitlab.com]
[example]
====
-A more complete use of the above if port had no versioning and foobar from the foo user on project bar on a self hosted GitLab site `https://gitlab.example.com`, the [.filename]#Makefile# ends up looking like this for fetching distribution files:
+A more complete use of the above if port had no versioning and foobar from the foo user on project bar on a self hosted GitLab site `https://gitlab.example.com/`, the [.filename]#Makefile# ends up looking like this for fetching distribution files:
[.programlisting]
....
@@ -2987,12 +2987,12 @@ For the predefined licenses, the default permissions are `dist-mirror dist-sell
|`none`
|`OFL10`
-|SIL Open Font License version 1.0 (http://scripts.sil.org/OFL)
+|SIL Open Font License version 1.0 (https://scripts.sil.org/OFL/)
|`FONTS`
|(default)
|`OFL11`
-|SIL Open Font License version 1.1 (http://scripts.sil.org/OFL)
+|SIL Open Font License version 1.1 (https://scripts.sil.org/OFL/)
|`FONTS`
|(default)
@@ -3189,7 +3189,7 @@ Groups the license belongs.
.Predefined License Groups List
[[licenses-license_groups-FSF]]
`FSF`::
-Free Software Foundation Approved, see the http://www.fsf.org/licensing[FSF Licensing & Compliance Team].
+Free Software Foundation Approved, see the https://www.fsf.org/licensing/[FSF Licensing & Compliance Team].
[[licenses-license_groups-GPL]]
`GPL`::
@@ -3197,11 +3197,11 @@ GPL Compatible
[[licenses-license_groups-OSI]]
`OSI`::
-OSI Approved, see the Open Source Initiative http://opensource.org/licenses[Open Source Licenses] page.
+OSI Approved, see the Open Source Initiative https://opensource.org/licenses/[Open Source Licenses] page.
[[licenses-license_groups-COPYFREE]]
`COPYFREE`::
-Comply with Copyfree Standard Definition, see the http://copyfree.org/standard/licenses[Copyfree Licenses] page.
+Comply with Copyfree Standard Definition, see the https://copyfree.org/standard/licenses/[Copyfree Licenses] page.
[[licenses-license_groups-FONTS]]
`FONTS`::
@@ -3380,7 +3380,7 @@ PORTSCOUT= limit:^0\.6\.4
+
[.programlisting]
....
-PORTSCOUT= site:http://pgfoundry.org/frs/?group_id=1000416
+PORTSCOUT= site:http://www.renpy.org/dl/release/
....
[[makefile-depend]]
diff --git a/documentation/content/en/books/porters-handbook/order/_index.adoc b/documentation/content/en/books/porters-handbook/order/_index.adoc
index 057119bed6..32814f2a25 100644
--- a/documentation/content/en/books/porters-handbook/order/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/order/_index.adoc
@@ -112,6 +112,7 @@ The variables are:
* crossref:makefiles[makefile-maintainer,`MAINTAINER`]
* crossref:makefiles[makefile-comment,`COMMENT`]
+* crossref:makefiles[makefile-www,`WWW`]
[[porting-order-license]]
== `LICENSE` Block
diff --git a/documentation/content/en/books/porters-handbook/security/_index.adoc b/documentation/content/en/books/porters-handbook/security/_index.adoc
index ac663489ae..e8c9a0a6b8 100644
--- a/documentation/content/en/books/porters-handbook/security/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/security/_index.adoc
@@ -211,17 +211,17 @@ The above example specifies that affected are versions `1.6` and up to but not i
<.> This is a https://www.freebsd.org/support/[FreeBSD problem report].
-<.> This is a http://www.cve.mitre.org/[MITRE CVE] identifier.
+<.> This is a https://cve.mitre.org/[MITRE CVE] identifier.
-<.> This is a http://www.securityfocus.com/bid[SecurityFocus Bug ID].
+<.> This is a https://www.securityfocus.com/bid/[SecurityFocus Bug ID].
-<.> This is a http://www.cert.org/[US-CERT] security advisory.
+<.> This is a https://www.cert.org/[US-CERT] security advisory.
-<.> This is a http://www.cert.org/[US-CERT] vulnerability note.
+<.> This is a https://www.cert.org/[US-CERT] vulnerability note.
-<.> This is a http://www.cert.org/[US-CERT] Cyber Security Alert.
+<.> This is a https://www.cert.org/[US-CERT] Cyber Security Alert.
-<.> This is a http://www.cert.org/[US-CERT] Technical Cyber Security Alert.
+<.> This is a https://www.cert.org/[US-CERT] Technical Cyber Security Alert.
<.> This is a URL to an archived posting in a mailing list. The attribute `msgid` is optional and may specify the message ID of the posting.
@@ -295,7 +295,7 @@ dropbear-2012.58 is vulnerable:
dropbear -- exposure of sensitive information, DoS
CVE: CVE-2013-4434
CVE: CVE-2013-4421
-WWW: http://portaudit.FreeBSD.org/8c9b48d1-3715-11e3-a624-00262d8b701d.html
+WWW: https://portaudit.FreeBSD.org/8c9b48d1-3715-11e3-a624-00262d8b701d.html
1 problem(s) in the installed packages found.
....
diff --git a/documentation/content/en/books/porters-handbook/special/_index.adoc b/documentation/content/en/books/porters-handbook/special/_index.adoc
index 3a76c90467..046b741f5d 100644
--- a/documentation/content/en/books/porters-handbook/special/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/special/_index.adoc
@@ -138,7 +138,7 @@ Some software requires the porter to locate third-party libraries and add the re
Other software bundles all necessary libraries into the distribution file.
The second approach seems easier at first, but there are some serious drawbacks:
-This list is loosely based on the https://fedoraproject.org/wiki/Packaging:No_Bundled_Libraries[Fedora] and http://wiki.gentoo.org/wiki/Why_not_bundle_dependencies[Gentoo] wikis, both licensed under the http://creativecommons.org/licenses/by-sa/3.0/[CC-BY-SA 3.0] license.
+This list is loosely based on the https://fedoraproject.org/wiki/Packaging:No_Bundled_Libraries[Fedora] and https://wiki.gentoo.org/wiki/Why_not_bundle_dependencies[Gentoo] wikis, both licensed under the https://creativecommons.org/licenses/by-sa/3.0/[CC-BY-SA 3.0] license.
Security::
If vulnerabilities are found in the upstream library and fixed there, they might not be fixed in the library bundled with the port.
@@ -1275,7 +1275,7 @@ If `MASTER_SITES` is set to `CPAN`, the correct subdirectory is usually selected
If the default subdirectory is wrong, `CPAN/Module` can be used to change it.
`MASTER_SITES` can also be set to the old `MASTER_SITE_PERL_CPAN`, then the preferred value of `MASTER_SITE_SUBDIR` is the top-level hierarchy name.
For example, the recommended value for `p5-Module-Name` is `Module`.
-The top-level hierarchy can be examined at http://cpan.org/modules/by-module/[cpan.org].
+The top-level hierarchy can be examined at https://cpan.org/modules/by-module/[cpan.org].
This keeps the port working when the author of the module changes.
The exception to this rule is when the relevant directory does not exist or the distfile does not exist in that directory.
@@ -1313,8 +1313,8 @@ When a port needs Perl support, it must set `USES=perl5` with the optional `USE_
[NOTE]
====
-Ports of Perl modules which do not have an official website must link to `cpan.org` in the WWW line of [.filename]#pkg-descr#.
-The preferred URL form is `http://search.cpan.org/dist/Module-Name/` (including the trailing slash).
+Ports of Perl modules which do not have an official website must link to `cpan.org` in the WWW line of [.filename]#Makefile#.
+The preferred URL form is `https://search.cpan.org/dist/Module-Name/` (including the trailing slash).
====
[NOTE]
@@ -1516,7 +1516,7 @@ USES= display
[[desktop-entries]]
=== Desktop Entries
-Desktop entries (http://standards.freedesktop.org/desktop-entry-spec/latest/[a Freedesktop standard]) provide a way to automatically adjust desktop features when a new program is installed, without requiring user intervention.
+Desktop entries (https://standards.freedesktop.org/desktop-entry-spec/latest/[a Freedesktop standard]) provide a way to automatically adjust desktop features when a new program is installed, without requiring user intervention.
For example, newly-installed programs automatically appear in the application menus of compatible desktop environments.
Desktop entries originated in the GNOME desktop environment, but are now a standard and also work with KDE and Xfce.
This bit of automation provides a real benefit to the user, and desktop entries are encouraged for applications which can be used in a desktop environment.
@@ -1545,7 +1545,7 @@ Syntax is:
DESKTOP_ENTRIES= "NAME" "COMMENT" "ICON" "COMMAND" "CATEGORY" StartupNotify
....
-The list of possible categories is available on the http://standards.freedesktop.org/menu-spec/latest/apa.html[Freedesktop website].
+The list of possible categories is available on the https://standards.freedesktop.org/menu-spec/latest/apa.html[Freedesktop website].
`StartupNotify` indicates whether the application is compatible with _startup notifications_.
These are typically a graphic indicator like a clock that appear at the mouse pointer, menu, or panel to give the user an indication when a program is starting.
A program that is compatible with startup notifications clears the indicator after it has started.
diff --git a/documentation/content/en/books/porters-handbook/uses/_index.adoc b/documentation/content/en/books/porters-handbook/uses/_index.adoc
index f0675734be..d5999cdc5f 100644
--- a/documentation/content/en/books/porters-handbook/uses/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/uses/_index.adoc
@@ -318,11 +318,11 @@ After including [.filename]#bsd.port.pre.mk# the port can inspect the results us
Possible arguments: (none)
Include Common Platform Enumeration (CPE) information in package manifest as a CPE 2.3 formatted string.
-See the http://scap.nist.gov/specifications/cpe/[CPE specification] for details.
+See the https://scap.nist.gov/specifications/cpe/[CPE specification] for details.
To add CPE information to a port, follow these steps:
[.procedure]
-. Search for the official CPE entry for the software product either by using the NVD's http://web.nvd.nist.gov/view/cpe/search[CPE search engine] or in the http://static.nvd.nist.gov/feeds/xml/cpe/dictionary/official-cpe-dictionary_v2.3.xml[official CPE dictionary] (warning, very large XML file). _Do not ever make up CPE data._
+. Search for the official CPE entry for the software product either by using the NVD's https://web.nvd.nist.gov/view/cpe/search[CPE search engine] or in the https://nvd.nist.gov/feeds/xml/cpe/dictionary/official-cpe-dictionary_v2.3.xml.gz[official CPE dictionary] (warning, very large XML file). _Do not ever make up CPE data._
. Add `cpe` to `USES` and compare the result of `make -V CPE_STR` to the CPE dictionary entry. Continue one step at a time until `make -V CPE_STR` is correct.
. If the product name (second field, defaults to `PORTNAME`) is incorrect, define `CPE_PRODUCT`.
. If the vendor name (first field, defaults to `CPE_PRODUCT`) is incorrect, define `CPE_VENDOR`.