[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Freeipmi-devel] Some improvement ideas

From: Arnaud Quette
Subject: [Freeipmi-devel] Some improvement ideas
Date: Wed, 29 Jun 2011 01:54:52 +0200

Hi Al and the list,

Here is 2 things that I'd like to share with you, and that could make your developer / maintainer life easier, and your users happier.
I won't go into details, but there are also clear QA advantages in automation, and usage of standard transformation tools.

1) Documentation

For both user and developers docs, manpages, website, you should consider AsciiDoc:

AsciiDoc use a simple, yet powerful, plain text formating, equivalent to Wikis RST.
It allows to handle everything from Makefiles, and generate HTML, PDF, groff, epub, ODS, ... from .txt
AsciiDoc was recommended to me 2 years ago by ESR (Eric S Raymond, part of the NUT team), and it's really a Holy Grail!

Here is what I did for NUT:

Have a closer look at the Documentation sections.
All this done with the .txt files here:

If you're interested, I can help bootstrapping things...

2) Maintainability

you should consider automatic generation for the ChangeLog, using SVN commit messages.

This is what we have in NUT:
# Automatically generate the ChangeLog from SVN logs:
ChangeLog: tools/svn2cl.authors
    svn2cl --group-by-day --include-rev --authors=$< --revision 'HEAD:2332' --output=$@ || \
        echo "svn2cl failed to generate the ChangeLog. See" > $@

Here is a sample output:

well, I should be done for this evening, but expect me to get back soon ;-)

Linux / Unix Expert R&D - Eaton -
Network UPS Tools (NUT) Project Leader -
Debian Developer -
Free Software Developer -

reply via email to

[Prev in Thread] Current Thread [Next in Thread]