Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 832156 - general-concepts/autotools: Rework sentence referring to einfo usage that was removed
Summary: general-concepts/autotools: Rework sentence referring to einfo usage that was...
Status: RESOLVED FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Devmanual (show other bugs)
Hardware: All Linux
: Normal trivial
Assignee: Gentoo Devmanual Team
URL: https://devmanual.gentoo.org/general-...
Whiteboard:
Keywords: PATCH
Depends on:
Blocks:
 
Reported: 2022-01-27 09:47 UTC by Thomas Bracht Laumann Jespersen
Modified: 2022-03-01 09:59 UTC (History)
1 user (show)

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


Attachments
[PATCH] general-concepts/autotools: Adjust comment around einfo (0001-general-concepts-autotools-Adjust-comment-around-ein.patch,1.35 KB, patch)
2022-01-27 09:48 UTC, Thomas Bracht Laumann Jespersen
Details | Diff
[PATCH] general-concepts/autotools: Remove comment re info (0001-general-concepts-autotools-Remove-comment-re-einfo.patch,1.09 KB, patch)
2022-01-27 11:44 UTC, Thomas Bracht Laumann Jespersen
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Thomas Bracht Laumann Jespersen 2022-01-27 09:47:39 UTC
I'm working my way through the devmanual and a sentence referred to a usage of "einfo" that didn't exist in the sample code.

Reproducible: Always

Steps to Reproduce:
Read this page: https://devmanual.gentoo.org/general-concepts/autotools/index.html#simple-autotools-patching-example

The sentence: "The einfo message before running autotools is not mandatory." There is no use of einfo in the preceding example
Comment 1 Thomas Bracht Laumann Jespersen 2022-01-27 09:48:35 UTC
Created attachment 763733 [details, diff]
[PATCH] general-concepts/autotools: Adjust comment around einfo
Comment 2 Ulrich Müller gentoo-dev 2022-01-27 10:24:39 UTC
einfo was removed when the example was updated in commit d9e28f40be32f76224ef0dbe2f3163e0615896f1.

Thank you for the patch, but two comments:
- I wonder if we shouldn't recommend ebegin/eend instead?
- Certainly the wording "sometimes ... something ... something" could be improved. :)

Or maybe we should drop the paragraph altogether; messages around eautoreconf are very unusual.

@sam: Any opinion?
Comment 3 Thomas Bracht Laumann Jespersen 2022-01-27 11:41:31 UTC
I considered just deleting the sentence, I'm sure the devmanual explains the use of einfo/ebegin/eend elsewhere :-)
Comment 4 Thomas Bracht Laumann Jespersen 2022-01-27 11:44:52 UTC
Created attachment 763741 [details, diff]
[PATCH] general-concepts/autotools: Remove comment re info

Patch that just removes the paragraph talking about einfo.
Comment 5 Larry the Git Cow gentoo-dev 2022-03-01 09:59:08 UTC
The bug has been closed via the following commit(s):

https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=6756801c7f1d3b8a6326567a164891333b1f10d3

commit 6756801c7f1d3b8a6326567a164891333b1f10d3
Author:     Thomas Bracht Laumann Jespersen <t@laumann.xyz>
AuthorDate: 2022-01-27 09:39:43 +0000
Commit:     Sam James <sam@gentoo.org>
CommitDate: 2022-03-01 09:58:56 +0000

    general-concepts/autotools: Remove comment re einfo
    
    In commit d9e28f40be32f76224ef0dbe2f3163e0615896f1, einfo lines were
    removed from the examples but a paragraph still still referenced it.
    Delete the paragraph.
    
    Closes: https://bugs.gentoo.org/832156
    Signed-off-by: Thomas Bracht Laumann Jespersen <t@laumann.xyz>
    Signed-off-by: Sam James <sam@gentoo.org>

 general-concepts/autotools/text.xml | 7 -------
 1 file changed, 7 deletions(-)