From: "Ulrich Müller" <ulm@gentoo.org>
To: gentoo-commits@lists.gentoo.org
Subject: [gentoo-commits] proj/devmanual:master commit in: ebuild-maintenance/maintenance-tasks/, ebuild-writing/common-mistakes/, ...
Date: Mon, 9 Dec 2019 21:39:56 +0000 (UTC) [thread overview]
Message-ID: <1575804724.e2a34ce393ae620d239330d73cba9153ed7fdd13.ulm@gentoo> (raw)
commit: e2a34ce393ae620d239330d73cba9153ed7fdd13
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Wed Dec 4 17:18:45 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=e2a34ce3
Drop caption attribute from <pre> elements.
This isn't processed by devbook.xsl and doesn't show up in the output.
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
ebuild-maintenance/git/text.xml | 6 +++---
ebuild-maintenance/maintenance-tasks/text.xml | 8 ++++----
ebuild-writing/common-mistakes/text.xml | 8 ++++----
ebuild-writing/user-submitted/text.xml | 2 +-
4 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/ebuild-maintenance/git/text.xml b/ebuild-maintenance/git/text.xml
index ee32c9c..ba811ac 100644
--- a/ebuild-maintenance/git/text.xml
+++ b/ebuild-maintenance/git/text.xml
@@ -63,7 +63,7 @@ To ensure that the Gentoo policies are followed, you should set the following
configuration variables:
</p>
-<pre caption="Configuring git for the Gentoo repository">
+<pre>
git config --local user.name "${YOUR_FULL_NAME}"
# use your @gentoo.org address even if you have a different default
git config --local user.email "${YOUR_NICKNAME}@gentoo.org"
@@ -89,7 +89,7 @@ To include the converted CVS history in the git repository, you can
graft it into the repository:
</p>
-<pre caption="Grafting the history into git">
+<pre>
git remote add history https://anongit.gentoo.org/git/repo/gentoo/historical.git/
git fetch history
git replace --graft 56bd759df1d0c750a065b8c845e93d5dfa6b549d history/master
@@ -305,7 +305,7 @@ message.
An example commit message is shown below:
</p>
-<pre caption="Example commit message">
+<pre>
app-misc/foo: version bump to 0.5
This also adds a new USE flag 'bar' which controls the
diff --git a/ebuild-maintenance/maintenance-tasks/text.xml b/ebuild-maintenance/maintenance-tasks/text.xml
index 92dd0a0..50fe2f2 100644
--- a/ebuild-maintenance/maintenance-tasks/text.xml
+++ b/ebuild-maintenance/maintenance-tasks/text.xml
@@ -257,7 +257,7 @@ the latest file in <path>profiles/updates/</path> in the
following format:
</p>
-<pre caption="Adding an entry to updates">
+<pre>
move old-category/package-name new-category/package-name
</pre>
@@ -350,7 +350,7 @@ also need to create a new entry in <path>profiles/updates/</path> in
the Gentoo repository in the following format:
</p>
-<pre caption="Adding an entry to updates">
+<pre>
slotmove app-text/gtkspell 0 2
</pre>
@@ -423,7 +423,7 @@ Here is a list of commands that will delete <path>dev-util/pmk</path>
from the tree:
</p>
-<pre caption="Removing a package from git">
+<pre>
# cd dev-qt
# git rm -rf qtphonon
# git commit --gpg-sign
@@ -433,7 +433,7 @@ from the tree:
An example commit message is shown below:
</p>
-<pre caption="Package removal commit message">
+<pre>
commit b97eb6d43f45dfd5b739638928db22d3f3392685
Author: Michael Palimaka <kensington@gentoo.org>
Date: Tue Oct 3 21:43:03 2017 +1100
diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
index dbf6eee..cee330d 100644
--- a/ebuild-writing/common-mistakes/text.xml
+++ b/ebuild-writing/common-mistakes/text.xml
@@ -179,7 +179,7 @@ skel.ebuild</uri>.
The first two lines <e>must</e> look like this:
</p>
-<pre caption="Valid Header">
+<pre>
# Copyright 1999-2019 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2
</pre>
@@ -222,7 +222,7 @@ number is not consistent with the tarball/source, then use MY_P. An example
dev-python/pyopenal fetches a tarball called PyOpenAL, so we redefine it like:
</p>
-<pre caption="Example versioning redefinition">
+<pre>
MY_P=${P/pyopenal/PyOpenAL}
SRC_URI="http://download.gna.org/pyopenal/${MY_P}.tar.gz"
S=${WORKDIR}/${MY_P}
@@ -352,7 +352,7 @@ Make sure you have the SLOT variable in the ebuild. If you don't plan to use it,
don't remove it. Put in:
</p>
-<pre caption="Default SLOT variable">
+<pre>
SLOT="0"
</pre>
@@ -503,7 +503,7 @@ It is wise to submit a diff for a package update rather than the whole ebuild.
The best way to generate it would be:
</p>
-<pre caption="Creating a diff">
+<pre>
$ <i>diff -u some-package-0.1.0.ebuild some-package-0.2.0.ebuild > ~/some-package-0.2.0.diff</i>
</pre>
diff --git a/ebuild-writing/user-submitted/text.xml b/ebuild-writing/user-submitted/text.xml
index 68c88f0..2f384ca 100644
--- a/ebuild-writing/user-submitted/text.xml
+++ b/ebuild-writing/user-submitted/text.xml
@@ -16,7 +16,7 @@ the ebuild meets all Gentoo Linux development standards.
The user-submitted ebuild must not contain custom headers like this:
</p>
-<pre caption="A custom header that should be included in the commit message instead">
+<pre>
# Ebuild updated by: me <me@example.com>
</pre>
reply other threads:[~2019-12-09 21:40 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1575804724.e2a34ce393ae620d239330d73cba9153ed7fdd13.ulm@gentoo \
--to=ulm@gentoo.org \
--cc=gentoo-commits@lists.gentoo.org \
--cc=gentoo-dev@lists.gentoo.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox