all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
* commit style redux
@ 2009-03-31  3:21 Miles Bader
  2009-04-01  0:57 ` Stefan Monnier
  2010-01-16  3:00 ` Glenn Morris
  0 siblings, 2 replies; 21+ messages in thread
From: Miles Bader @ 2009-03-31  3:21 UTC (permalink / raw)
  To: emacs-devel

Hmm, so since Emacs is going to move to a real source-control system in
the near(ish) future, maybe people could start trying to use a
commit-style which is more friendly to such systems?

Not only is this good practice for the future, but it also creates a
much nicer change history when the CVS repo is converted to the new
system (and even now, for people currently tracking Emacs via other
systems).

E.g., --

 (1) Commit all changed files at once with a single log message (which
     in CVS will result in an identical log message for all committed
     files), not one-by-one.  This is pretty easy using vc-dir now.

 (2) Make the log message describe the entire changeset, perhaps
     including relevant changelog entiries (I often don't bother with
     the latter if it's a trivial sort of change).

     Many modern source-control systems vaguely distinguish the first
     line of the log message to use as a short summary for abbreviated
     history listing (in arch this was explicitly called the summary,
     but many other systems have a similar concept).  So it's nice if
     you can format the log entry like:

        SHORTISH ONE-LINE SUMMARY

        MULTIPLE-LINE DETAILED DESCRIPTION POSSIBLY INCLUDING (OR
        CONSISTING OF) CHANGELOG ENTRIES

     [Even with CVS this style is useful, because web CVS browsing
     interfaces often include the first N words of the log message of
     the most recent commit as a short "most recent change"
     description.]

 (3) Don't phrase log messages assuming the filename is known, because
     in non-file-oriented systems (everything modern other than CVS),
     the log listing tends to be treated as global information, and the
     connection with specific files is less explicit.

     For instance, currently I often see log messages like "Regenerate";
     for modern source-control systems with a global log, it's better to
     have something like "Regenerate configure".

I know I'm always harping on this, but I figure with the change looming
ever closer, I'll try again... :-)

Thanks,

-Miles

-- 
`Life is a boundless sea of bitterness'




^ permalink raw reply	[flat|nested] 21+ messages in thread

end of thread, other threads:[~2010-02-08  1:28 UTC | newest]

Thread overview: 21+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2009-03-31  3:21 commit style redux Miles Bader
2009-04-01  0:57 ` Stefan Monnier
2010-01-16  3:00 ` Glenn Morris
2010-01-16  7:03   ` Juanma Barranquero
2010-01-16  9:10   ` Thien-Thi Nguyen
2010-01-27  4:25   ` Glenn Morris
2010-01-27 14:57     ` Stefan Monnier
2010-01-28  5:30       ` log-edit-strip-single-file-name [was Re: commit style redux] Glenn Morris
2010-01-28 19:25         ` log-edit-strip-single-file-name Stefan Monnier
2010-01-28 23:13           ` log-edit-strip-single-file-name Stefan Monnier
2010-01-29  3:06           ` log-edit-strip-single-file-name Dan Nicolaescu
2010-01-29  8:20           ` log-edit-strip-single-file-name Dan Nicolaescu
2010-01-29 17:58             ` log-edit-strip-single-file-name Stefan Monnier
2010-02-04  7:51               ` log-edit-strip-single-file-name Dan Nicolaescu
2010-02-04 15:40                 ` log-edit-strip-single-file-name Stefan Monnier
2010-02-06  4:26                   ` log-edit-strip-single-file-name Dan Nicolaescu
2010-02-06 14:28                     ` log-edit-strip-single-file-name Stefan Monnier
2010-02-06 19:18                       ` log-edit-strip-single-file-name Dan Nicolaescu
2010-02-08  1:28                         ` log-edit-strip-single-file-name Stefan Monnier
2010-01-30 22:57           ` log-edit-strip-single-file-name Juri Linkov
2010-01-31  6:56             ` log-edit-strip-single-file-name Stefan Monnier

Code repositories for project(s) associated with this external index

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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.