emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Julien Danjou <julien@danjou.info>
To: Christian Egli <christian.egli@sbszh.ch>
Cc: emacs-orgmode@gnu.org
Subject: Re: Re: A request: Moving away from ChangeLog
Date: Fri, 21 May 2010 23:17:22 +0200	[thread overview]
Message-ID: <87zkzt550d.fsf@keller.adm.naquadah.org> (raw)
In-Reply-To: <871vd5dkqu.fsf@saadawi.sbszh.ch> (Christian Egli's message of "Fri, 21 May 2010 23:10:17 +0200")


[-- Attachment #1.1: Type: text/plain, Size: 936 bytes --]

On Fri, May 21 2010, Christian Egli wrote:

> So before pouring out the baby with the bathwater maybe we should at
> least try if the git merge driver solves the main problem we have with
> the Changelog files.  

This does not resolve a ugly part which is the duplication of
information: in the changelog file and in the commit changelog.

Documenting commit properly should be enough.

A better idea, if you want a user readable changelog, is 2 write the
commit message in a parseable format with 2 information: one for the
developer (what the commit changes in the code, API, whatever), and one
for the user (what it changes in the software usage). That last one only
if necessary.

And with this, it's a win-win: you can generate changelog files, and you
can read changelog while reading commit/bisecting/whatever git action
you do.

-- 
Julien Danjou
// ᐰ <julien@danjou.info>   http://julien.danjou.info

[-- Attachment #1.2: Type: application/pgp-signature, Size: 197 bytes --]

[-- Attachment #2: Type: text/plain, Size: 201 bytes --]

_______________________________________________
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode

  reply	other threads:[~2010-05-21 21:17 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-05-21  9:06 A request: Moving away from ChangeLog John Wiegley
2010-05-21  9:41 ` John Wiegley
2010-05-21 12:15   ` Carsten Dominik
2010-05-21 12:50     ` John Wiegley
2010-05-21 13:47       ` Tassilo Horn
2010-05-21 15:06         ` John Wiegley
2010-05-21 15:39           ` Bernt Hansen
2010-05-21 15:46             ` John Wiegley
2010-05-21 16:01               ` Bernt Hansen
2010-05-21 16:32             ` Eric Schulte
2010-05-21 15:53           ` Carsten Dominik
2010-05-21 15:58             ` John Wiegley
2010-05-21 14:32       ` Carsten Dominik
2010-05-21 15:08         ` John Wiegley
2010-05-21 15:33         ` John Wiegley
2010-05-21 13:01     ` Ben Finney
2010-05-21 14:21       ` Carsten Dominik
2010-05-21 21:10 ` Christian Egli
2010-05-21 21:17   ` Julien Danjou [this message]
2010-06-01 14:58   ` Carsten Dominik
2010-06-02  7:44     ` Christian Egli
2010-06-02  9:32       ` Carsten Dominik

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87zkzt550d.fsf@keller.adm.naquadah.org \
    --to=julien@danjou.info \
    --cc=christian.egli@sbszh.ch \
    --cc=emacs-orgmode@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).