Gentoo Archives: gentoo-commits

From: "Göktürk Yüksek" <gokturk@g.o>
To: gentoo-commits@l.g.o
Subject: [gentoo-commits] proj/devmanual:devbook-guide commit in: appendices/contributing/devbook-guide/
Date: Sat, 29 Jul 2017 20:55:36
Message-Id: 1501360876.9409ed6f32c3e5148b1c77c62862916a747c7b6e.gokturk@gentoo
1 commit: 9409ed6f32c3e5148b1c77c62862916a747c7b6e
2 Author: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
3 AuthorDate: Sat Jul 29 20:41:16 2017 +0000
4 Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
5 CommitDate: Sat Jul 29 20:41:16 2017 +0000
6 URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=9409ed6f
7
8 appendices/contributing/devbook-guide: remove the <comment> tag
9
10 It has no use in devmanual.
11
12 appendices/contributing/devbook-guide/text.xml | 23 +++--------------------
13 1 file changed, 3 insertions(+), 20 deletions(-)
14
15 diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
16 index 971dddd..85a3390 100644
17 --- a/appendices/contributing/devbook-guide/text.xml
18 +++ b/appendices/contributing/devbook-guide/text.xml
19 @@ -218,8 +218,6 @@ This is text output or code.
20
21 Make HTML/XML easier to read by using selective emphasis:
22 &lt;foo&gt;&lt;i&gt;bar&lt;/i&gt;&lt;/foo&gt;
23 -
24 -&lt;comment&gt;(This is how to insert a comment into a code block)&lt;/comment&gt;
25 &lt;/pre&gt;
26
27 &lt;note&gt;
28 @@ -251,8 +249,6 @@ This is text output or code.
29
30 Make HTML/XML easier to read by using selective emphasis:
31 &lt;foo&gt;<i>bar</i>&lt;/foo&gt;
32 -
33 -<comment>(This is how to insert a comment into a code block)</comment>
34 </pre>
35
36 <note>
37 @@ -511,7 +507,7 @@ GuideXML-tag (both opening as closing), except for:
38 <c>&lt;th&gt;</c>, <c>&lt;ti&gt;</c>,
39 <c>&lt;li&gt;</c>, <c>&lt;i&gt;</c>, <c>&lt;e&gt;</c>,
40 <c>&lt;uri&gt;</c>, <c>&lt;path&gt;</c>, <c>&lt;b&gt;</c>, <c>&lt;c&gt;</c>,
41 -<c>&lt;comment&gt;</c>, <c>&lt;mail&gt;</c>.
42 +<c>&lt;mail&gt;</c>.
43 </p>
44
45 <p>
46 @@ -578,8 +574,8 @@ and the attribute value. As an example:
47 </p>
48
49 <pre caption="Attributes">
50 -<comment>Wrong :</comment> &lt;pre caption = "Attributes"&gt;
51 -<comment>Correct:</comment> &lt;pre caption="Attributes"&gt;
52 +Wrong : &lt;pre caption = "Attributes"&gt;
53 +Correct: &lt;pre caption="Attributes"&gt;
54 </pre>
55
56 </body>
57 @@ -617,19 +613,6 @@ possible. In other words, the <uri link="http://forums.gentoo.org">Gentoo
58 Forums</uri> is preferred over <uri>http://forums.gentoo.org</uri>.
59 </p>
60
61 -<p>
62 -When you comment something inside a <c>&lt;pre&gt;</c> construct, use
63 -<c>&lt;comment&gt;</c> and parentheses or the comment marker for the language
64 -that is being used (<c>#</c> for bash scripts and many other things, <c>//</c>
65 -for C code, etc.) Also place the comment <e>before</e> the subject of the
66 -comment.
67 -</p>
68 -
69 -<pre caption="Comment example">
70 -<comment>(Substitute "john" with your user name)</comment>
71 -# <i>id john</i>
72 -</pre>
73 -
74 </body>
75 </section>
76 </chapter>