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: Wed, 12 Apr 2017 21:24:18
Message-Id: 1492030979.c7fb6f30580b30728e24fb3a1265a1e17ca359ad.gokturk@gentoo
1 commit: c7fb6f30580b30728e24fb3a1265a1e17ca359ad
2 Author: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
3 AuthorDate: Wed Apr 12 21:02:59 2017 +0000
4 Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org>
5 CommitDate: Wed Apr 12 21:02:59 2017 +0000
6 URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=c7fb6f30
7
8 appendices/contributing/devbook-guide: erase the code samples section
9
10 In devmanual, code samples and syntax highlighting are done using the
11 <codesample/> now. Erase the content of this section and insert a
12 <todo>.
13
14 appendices/contributing/devbook-guide/text.xml | 66 ++------------------------
15 1 file changed, 4 insertions(+), 62 deletions(-)
16
17 diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
18 index a8ebcdf..967c990 100644
19 --- a/appendices/contributing/devbook-guide/text.xml
20 +++ b/appendices/contributing/devbook-guide/text.xml
21 @@ -405,68 +405,10 @@ The <c>&lt;sub&gt;</c> and <c>&lt;sup&gt;</c> elements are used to specify
22 <title>Code samples and colour-coding</title>
23 <body>
24
25 -<p>
26 -To improve the readability of code samples, the following tags are allowed
27 -inside <c>&lt;pre&gt;</c> blocks:
28 -</p>
29 -
30 -<dl>
31 - <dt><c>&lt;i&gt;</c></dt>
32 - <dd>Distinguishes user input from displayed text</dd>
33 - <dt><c>&lt;comment&gt;</c></dt>
34 - <dd>Comments relevant to the action(s) that appear after the comment</dd>
35 - <dt><c>&lt;keyword&gt;</c></dt>
36 - <dd>Denotes a keyword in the language used in the code sample
37 - </dd>
38 - <dt><c>&lt;ident&gt;</c></dt>
39 - <dd>Used for an identifier
40 - </dd>
41 - <dt><c>&lt;const&gt;</c></dt>
42 - <dd>Used for a constant
43 - </dd>
44 - <dt><c>&lt;stmt&gt;</c></dt>
45 - <dd>Used for a statement
46 - </dd>
47 - <dt><c>&lt;var&gt;</c></dt>
48 - <dd>Used for a variable
49 - </dd>
50 -</dl>
51 -
52 -<note>
53 -Remember that all leading and trailing spaces, and line breaks in
54 -<c>&lt;pre&gt;</c> blocks will appear in the displayed html page.
55 -</note>
56 -
57 -<p>
58 -Sample colour-coded <c>&lt;pre&gt;</c> block:
59 -</p>
60 -
61 -<pre caption="My first ebuild">
62 -<comment># Copyright 1999-2009 <b>Gentoo Foundation</b>
63 -# Distributed under the terms of the GNU General Public License v2
64 -# &#36;Header: $</comment>
65 -
66 -<ident>DESCRIPTION</ident>=<const>"Exuberant ctags generates tags files for quick source navigation"</const>
67 -<ident>HOMEPAGE</ident>=<const>"http://ctags.sourceforge.net"</const>
68 -<ident>SRC_URI</ident>=<const>"mirror://sourceforge/ctags/<var>${P}</var>.tar.gz"</const>
69 -
70 -<ident>LICENSE</ident>=<const>"GPL-2"</const>
71 -<ident>SLOT</ident>=<const>"0"</const>
72 -<ident>KEYWORDS</ident>=<const>"~mips ~sparc ~x86"</const>
73 -<ident>IUSE</ident>=<const>""</const>
74 -
75 -<stmt>src_compile()</stmt> {
76 - <keyword>econf</keyword> --with-posix-regex
77 - <keyword>emake</keyword> || <keyword>die</keyword> <const>"emake failed"</const>
78 -}
79 -
80 -<stmt>src_install()</stmt> {
81 - <keyword>make</keyword> <ident>DESTDIR</ident>="<var>${D}</var>" install || <keyword>die</keyword> <const>"install failed"</const>
82 -
83 - <keyword>dodoc</keyword> FAQ NEWS README
84 - <keyword>dohtml</keyword> EXTENDING.html ctags.html
85 -}
86 -</pre>
87 +<todo>
88 +Fill this section with the information about the use of
89 +&lt;codesample/&gt;.
90 +</todo>
91
92 </body>
93 </section>