On Fri, 9 Dec 2011 10:08:10 +0900 Daniel Juyung Seo
<seojuyu...@gmail.com> wrote:

> On Fri, Dec 9, 2011 at 1:29 AM, Tom Hacohen
> <tom.haco...@partner.samsung.com> wrote:
> > What I said in IRC:
> >
> > In my POV, we should ditch the NEWS file entirely and change the
> > way we handle the Changelog.
> >
> > Honestly, NEWS file was for the time before people tweeted,
> > blogged, and what not. It's not really relevant anymore, not in the
> > way we use it anyway.

All the information should still stay with the source code.  Making
people chase info all over the web wont help.

> > Changelog: we should add one entry per release that says "We added
> > new API and deprecated old API. Check doxygen for details". As we
> > use the @deprecated and @since doxygen flags anyway... As for other
> > types of changelog entries: we should keep doing those (important
> > notices). For example, we should write changelog entries when we
> > add completely new and needed features, like group inheritance in
> > edje, or possibly a new and cool elm widget. In conclusion,
> > emphasize what we want to emphasize.
> >
> >
> > I hate the fact that I have to copy almost all of my commit logs to
> > Changelog (format and rephrase it a bit) and NEWS file (format and
> > rephrase it a lot). I feel like an idiot, and it drives me nuts.
> 
> This is what I already felt and I agree with Tom.
> That's so redundant and looks ugly :(
> We just need to maintain one file. How about marking the entry, if
> there is any news or important notes?

If there should be separate files, then their goals should be
different.  We already have commit messages, don't think that is going
away any time soon.  That covers the nitty gritty details of what
changes, in a form that is suitable for developers.  Then there is the
NEWS file, which really should be a summary of the major changes for
every one to look at.

The changelog could be somewhere between the two.  Though on some
projects, the changelog is just the commit messages automatically
derived from the source repo by some script or such.  In which case
it's just redundant information, but it's in the source files (as
opposed to being only in the repo database) so that's important to, but
a script could do that.

NEWS and changelog probably should be in binary releases to.  For the
same reason, so people don't have to hunt down tweets or blogs or
whatever, it's all there in front of them.

-- 
A big old stinking pile of genius that no one wants
coz there are too many silver coated monkeys in the world.

Attachment: signature.asc
Description: PGP signature

------------------------------------------------------------------------------
Cloud Services Checklist: Pricing and Packaging Optimization
This white paper is intended to serve as a reference, checklist and point of 
discussion for anyone considering optimizing the pricing and packaging model 
of a cloud services business. Read Now!
http://www.accelacomm.com/jaw/sfnl/114/51491232/
_______________________________________________
enlightenment-devel mailing list
enlightenment-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-devel

Reply via email to