Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 485314 - Remove outdated ChangeLog and echangelog documentation
Summary: Remove outdated ChangeLog and echangelog documentation
Status: RESOLVED FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Devmanual (show other bugs)
Hardware: All Linux
: Normal normal (vote)
Assignee: Gentoo Devmanual Team
URL:
Whiteboard:
Keywords: InVCS
Depends on:
Blocks:
 
Reported: 2013-09-18 16:12 UTC by Michael Orlitzky
Modified: 2016-04-02 18:34 UTC (History)
0 users

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


Attachments
Patch to swap out echangelog for repoman (0001-Replace-echangelog-with-repoman-on-the-Help-for-New-.patch,1.06 KB, patch)
2014-10-15 01:30 UTC, Michael Orlitzky
Details | Diff
0001-ebuild-writing-misc-files-remove-ChangeLog-section.patch (0001-ebuild-writing-misc-files-remove-ChangeLog-section.patch,4.83 KB, patch)
2015-11-27 16:36 UTC, Michael Orlitzky
Details | Diff
0002-tools-reference-remove-the-echangelog-page.patch (0002-tools-reference-remove-the-echangelog-page.patch,2.11 KB, patch)
2015-11-27 16:37 UTC, Michael Orlitzky
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Michael Orlitzky gentoo-dev 2013-09-18 16:12:22 UTC
Working on my ebuild quizzes, it was pointed out that the following is redundant:

  $ echangelog "msg"
  $ repoman commit -m "msg"

It is preferable to keep the commit messages the same in most cases; therefore, a simple,

  $ repoman commit -m "msg"

will suffice. Repoman will notice the missing ChangeLog entry and add it itself.
Comment 1 Michael Orlitzky gentoo-dev 2014-10-15 01:30:36 UTC
Created attachment 386702 [details, diff]
Patch to swap out echangelog for repoman

I don't know how to build the HTML from XML, but the change was simple enough so maybe I didn't screw it up.
Comment 2 Stefan Junker 2015-04-24 04:11:45 UTC
The page https://devmanual.gentoo.org/ebuild-writing/misc-files/changelog/index.html should also be updated with the new information.
Comment 3 Markos Chandras (RETIRED) gentoo-dev 2015-04-24 19:21:30 UTC
This is not always accurate. echangelog (and ChangeLog) are used to provide detailed information about what really changed. Sometimes the commit message is enough, some other times it's best to add more details to the ChangeLog regarding that particular commit. So yes, while repoman commit -m "Foo" will also append "Foo" to ChangeLog (if you haven't edited yourself) we still need to reference the proper use to echangelog though. I believe the patch needs some rewording.
Comment 4 Michael Orlitzky gentoo-dev 2015-11-27 16:36:02 UTC
Created attachment 418024 [details, diff]
0001-ebuild-writing-misc-files-remove-ChangeLog-section.patch
Comment 5 Michael Orlitzky gentoo-dev 2015-11-27 16:37:39 UTC
Created attachment 418026 [details, diff]
0002-tools-reference-remove-the-echangelog-page.patch

The original issue I reported is obsolete, but Stefan is right, this needs to be fixed in the devmanual as well. So here are some patches to remove the outdated (e)changelog stuff.
Comment 6 Göktürk Yüksek archtester gentoo-dev 2016-04-02 18:34:00 UTC
This is live on https://devmanual.gentoo.org/