Gentoo Archives: gentoo-dev

From: Michael Weber <xmw@g.o>
To: gentoo-dev@l.g.o
Subject: Re: readme.gentoo.eclass: use echo -e instead of plain echo (Was: Re: [gentoo-dev] readme.gentoo.eclass: Add a DISABLE_AUTOFORMATTING variable=
Date: Fri, 01 Feb 2013 11:08:28
Message-Id: 510BA201.20002@gentoo.org
In Reply to: Re: readme.gentoo.eclass: use echo -e instead of plain echo (Was: Re: [gentoo-dev] readme.gentoo.eclass: Add a DISABLE_AUTOFORMATTING variable= by Ben de Groot
1 On 02/01/2013 10:55 AM, Ben de Groot wrote:
2 > On 1 February 2013 02:59, Pacho Ramos <pacho@g.o> wrote:
3 >> El dom, 27-01-2013 a las 18:47 +0100, Pacho Ramos escribió:
4 >>> El dom, 27-01-2013 a las 15:00 +0100, Pacho Ramos escribió:
5 >>>> Currently, when people uses DOC_CONTENTS variable to place their desired
6 >>>> messages, they are automatically reformatted by "fmt" to get proper
7 >>>> messages (for example, splitting long lines).
8 >>>>
9 >>>> But, in some cases, may be useful to disable this behavior and respect
10 >>>> strictly how DOC_CONTENTS was formatted, for example in that kind of
11 >>>> messages telling people to run a command and, then, requiring a new line
12 >>>> to be used. This can also be useful to append extra information to
13 >>>> DOC_CONTENTS when, for example, additional info is needed when enabling
14 >>>> a USE flag.
15 >>>>
16 >>>>
17 >>>
18 >>> Well, after reading man echo I see all this is not needed, I simply need
19 >>> to use echo -e to get it understand "\n" to create new lines
20 >>>
21 >>> New patch attached
22 >>
23 >> This will add an option to disabling autoformatting to let people get
24 >> their doc_contents 100% respected if they want
25 >
26 > How about using an "as-is" argument to readme.gentoo_create_doc?
27 > That would be more concise. :-)
28 >
29 PLEASE, add "define DOC_CONTENTS in an non-global scope, use
30 src_prepare/pkg_setup instead" to the eclass documentation of
31 readme.gentoo_print_elog, Thanks
32
33 ++ for the eclass, the README.gentoo might submerge into the users
34 handling of Gentoo Systems. (I always laughed about README.Debian)
35 [1] show an report about exactly the non-atomar situation of elog and
36 application usage.
37
38 While [2] complained about elog cluttering, I try to migrate
39 x11-wm/xpra-0.8.0 (upcoming), am I doing it right?
40
41 DOC_CONTENTS="""
42 please make your Xorg binary readable for users of xpra
43 chmod a+r /usr/bin/Xorg
44 and think about the security impact
45 A copy at ~/.xpra/Xorg matching the current modules is sufficient.
46 """
47
48 ^^ clearly would benefit from non-formatting.
49 repoman full complains about "Ebuild contains leading spaces on line".
50
51 [1] https://bugs.gentoo.org/show_bug.cgi?id=448588
52 [2] https://bugs.gentoo.org/show_bug.cgi?id=440464
53
54
55 --
56 Michael Weber
57 Gentoo Developer
58 web: https://xmw.de/
59 mailto: Michael Weber <xmw@g.o>