Skip to content

Commit

Permalink
Refer to the Package Manager Specification by its full name
Browse files Browse the repository at this point in the history
Other small updates of wording (when in the same paragraph).
Fix/update some external links.

Signed-off-by: Ulrich Müller <ulm@gentoo.org>
  • Loading branch information
ulm committed Nov 12, 2024
1 parent 6a6a071 commit 3dec896
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 26 deletions.
14 changes: 7 additions & 7 deletions ebuild-writing/eapi/text.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
<body>

<p>
The <uri link="https://wiki.gentoo.org/wiki/Project:PMS">Package Manager
Specification (PMS)</uri> is a standardization effort to ensure that the
ebuild file format, the ebuild repository format (of which the Gentoo
The <uri link="https://wiki.gentoo.org/wiki/Project:Package_Manager_Specification">
Package Manager Specification</uri> is a standardization effort to ensure that
the ebuild file format, the ebuild repository format (of which the Gentoo
repository is Gentoo's main incarnation) as well as behaviour of the package
managers interacting with these ebuilds is properly written down and agreed
upon.
Expand All @@ -16,8 +16,8 @@ upon.
<p>
EAPI is a version defined in ebuilds and other package manager related files
which informs the package manager about the file syntax and content. It is,
in effect, the version of the package manager specification (PMS) that the
file adheres to.
in effect, the version of the Package Manager Specification that the file
adheres to.
</p>

<p>
Expand Down Expand Up @@ -49,8 +49,8 @@ EAPI=7
</codesample>

<note>
Most developers prefer to set the EAPI version without quotes. However, the PMS
allows single and double quotes as well.
Most developers prefer to set the EAPI version without quotes. However,
enclosing it in single or double quotes is also allowed.
</note>

<important>
Expand Down
6 changes: 3 additions & 3 deletions ebuild-writing/file-format/text.xml
Original file line number Diff line number Diff line change
Expand Up @@ -122,11 +122,11 @@ ebuild version components.
</p>

<p>
The formal specification of version
The formal definition of the
<uri link="https://projects.gentoo.org/pms/8/pms.html#x1-250003.2">
format</uri> and the comparison
version format</uri> and the
<uri link="https://projects.gentoo.org/pms/8/pms.html#x1-260003.3">
algorithm</uri> can be found in PMS.
comparison algorithm</uri> can be found in the Package Manager Specification.
</p>

</body>
Expand Down
11 changes: 5 additions & 6 deletions ebuild-writing/variables/text.xml
Original file line number Diff line number Diff line change
Expand Up @@ -458,8 +458,7 @@ and the same set of mirrors is shared across multiple ebuilds, then you
don't have to repeatedly list each of them in every ebuild.
The <c>profiles/thirdpartymirrors</c> file in the <c>::gentoo</c> repository
contains named groups of mirrors, in the format specified by the
Package Manager Specification (PMS), accessible through the
<c>mirror://</c>
Package Manager Specification, accessible through the <c>mirror://</c>
pseudo-protocol.
</p>

Expand Down Expand Up @@ -710,10 +709,10 @@ While Portage may recognise several different <c>RESTRICT</c> tokens, it is
important that you do not rely on them existing. That is, you should ensure
your ebuild does not fail if those tokens are not exposed or given a different
name by another package manager. You can make use of Portage-provided
<c>RESTRICT</c> tokens, but do not fail hard without them. See
<uri link="https://projects.gentoo.org/pms/7/pms.html#x1-810008.2.8">
PMS</uri> for the list of standardised <c>RESTRICT</c> tokens, or the above
table.
<c>RESTRICT</c> tokens, but do not fail hard without them. See the
<uri link="https://projects.gentoo.org/pms/8/pms.html#x1-680007.3.6">
Package Manager Specification</uri> for the list of standardised
<c>RESTRICT</c> tokens, or the above table.
</p>

</body>
Expand Down
8 changes: 4 additions & 4 deletions function-reference/install-functions/text.xml
Original file line number Diff line number Diff line change
Expand Up @@ -313,10 +313,10 @@ The <c>*into</c> functions create the directory if it does not already exist.
<ti>
Install a directory that will be empty when the package is
merged. This is like <c>dodir</c>, but for empty directories
instead. <uri
link="https://projects.gentoo.org/pms/7/pms.html#x1-14200013.2.2">The
handling of empty directories is undefined by the package
manager specification</uri>, and the <c>keepdir</c> function
instead.
<uri link="https://projects.gentoo.org/pms/8/pms.html#x1-14200013.2.2">
The handling of empty directories is undefined by the Package
Manager Specification</uri>, and the <c>keepdir</c> function
exists to ensure that the (otherwise empty) directory is
tracked. This is accomplished by installing a hidden file
prefixed with <c>.keep</c> to the directory in question.
Expand Down
8 changes: 4 additions & 4 deletions function-reference/version-functions/text.xml
Original file line number Diff line number Diff line change
Expand Up @@ -202,12 +202,12 @@ If the range spans outside the version string, it is silently truncated.
not-equal, less-than-or-equal, or less-than <e>v2</e>.
</p>
<p>
Both versions <e>v1</e> and <e>v2</e> must conform to the
Both versions <e>v1</e> and <e>v2</e> must conform to
<uri link="https://projects.gentoo.org/pms/8/pms.html#x1-250003.2">
PMS version syntax</uri> (with optional revision parts), and the
comparison is performed according to the
Gentoo package version syntax</uri> (with optional revision parts),
and the comparison is performed according to the
<uri link="https://projects.gentoo.org/pms/8/pms.html#x1-260003.3">
algorithm specified in the PMS</uri>.
algorithm</uri> defined by the Package Manager Specification.
</p>
</ti>
</tr>
Expand Down
5 changes: 3 additions & 2 deletions profiles/text.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@
<p>
This section provides details on the <c>profiles/</c> directory. All of these
files are also documented in <c>man portage</c>, but the canonical reference
for profiles is within
<uri link="https://projects.gentoo.org/pms/8/pms.html#x1-320004.4">PMS</uri>.
for profiles is in the
<uri link="https://projects.gentoo.org/pms/8/pms.html#x1-320004.4">
Package Manager Specification</uri>.
</p>

<p>
Expand Down

0 comments on commit 3dec896

Please sign in to comment.