Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 597400 - savedconfig.eclass: improve wording in elog messages
Summary: savedconfig.eclass: improve wording in elog messages
Status: UNCONFIRMED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: Eclasses (show other bugs)
Hardware: All Linux
: Normal enhancement
Assignee: Gentoo's Team for Core System packages
URL:
Whiteboard:
Keywords: PATCH
Depends on:
Blocks:
 
Reported: 2016-10-18 07:09 UTC by Teika kazura
Modified: 2016-10-18 11:09 UTC (History)
0 users

See Also:
Package list:
Runtime testing required: ---


Attachments
patch to savedconfig.eclass (eclass.patch,1.22 KB, patch)
2016-10-18 07:09 UTC, Teika kazura
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Teika kazura 2016-10-18 07:09:52 UTC
Created attachment 450608 [details, diff]
patch to savedconfig.eclass

The elog message of save_config() in savedconfig.eclass is a bit difficult to read. Let me propose a patch to improve it.

One obvious problem of the current elog is the following line:
------------------------------------------------------------------------
"You can edit **these file**..."
------------------------------------------------------------------------
"these files" has to be "this file" (which means the savedconfig file.)

There is one more trouble: the following lines are a bit of headache:
------------------------------------------------------------------------
${PORTAGE_CONFIGROOT}/etc/portage/savedconfig/
[${CTARGET}|${CHOST}|""]/${CATEGORY}/[${PF}|${P}|${PN}]
------------------------------------------------------------------------
This is the verbatim elog message. It's difficult to understand, because (i) it is the pathname, but broken into two lines. (ii) Most gentoo users I guess are not fluent in ebuild variable names. (I can't distinguish PF and P, and had never heard of PORTAGE_CONFIGROOT, nor CTARGET under /etc/portage.)

I propose (i) to produce an explicit example pathname, like
  "/etc/portage/savedconfig/sys-kernel/linux-firmware"
and (ii) also to retain the original two lines, appending "(line contd.)" to the first line. Maybe you might have a better idea.

(Similar one was in bug #306527. It was only a complaint, but I submit a patch.)

Thanks beforehand.