Gentoo Archives: gentoo-portage-dev

From: Brian Dolbec <dolsen@g.o>
To: gentoo-portage-dev@l.g.o
Subject: Re: [gentoo-portage-dev] [PROPOSAL] Don't split user visible messages across multiple lines
Date: Wed, 15 Mar 2017 22:32:46
Message-Id: 20170315153232.0cea9a14.dolsen@gentoo.org
In Reply to: [gentoo-portage-dev] [PROPOSAL] Don't split user visible messages across multiple lines by Alexandru Elisei
1 On Mon, 27 Feb 2017 20:33:28 +0200
2 Alexandru Elisei <alexandru.elisei@×××××.com> wrote:
3
4 > I was working on emerge --sync and my test repo configuration
5 > generated several warning messages. Finding the exact location where
6 > the warnings was generated was surprisingly difficult because the
7 > message string was split across three lines due to the 80 character
8 > line limit and I had to grep for different patterns until I found one
9 > that matched part of a line.
10 >
11 > I propose that messages that are visible to the user never be split
12 > across multiple lines. This is also the coding style convention used
13 > by the linux kernel:
14 > https://www.kernel.org/doc/html/latest/process/coding-style.html#breaking-long-lines-and-strings
15 >
16 > If accepted, this could go in the DEVELOPING file.
17 >
18
19 That could be pretty hard to do for all messages.
20 Especially messages with embedded data
21
22 eg: "%s is missing %s required use flag..." % ('sys-apps/foo', 'bar')
23
24
25 I know I don't always enforce the line length for a few characters,
26 also when clarity is more important than line length.
27
28 We could also increase the max. line length to something like 120 or 130.
29
30 --
31 Brian Dolbec <dolsen>

Replies