diff --git a/appendices/contributing/text.xml b/appendices/contributing/text.xml index fdcaa900..f7d313ba 100644 --- a/appendices/contributing/text.xml +++ b/appendices/contributing/text.xml @@ -55,10 +55,10 @@ for those who prefer to submit patches using pull requests.

To build the devmanual, simply run make in the top directory of -the repository. You need xsltproc (from dev-libs/libxslt) -for the XML to HTML conversion, xmllint (from dev-libs/libxml2) -for validation, and rsvg-convert (from gnome-base/librsvg) for -the SVG to PNG conversion used in some of the figures throughout the document. +the repository. You need xsltproc (from dev-libs/libxslt) +for the XML to HTML conversion, xmllint (from dev-libs/libxml2) +for validation, and rsvg-convert (from gnome-base/librsvg) +for the SVG to PNG conversion used in some of the figures throughout the document.

diff --git a/appendices/devbook-guide/text.xml b/appendices/devbook-guide/text.xml index b1643274..ad803c9d 100644 --- a/appendices/devbook-guide/text.xml +++ b/appendices/devbook-guide/text.xml @@ -501,6 +501,12 @@ The <sub> and <sup> elements are used to specify subscript and superscript.

+

+Use the <pkg> element to reference Gentoo packages, such as +<pkg>app-doc/pms</pkg>, which renders as app-doc/pms. +This tag automatically creates a link to the package information page. +

+ diff --git a/appendices/editor-configuration/emacs/text.xml b/appendices/editor-configuration/emacs/text.xml index 206f4387..01fc1f8f 100644 --- a/appendices/editor-configuration/emacs/text.xml +++ b/appendices/editor-configuration/emacs/text.xml @@ -64,13 +64,13 @@ activated by (setq x-select-enable-clipboard t).

For easy editing of ebuilds an Emacs mode has been created, which is -found in the package app-emacs/ebuild-mode. +found in the package app-emacs/ebuild-mode. It supports ebuilds and eclasses, highlights keywords and also provides a hook for your own customisation.

-Package app-emacs/nxml-gentoo-schemas improves editing of +Package app-emacs/nxml-gentoo-schemas improves editing of Gentoo specific XML files (e.g., metadata.xml). It provides auto-completion and on-the-fly validation, using a RELAX NG schema for each document type. diff --git a/appendices/editor-configuration/vim/text.xml b/appendices/editor-configuration/vim/text.xml index 0e6088b1..93883c52 100644 --- a/appendices/editor-configuration/vim/text.xml +++ b/appendices/editor-configuration/vim/text.xml @@ -7,7 +7,7 @@

For full whitespace, character set, syntax highlighting and indent settings for all of Gentoo's file-types in vim and gvim, emerge the -app-vim/gentoo-syntax package. +app-vim/gentoo-syntax package.

diff --git a/bin/gen-eclass-html.sh b/bin/gen-eclass-html.sh index 1c9aebf5..444c43ca 100755 --- a/bin/gen-eclass-html.sh +++ b/bin/gen-eclass-html.sh @@ -177,7 +177,7 @@ cat << 'EOF' > "${OUTPUTDIR}"/text.xml || exit 1

This section provides a reference for some of the more commonly used eclasses. Note that most eclasses have an accompanying manual page. These man pages can be -installed by emerging app-doc/eclass-manpages. +installed by emerging app-doc/eclass-manpages.

EOF diff --git a/devbook.rnc b/devbook.rnc index 0097a979..073bd091 100644 --- a/devbook.rnc +++ b/devbook.rnc @@ -1,4 +1,4 @@ -# Copyright 2022-2024 Gentoo Authors +# Copyright 2022-2025 Gentoo Authors # Distributed under the terms of the MIT license # or the CC-BY-SA-4.0 license (dual-licensed) @@ -123,6 +123,7 @@ e = element e { inline } sub = element sub { inline } sup = element sup { inline } d = element d { empty } +pkg = element pkg { text } uri = element uri { # uri can have either a URI in the body text or a link attribute diff --git a/devbook.rng b/devbook.rng index 020f9ec8..7b400e3c 100644 --- a/devbook.rng +++ b/devbook.rng @@ -2,7 +2,7 @@ @@ -408,6 +408,11 @@ + + + + + diff --git a/devbook.xsl b/devbook.xsl index 31f89410..4ac5cae9 100644 --- a/devbook.xsl +++ b/devbook.xsl @@ -337,6 +337,11 @@ + + + + + diff --git a/devmanual.css b/devmanual.css index d6365858..90b76336 100644 --- a/devmanual.css +++ b/devmanual.css @@ -66,6 +66,12 @@ h4:hover > a.permalink { max-width: 200px; } +.pkg-icon { + color: grey; + margin-left: 0.1em; + font-size: 70%; +} + /* compatible to Bootstrap 4 for future migration */ .d-inline-block { display: inline-block; diff --git a/ebuild-writing/eapi/text.xml b/ebuild-writing/eapi/text.xml index b565b43f..fc145b5a 100644 --- a/ebuild-writing/eapi/text.xml +++ b/ebuild-writing/eapi/text.xml @@ -34,7 +34,7 @@ This section provides usage and descriptions of the different EAPIs. An overview about the important features of each EAPI is provided in the appendix of the Package Manager Specification. The two-page leaflet can be printed out, consulted for reference and is available -as app-doc/pms in the main tree. +as app-doc/pms in the main tree.

@@ -1400,7 +1400,7 @@ $(usev foo --enable-foo)

Obviously, adding a second argument to hasv was not possible, so its - behaviour would have become inconsistent with usev in EAPI 8. Since + behaviour would have become inconsistent with usev in EAPI 8. Since hasv was not used in the Gentoo repository, it has been removed, along with hasq and useq which were considered deprecated since 2011. diff --git a/ebuild-writing/functions/src_compile/building/text.xml b/ebuild-writing/functions/src_compile/building/text.xml index 0b8cc0d6..0f6c8956 100644 --- a/ebuild-writing/functions/src_compile/building/text.xml +++ b/ebuild-writing/functions/src_compile/building/text.xml @@ -94,8 +94,8 @@ would break its syntax.

Portage performs a QA check which verifies if LDFLAGS are respected. This QA check is enabled only when LDFLAGS variable contains -Wl,--hash-style=gnu. -(This flag can be used only on systems which use sys-libs/glibc except for -machines with a MIPS CPU.) +(This flag can be used only on systems which use sys-libs/glibc except +for machines with a MIPS CPU.)

diff --git a/ebuild-writing/functions/src_unpack/other-formats/text.xml b/ebuild-writing/functions/src_unpack/other-formats/text.xml index 3853dbd4..ef17b3a0 100644 --- a/ebuild-writing/functions/src_unpack/other-formats/text.xml +++ b/ebuild-writing/functions/src_unpack/other-formats/text.xml @@ -19,7 +19,7 @@ If a package is supplied as a .zip file, you should:

    -
  • BDEPEND upon app-arch/unzip
    • +
  • BDEPEND upon app-arch/unzip
  • Use unpack as normal
diff --git a/ebuild-writing/functions/src_unpack/vcs-sources/text.xml b/ebuild-writing/functions/src_unpack/vcs-sources/text.xml index 1e34727e..b069f63b 100644 --- a/ebuild-writing/functions/src_unpack/vcs-sources/text.xml +++ b/ebuild-writing/functions/src_unpack/vcs-sources/text.xml @@ -60,7 +60,7 @@ following reasons:

It is safer (and better for the user) to make a snapshot instead. For example, -app-editors/emacs snapshots are made using: +app-editors/emacs snapshots are made using: 

diff --git a/ebuild-writing/misc-files/metadata/text.xml b/ebuild-writing/misc-files/metadata/text.xml
index c585faf5..86302563 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -104,8 +104,8 @@ metadata.xml:
 
   <description>
   
-    The description tag contains a description of the maintainership, or for 
-    example a remark that someone interested can take over the maintainership. 
+    The description tag contains a description of the maintainership, or for
+    example a remark that someone interested can take over the maintainership.
     It is optional.
   
 
@@ -330,7 +330,7 @@ There are also some attributes that can be used with these tags:
   
     A string identifying the type of upstream source. A list of valid strings are kept in
     metadata.dtd.
-    Developers should email the gentoo-dev mailing list before using a new type value. 
+    Developers should email the gentoo-dev mailing list before using a new type value.
   
 
 
@@ -364,7 +364,7 @@ For developers' convenience, a skeleton file is provided in the
 Gentoo tree with the name
 
 skel.metadata.xml. The metadata file can also be created
-using the app-portage/metagen tool.
+using the app-portage/metagen tool.
 

 
 

diff --git a/keywording/maintenance/text.xml b/keywording/maintenance/text.xml
index 228f0707..e0be0302 100644
--- a/keywording/maintenance/text.xml
+++ b/keywording/maintenance/text.xml
@@ -34,8 +34,8 @@ When demoting an entire architecture from stable (arch) to testing
     qkeyword --all "${ARCH}" | cut -f1 -d" " | xargs -n 250 qatom
     -F "%{CATEGORY}/%{PN}/%{PF}.ebuild" | xargs ekeyword "~${ARCH}"
     (qkeyword and qatom are tools from
-    app-portage/portage-utils, while ekeyword is provided by
-    app-portage/gentoolkit).
+    app-portage/portage-utils, while ekeyword is provided by
+    app-portage/gentoolkit).
   
   
  • 
     Update any eclasses that define shared KEYWORDS variables. Currently,