commit: effdb12f3d34ac5497d8d4ff109e7e9f35996c1f
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Wed Dec 4 16:04:52 2019 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Sun Dec 8 11:32:03 2019 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=effdb12f
Fix nesting of elements.
- Lists inside <p> are not allowed.
- <ul> is not a direct child of <ul>; it must be inside <li>.
- <p>, <note>, etc. are no children of <p>.
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-maintenance/git/text.xml | 6 ++--
ebuild-writing/eapi/text.xml | 35 ++++++++++------------
ebuild-writing/file-format/text.xml | 2 +-
ebuild-writing/functions/pkg_pretend/text.xml | 2 +-
.../functions/src_prepare/epatch/text.xml | 3 +-
ebuild-writing/misc-files/metadata/text.xml | 3 +-
ebuild-writing/variables/text.xml | 2 +-
general-concepts/autotools/text.xml | 6 ++--
general-concepts/dependencies/text.xml | 2 --
general-concepts/filesystem/text.xml | 14 +++++----
general-concepts/projects/text.xml | 2 ++
general-concepts/virtuals/text.xml | 2 ++
tasks-reference/pam/text.xml | 12 ++++----
13 files changed, 47 insertions(+), 44 deletions(-)
diff --git a/ebuild-maintenance/git/text.xml b/ebuild-maintenance/git/text.xml
index 8c83344..70fa46a 100644
--- a/ebuild-maintenance/git/text.xml
+++ b/ebuild-maintenance/git/text.xml
@@ -216,6 +216,7 @@ change followed by a colon ':' character. Use the rules in
the
following list to determine the proper format based on what has
changed, substituting the package, category and eclass names
appropriately:
+</p>
<ul>
<li><c>${CATEGORY}/${PN}:</c>Single Package (Note that <c>repoman commit</c>
@@ -227,6 +228,7 @@ automatically inserts this for you)</li>
<li><c>metadata:</c> Metadata Directory</li>
</ul>
+<p>
For packages where <c>${CATEGORY}/${PN}:</c> is long, the line length
limit can be exceeded, if absolutely necessary, to ensure a more
useful summary line. If a commit affects multiple directories, prepend
@@ -235,6 +237,7 @@ there are any bugs on Gentoo Bugzilla associated with the
commit, id
of the bug can be appended to the summary line using the format
<c>#BUG-ID</c>. If you are modifying keywords, clearly state what
keywords are added/removed.
+</p>
<warning>
By default, lines starting with <c>#</c> are considered to be comments
@@ -243,7 +246,6 @@ line does not start with <c>#BUG-ID</c>. Optionally, git
can be
configured to use a different character for comments by changing the
<c>commentchar</c> option.
</warning>
-</p>
<p>
For non-trivial commits, the message should contain a detailed
@@ -260,6 +262,7 @@ explained in the
<uri link="https://kernel.org/doc/html/latest/process/submitting-patches.html";>
Linux Kernel patch guideline</uri>. Additionally, the following tags
are optionally used in Gentoo:
+</p>
<ul>
<li><c>Bug:</c> Use this to reference bugs <e>without</e> closing them.
@@ -281,7 +284,6 @@ automatically with reference to the commit.</li>
<c>repoman commit</c> and records the options passed to repoman (such
as --force) for the commit.</li>
</ul>
-</p>
<p>
Additionally, some developers prefer referencing bugs on the summary
diff --git a/ebuild-writing/eapi/text.xml b/ebuild-writing/eapi/text.xml
index 5992c59..84db3cb 100644
--- a/ebuild-writing/eapi/text.xml
+++ b/ebuild-writing/eapi/text.xml
@@ -93,13 +93,13 @@ src_compile() {
</p>
<p>
<b>SLOT dependency examples:</b>
+ </p>
<ul>
<li><c>x11-libs/qt:3</c></li>
<li><c>~x11-libs/qt-3.3.8:3</c></li>
<li><c>>=x11-libs/qt-3.3.8:3</c></li>
<li><c>=x11-libs/qt-3.3*:3</c></li>
</ul>
- </p>
</li>
<li>
<p><b>IUSE defaults</b></p>
@@ -145,13 +145,13 @@ IUSE="foo +bar"
<p>
<c>doman</c> automatically detects language codes and puts it
in the
appropriate directory.
+ </p>
<codesample lang="ebuild">
doman foo.1
# will go into /usr/share/man/man1/foo.1
doman foo.lang.1
# will go into /usr/share/man/lang/man1/foo.1 with EAPI=2
</codesample>
- </p>
</li>
</ul>
</body>
@@ -163,7 +163,6 @@ doman foo.lang.1
<ul>
<li>
<p><b>Blockers</b></p>
- <p>
<ul>
<li>
<p><b>New Meaning for Old Syntax</b></p>
@@ -193,14 +192,13 @@ doman foo.lang.1
</p>
</li>
</ul>
- </p>
</li>
<li>
<p><b>USE Dependencies</b></p>
<p>
It is possible to depend on USE-flags of packages.
</p>
- <p>Examples:
+ <p>Examples:</p>
<ul>
<li><c>foo[bar]</c> means that package foo must have
USE-flag bar
enabled</li>
@@ -214,7 +212,6 @@ doman foo.lang.1
<li><c>foo[bar=]</c> means <c>bar? ( foo[bar] ) !bar? (
foo[-bar] )</c></li>
<li><c>foo[!bar=]</c> means <c>bar? ( foo[-bar] ) !bar?
( foo[bar] )</c></li>
</ul>
- </p>
</li>
<li>
<p><b>Customization of Output File Names in SRC_URI</b></p>
@@ -256,7 +253,7 @@
SRC_URI="https://dl.google.com/earth/client/GE4/release_4_3/GoogleEarthLinux.bin
<c>src_compile</c> functions.
</p>
<p>The default <c>src_configure</c> and <c>src_compile</c>
- functions in EAPI=2:
+ functions in EAPI=2:</p>
<codesample lang="ebuild">
src_configure() {
if [[ -x ${ECONF_SOURCE:-.}/configure ]] ; then
@@ -270,11 +267,9 @@ src_compile() {
fi
}
</codesample>
- </p>
</li>
<li>
<p><b>Execution Order of Phase Functions</b></p>
- <p>
<ul>
<li><c>pkg_setup</c></li>
<li><c>src_unpack</c></li>
@@ -288,7 +283,6 @@ src_compile() {
<li><c>pkg_prerm</c></li>
<li><c>pkg_postrm</c></li>
</ul>
- </p>
</li>
<li>
<p><b>Default Phase Functions</b></p>
@@ -299,7 +293,7 @@ src_compile() {
call to a function with the name <c>default_src_compile</c> is
equivalent
to a call to the default <c>src_compile</c> implementation.
</p>
- <p>The default phase functions are:
+ <p>The default phase functions are:</p>
<ul>
<li><c>default_pkg_nofetch</c></li>
<li><c>default_src_unpack</c></li>
@@ -308,7 +302,6 @@ src_compile() {
<li><c>default_src_compile</c></li>
<li><c>default_src_test</c></li>
</ul>
- </p>
</li>
<li>
<p><b>Default Phase Function Alias</b></p>
@@ -440,15 +433,19 @@ src_install() {
To control which items should be compressed and which
shouldn't
be compressed, you may include or exclude directories
or plain
files. The default inclusion list contains:
+ </p>
<ul>
<li><c>/usr/share/doc</c></li>
<li><c>/usr/share/info</c></li>
<li><c>/usr/share/man</c></li>
</ul>
+ <p>
The default exclusion list contains:
+ </p>
<ul>
<li><c>/usr/share/doc/${PF}/html</c></li>
</ul>
+ <p>
When a directory is in- or excluded, all files and
directories in
the given directories shall be added to the
corresponding list.
If a file is in- or excluded, the file shall be added
to the
@@ -484,13 +481,13 @@ src_install() {
case the use-flag does not exist in the given package.
The
<c>(+)</c> means that this use-flag is assumed to be
enabled,
<c>(-)</c> the opposite.
+ </p>
<p>Example:</p>
<codesample lang="ebuild">
DEPEND="
>=dev-libs/boost-1.32[boost(+)]
sys-devel/gcc[openmp(-)]"
</codesample>
- </p>
</li>
</ul>
</body>
@@ -509,6 +506,7 @@ DEPEND="
and before installing them).
This phase typically checks for a kernel configuration
and may
<c>eerror</c> and <c>die</c> when needed.
+ </p>
<important>
There is no guarantee that the ebuild's
dependencies are installed
when this phase is called.
@@ -517,7 +515,6 @@ DEPEND="
As <c>pkg_pretend</c> is not called in the main
phase function
sequence, environment saving is not guaranteed.
</important>
- </p>
<p>Example:</p>
<codesample lang="ebuild">
# Copyright 1999-2019 Gentoo Authors
@@ -624,6 +621,7 @@ src_install() {
<p>
The <c>MERGE_TYPE</c> variable contains the type of
package that
is being merged. Possible values are:
+ </p>
<dl>
<dt><c>source</c></dt>
<dd><p>
@@ -638,7 +636,6 @@ src_install() {
if building a binary package without
installing it.
</p></dd>
</dl>
- </p>
</li>
<li>
<p><b>DOCS</b></p>
@@ -778,7 +775,6 @@ RDEPEND="dev-libs/foo:2=
</li>
<li>
<p><b>New usex helper function</b></p>
- <p>
<!-- We probably need an example here -->
<pre>
USAGE: usex <USE flag> [true output] [false output] [true suffix] [false
suffix]
@@ -786,7 +782,6 @@ DESCRIPTION:
If USE flag is set, echo [true output][true suffix] (defaults to "yes"),
otherwise echo [false output][false suffix] (defaults to "no").
</pre>
- </p>
</li>
</ul>
</body>
@@ -862,6 +857,7 @@ If USE flag is set, echo [true output][true suffix]
(defaults to "yes"),
<p><b>Update default implementation of
<c>src_prepare</c></b></p>
<p>
This phase is no longer a no-op, it supports applying
patches via the <c>PATCHES</c> variable and applying user patches via
<c>eapply_user</c>. The default <c>src_prepare</c> looks like this:
+ </p>
<codesample lang="ebuild">
src_prepare() {
if declare -p PATCHES | grep -q "^declare -a "; then
@@ -872,12 +868,12 @@ src_prepare() {
eapply_user
}
</codesample>
- </p>
</li>
<li>
<p><b>New <c>src_install</c> Phase Function</b></p>
<p>
This phase uses the new <c>einstalldocs</c> function
for installation of documentation. The default <c>src_install</c> looks like
this:
+ </p>
<codesample lang="ebuild">
src_install() {
if [[ -f Makefile ]] || [[ -f GNUmakefile ]] || [[ -f makefile ]]; then
@@ -886,7 +882,6 @@ src_install() {
einstalldocs
}
</codesample>
- </p>
</li>
</ul>
</body>
@@ -924,8 +919,8 @@ src_install() {
<p><b><c>eapply_user</c> support</b></p>
<p>
The <c>eapply_user</c> command permits the package
manager to apply user-provided patches. It must be called from every
<c>src_prepare</c> function.
- <note><c>eapply_user</c> doesn't need to be called
explicitly when default <c>src_prepare</c> is called.</note>
</p>
+ <note><c>eapply_user</c> doesn't need to be called
explicitly when default <c>src_prepare</c> is called.</note>
</li>
<li>
<p><b><c>econf</c> adds <c>--docdir</c> and
<c>--htmldir</c></b></p>
diff --git a/ebuild-writing/file-format/text.xml
b/ebuild-writing/file-format/text.xml
index f9e4bd9..6c199e0 100644
--- a/ebuild-writing/file-format/text.xml
+++ b/ebuild-writing/file-format/text.xml
@@ -88,6 +88,7 @@ Any of these suffixes may be followed by an unsigned integer.
<p>
These suffixes can be chained together and will be processed iteratively. To
give some examples (the following list is from lowest version to highest):
+</p>
<ul>
<li>foo-1.0.0_alpha_pre</li>
@@ -95,7 +96,6 @@ give some examples (the following list is from lowest version
to highest):
<li>foo-1.0.0_beta_pre</li>
<li>foo-1.0.0_beta_p1</li>
</ul>
-</p>
<p>
No integer part of the version may be longer than 18 digits.
diff --git a/ebuild-writing/functions/pkg_pretend/text.xml
b/ebuild-writing/functions/pkg_pretend/text.xml
index e0c454c..e21a1c2 100644
--- a/ebuild-writing/functions/pkg_pretend/text.xml
+++ b/ebuild-writing/functions/pkg_pretend/text.xml
@@ -73,6 +73,7 @@ executed after the package manager has calculated the
dependencies
and before installing them).
This phase typically checks for a kernel configuration and may
<c>eerror</c> and <c>die</c> when needed.
+</p>
<important>
There is no guarantee that the ebuild's dependencies are installed
when this phase is called.
@@ -81,7 +82,6 @@ This phase typically checks for a kernel configuration and may
As <c>pkg_pretend</c> is not called in the main phase function
sequence, environment saving is not guaranteed.
</important>
-</p>
</body>
</section>
diff --git a/ebuild-writing/functions/src_prepare/epatch/text.xml
b/ebuild-writing/functions/src_prepare/epatch/text.xml
index b0a257d..0bd0938 100644
--- a/ebuild-writing/functions/src_prepare/epatch/text.xml
+++ b/ebuild-writing/functions/src_prepare/epatch/text.xml
@@ -21,6 +21,8 @@ Starting with EAPI=7, this function is banned and
<c>eapply</c> must be used.
Beginning with EAPI=6, a new function <c>eapply</c> was added to apply patches
without the need for an eclass.
This function differs from epatch in several ways:
+</p>
+
<ul>
<li><c>eapply</c> will not unpack patches for you.</li>
<li>
@@ -32,7 +34,6 @@ When specifying a directory, at least one file with a name
ending in .patch or .
must exist or the command fails. Other files are ignored.
</li>
</ul>
-</p>
<p>
Note that distributing modified tarballs rather than a vanilla tarball
diff --git a/ebuild-writing/misc-files/metadata/text.xml
b/ebuild-writing/misc-files/metadata/text.xml
index 56229f0..7260e48 100644
--- a/ebuild-writing/misc-files/metadata/text.xml
+++ b/ebuild-writing/misc-files/metadata/text.xml
@@ -24,6 +24,8 @@ The character set <b>must</b> be UTF-8 as specified by
<p>
Concerning indentation there is no strict rule governing the style and
width. However the following minimal set of rules need to be followed:
+</p>
+
<ul>
<li>
Indentation should be consistent, i.e. either spaces or tabs, but
@@ -34,7 +36,6 @@ width. However the following minimal set of rules need to be
followed:
belong to other developers.
</li>
</ul>
-</p>
<p>
The following table summarizes the tags that may appear in a
diff --git a/ebuild-writing/variables/text.xml
b/ebuild-writing/variables/text.xml
index caa7cf0..7e1d37b 100644
--- a/ebuild-writing/variables/text.xml
+++ b/ebuild-writing/variables/text.xml
@@ -531,6 +531,7 @@ build system.
Below is an example of an ebuild that uses <c>ROOT</c> in
<c>pkg_postinst()</c> to conditionally print an error message if an
old and obsolete configuration file still exists:
+</p>
<codesample lang="ebuild">
pkg_postinst() {
@@ -542,7 +543,6 @@ pkg_postinst() {
fi
}
</codesample>
-</p>
</body>
</section>
diff --git a/general-concepts/autotools/text.xml
b/general-concepts/autotools/text.xml
index 02d8b30..8be8d34 100644
--- a/general-concepts/autotools/text.xml
+++ b/general-concepts/autotools/text.xml
@@ -659,8 +659,7 @@ For more details on autotools:
<li>
The GNU documentation for the various autotools components is of varying
quality and completeness:
- </li>
- <ul>
+ <ul>
<li>
<uri link="https://www.gnu.org/software/automake/manual/automake.html";>
GNU automake Manual
@@ -678,7 +677,8 @@ For more details on autotools:
<li>
<uri link="https://autotools.io";>Autotools Mythbuster</uri>
</li>
- </ul>
+ </ul>
+ </li>
<li>
There are some good overview lectures available online. <uri
link="http://www.shlomifish.org/lecture/Autotools/";>These
diff --git a/general-concepts/dependencies/text.xml
b/general-concepts/dependencies/text.xml
index 9d44d68..d1d6db2 100644
--- a/general-concepts/dependencies/text.xml
+++ b/general-concepts/dependencies/text.xml
@@ -148,7 +148,6 @@ This states that at least version 0.9.7d of <c>openssl</c>
is required.
Available version specifiers are:
</p>
-<p>
<table>
<tr>
<th>Specifier</th>
@@ -182,7 +181,6 @@ Available version specifiers are:
<ti>A version strictly before 1.23 is required.</ti>
</tr>
</table>
-</p>
</body>
</subsection>
diff --git a/general-concepts/filesystem/text.xml
b/general-concepts/filesystem/text.xml
index ab9b354..2163bf3 100644
--- a/general-concepts/filesystem/text.xml
+++ b/general-concepts/filesystem/text.xml
@@ -15,20 +15,22 @@ The basic filesystem layout and purpose is as follows:
<li><c>/opt</c>: Binary-only applications.</li>
<li><c>/sbin</c>: System administrator boot-critical applications</li>
<li><c>/tmp</c>: Temporary data</li>
- <li><c>/usr</c>: General applications</li>
- <ul>
+ <li><c>/usr</c>: General applications
+ <ul>
<li><c>/usr/bin</c>: Applications</li>
<li><c>/usr/lib</c>: Libraries</li>
<li><c>/usr/local</c>: Non-portage applications. <b>Ebuilds must not
install here</b>.</li>
<li><c>/usr/sbin</c>: Non-system-critical system administrator
applications</li>
<li><c>/usr/share</c>: Architecture independent application data and
documentation</li>
- </ul>
- <li><c>/var</c>: Program generated data</li>
- <ul>
+ </ul>
+ </li>
+ <li><c>/var</c>: Program generated data
+ <ul>
<li><c>/var/cache</c>: Long term data which can be regenerated</li>
<li><c>/var/lib</c>: General application generated data</li>
<li><c>/var/log</c>: Log files</li>
- </ul>
+ </ul>
+ </li>
</ul>
<p>
diff --git a/general-concepts/projects/text.xml
b/general-concepts/projects/text.xml
index b725ed3..ee501b9 100644
--- a/general-concepts/projects/text.xml
+++ b/general-concepts/projects/text.xml
@@ -36,6 +36,7 @@ api.gentoo.org</uri> or on the
<p>
According to the metastructure any developer may create a new
project. There are two procedures involved in starting a new project:
+</p>
<ol>
<li>
@@ -49,6 +50,7 @@ project. There are two procedures involved in starting a new
project:
</li>
</ol>
+<p>
There is no approval required for the RFC and negative comments do not
block a developer from creating a project. Competing projects are
allowed to co-exist in Gentoo; existence of another project with
diff --git a/general-concepts/virtuals/text.xml
b/general-concepts/virtuals/text.xml
index 8eb9675..4f8b96d 100644
--- a/general-concepts/virtuals/text.xml
+++ b/general-concepts/virtuals/text.xml
@@ -21,6 +21,7 @@ Before adding a new virtual, it should be discussed on
<c>gentoo-dev</c>.
<p>
An example of a virtual:
+</p>
<codesample lang="ebuild">
EAPI=4
@@ -32,6 +33,7 @@ KEYWORDS="alpha amd64 arm hppa ia64 ~mips ppc ppc64 ~s390
sparc x86 ~x86-fbsd"
RDEPEND="|| ( >=sys-devel/gcc-4.1 dev-libs/boost )"
</codesample>
+<p>
Looks familar...right? It should since its going to look just like a regular
ebuild.
</p>
diff --git a/tasks-reference/pam/text.xml b/tasks-reference/pam/text.xml
index ed35d28..6aa04d6 100644
--- a/tasks-reference/pam/text.xml
+++ b/tasks-reference/pam/text.xml
@@ -40,8 +40,7 @@ The statement is composed of 3 or 4 tokens:
<li>
The first token specifies the type of service for which the statement is
done.
There are four types:
- </li>
- <ul>
+ <ul>
<li>
<e>account</e>, which checks for validity of the user account.
</li>
@@ -57,12 +56,12 @@ The statement is composed of 3 or 4 tokens:
mount/umount of home directories, executed both before starting and after
closing the user session.
</li>
- </ul>
+ </ul>
+ </li>
<li>
The second token is the control that tells PAM how to behave with failures
and
success of the authentication for the module specified:
- </li>
- <ul>
+ <ul>
<li>
<e>requisite</e>, a failure results in the termination of the process.
</li>
@@ -79,7 +78,8 @@ The statement is composed of 3 or 4 tokens:
not the only module present, in which case a success or a failure of it
makes the authentication succeed or fail.
</li>
- </ul>
+ </ul>
+ </li>
<li>
The third token is the module to execute for that type of service; PAM
modules
are extensible and, as the name says, pluggable. The result is that there
are
