Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 464216 - devmanual should explain how to use echangelog when there isn't a Changelog in the same directory
Summary: devmanual should explain how to use echangelog when there isn't a Changelog i...
Status: RESOLVED FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Devmanual (show other bugs)
Hardware: All Linux
: Normal enhancement (vote)
Assignee: Gentoo Devmanual Team
URL:
Whiteboard:
Keywords: NeedPatch
Depends on:
Blocks:
 
Reported: 2013-04-02 17:58 UTC by Agostino Sarubbo
Modified: 2013-09-28 09:47 UTC (History)
1 user (show)

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


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Agostino Sarubbo gentoo-dev 2013-04-02 17:58:42 UTC
The devmanual should explain that when there isn't a changelog in the directory where you are editing some files, you need to run 'cd ..' until you will see a changelog.

Good example: gentoo-x86/profiles/arch/powerpc/ppc64 and the changelog is only in gentoo-x86/profiles/arch/powerpc/
Comment 1 Markos Chandras (RETIRED) gentoo-dev 2013-04-02 18:04:58 UTC
Well I don't think it needs further explanation. If you can't see a changelog in the current directory, you just look on the parent dir etc etc. This is the "default" approach.
But anyway, if someone wants to write a patch I am fine with it
Comment 2 Agostino Sarubbo gentoo-dev 2013-04-02 18:06:36 UTC
(In reply to comment #1)
> Well I don't think it needs further explanation. If you can't see a
> changelog in the current directory, you just look on the parent dir etc etc.
> This is the "default" approach.
> But anyway, if someone wants to write a patch I am fine with it

That's fine, but this default approach is not documented and we need to do it
Comment 3 Michael Palimaka (kensington) gentoo-dev 2013-04-02 18:12:01 UTC
(In reply to comment #1)
> Well I don't think it needs further explanation. If you can't see a
> changelog in the current directory, you just look on the parent dir etc etc.
> This is the "default" approach.

This makes sense in theory, but there are many instances of this not happening from both new and very old devs.
Comment 4 Markos Chandras (RETIRED) gentoo-dev 2013-04-02 18:30:45 UTC
(In reply to comment #3)
> (In reply to comment #1)
> > Well I don't think it needs further explanation. If you can't see a
> > changelog in the current directory, you just look on the parent dir etc etc.
> > This is the "default" approach.
> 
> This makes sense in theory, but there are many instances of this not
> happening from both new and very old devs.

True but I really doubt anyone would look in the devmanual for this. It's better if you just advertise it in the mailing list. Then we can document it.
Comment 5 Agostino Sarubbo gentoo-dev 2013-04-02 18:36:57 UTC
(In reply to comment #4)
> True but I really doubt anyone would look in the devmanual for this. It's
> better if you just advertise it in the mailing list. Then we can document it.

I know the way to do it, but the bug born because of Micheal's mistake and I guess the advise on the mailing list is wrong. Who will advise a new developer that will join e.g. in June? The documentation needs for a reason.
Comment 6 Markos Chandras (RETIRED) gentoo-dev 2013-04-02 19:50:22 UTC
(In reply to comment #5)
> (In reply to comment #4)
> > True but I really doubt anyone would look in the devmanual for this. It's
> > better if you just advertise it in the mailing list. Then we can document it.
> 
> I know the way to do it, but the bug born because of Micheal's mistake and I
> guess the advise on the mailing list is wrong. Who will advise a new
> developer that will join e.g. in June? The documentation needs for a reason.

It's obvious that I suggested that as a reminder to old developers. Once everyone is aware of that, then we can document it. I prefer it this way instead of going documenting such bits in the devmanual silently.
Comment 7 Markos Chandras (RETIRED) gentoo-dev 2013-09-28 09:47:13 UTC
Well nobody discussed it in the list, so i just fixed in the devmanual

http://git.overlays.gentoo.org/gitweb/?p=proj/devmanual.git;a=commit;h=f4121175e9bc0d0260bbe399ef39339085afa481