commit: 18bf92b7ef4b09b58add33d4ce40a965c05b2f49
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Wed Dec 4 17:08:48 2019 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Sun Dec 8 11:32:04 2019 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=18bf92b7
Element <br> is not supported.
Replace by paragraph break, or drop.
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
appendices/contributing/devbook-guide/text.xml | 4 +++-
ebuild-writing/common-mistakes/text.xml | 20 ++++++++++----------
ebuild-writing/eapi/text.xml | 4 ++--
ebuild-writing/functions/src_prepare/epatch/text.xml | 8 ++++++--
function-reference/install-functions/text.xml | 2 +-
5 files changed, 22 insertions(+), 16 deletions(-)
diff --git a/appendices/contributing/devbook-guide/text.xml
b/appendices/contributing/devbook-guide/text.xml
index d1225d6..5aa5525 100644
--- a/appendices/contributing/devbook-guide/text.xml
+++ b/appendices/contributing/devbook-guide/text.xml
@@ -71,7 +71,9 @@ document and specifies its DTD. The <c><!--
$Header$ --></c> line
will be automatically modified by the CVS server and helps to track revisions.
Next, there's a <c><guide></c> tag -- the entire guide document is
enclosed within a <c><guide> </guide></c> pair.
-<br/>
+</p>
+
+<p>
The <c>lang</c> attribute should be used to specify the language code of your
document. It is used to format the date and insert strings like "<e>Note</e>",
"<e>Content</e>", etc. in the specified language. The default is English.
diff --git a/ebuild-writing/common-mistakes/text.xml
b/ebuild-writing/common-mistakes/text.xml
index 026e1d9..dbf6eee 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -242,22 +242,22 @@ part.
<ul>
<li>
- <e>Always include the CATEGORY.</e><br />
+ <e>Always include the CATEGORY.</e>
For example, use <c>>=x11-libs/gtk+-2</c> and not <c>>=gtk+-2</c>.
</li>
<li>
- <e>Do not put an asterisk (*) for >= dependencies.</e><br />
+ <e>Do not put an asterisk (*) for >= dependencies.</e>
For example, it should be <c>>=x11-libs/gtk+-2</c> rather than
<c>>=x11-libs/gtk+-2*</c>.
</li>
<li><e>GTK specific. Always use =x11-libs/gtk+-1.2* for GTK+1 apps.</e></li>
<li>
- <e>Never depend on a meta package.</e><br />
+ <e>Never depend on a meta package.</e>
So don't depend on gnome-base/gnome, always depend on the specific
libraries like libgnome.
</li>
<li>
- <e>One dependency per line.</e><br />
+ <e>One dependency per line.</e>
Don't put multiple dependency on the same line. It makes it ugly to read
and hard to follow.
</li>
@@ -277,29 +277,29 @@ some tips on how to find the correct dependencies.
<ul>
<li>
- <e>Look in configure.in or configure.ac</e><br />
+ <e>Look in configure.in or configure.ac.</e>
Look for checks for packages in here. Things to look out for are pkg-config
checks or AM_* functions that check for a specific version.
</li>
<li>
- <e>Look at included .spec files</e><br />
+ <e>Look at included .spec files.</e>
A good indication of dependencies is to look at the included .spec files
for relevant deps. However, do not trust them to be the definitive complete
- list of dependencies
+ list of dependencies.
</li>
<li>
- <e>Look at the application/library website</e><br />
+ <e>Look at the application/library website.</e>
Check the application website for possible dependencies that they suggest
are needed.
</li>
<li>
- <e>Read the README and INSTALL for the package</e><br />
+ <e>Read the README and INSTALL for the package.</e>
They usually also contain useful information about building and installing
packages.
</li>
<li>
<e>Remember non-binary dependencies such as pkg-config, doc generation
- programs, etc.</e><br />
+ programs, etc.</e>
Usually the build process requires some dependencies such as intltool,
libtool, pkg-config, doxygen, scrollkeeper, gtk-doc, etc. Make sure those
are clearly stated.
diff --git a/ebuild-writing/eapi/text.xml b/ebuild-writing/eapi/text.xml
index 84db3cb..3f9590d 100644
--- a/ebuild-writing/eapi/text.xml
+++ b/ebuild-writing/eapi/text.xml
@@ -1110,8 +1110,8 @@ src_install() {
<p><b>New function <c>dostrip</c></b></p>
<p>
The <c>dostrip</c> helper has been added with
<c>EAPI=7</c>.
- This function controls whether or not to strip a
binary.<br />
- <c>dostrip -x [file]</c> will exclude a binary from
being stripped.<br />
+ This function controls whether or not to strip a binary.
+ <c>dostrip -x [file]</c> will exclude a binary from
being stripped.
Conversely, when combined with RESTRICT=strip,
<c>dostrip [file]</c> selects a binary
file to be stripped.
</p>
diff --git a/ebuild-writing/functions/src_prepare/epatch/text.xml
b/ebuild-writing/functions/src_prepare/epatch/text.xml
index 0bd0938..59987fc 100644
--- a/ebuild-writing/functions/src_prepare/epatch/text.xml
+++ b/ebuild-writing/functions/src_prepare/epatch/text.xml
@@ -9,11 +9,15 @@ The canonical way of applying patches in ebuilds is to
use <c>epatch</c> (from <c>epatch.eclass</c>, which you must make sure
to inherit!) inside <c>src_prepare</c>. This function automatically
handles <c>-p</c> levels, <c>gunzip</c> and so on as necessary.
-<br />
+</p>
+
+<p>
Also note that old ebuilds may still use src_unpack to apply patches.
This is because those ebuilds are based in EAPI=1.
You are advised to use the latest and apply your patches in src_prepare
function instead.
-<br />
+</p>
+
+<p>
Starting with EAPI=7, this function is banned and <c>eapply</c> must be used.
</p>
diff --git a/function-reference/install-functions/text.xml
b/function-reference/install-functions/text.xml
index 06bc241..cdc7b48 100644
--- a/function-reference/install-functions/text.xml
+++ b/function-reference/install-functions/text.xml
@@ -245,7 +245,7 @@ the first is the source name, the second the name to use
when installing.
<c>domo</c>
</ti>
<ti>
- Install a Gettext <c>.mo</c> file<br />
+ Install a Gettext <c>.mo</c> file.
(EAPI=7) No longer looks at the value of <c>into</c>
</ti>
</tr>
