Re: [PATCH 3/3] NEWS: Insert markdown formatting commands

Subject: Re: [PATCH 3/3] NEWS: Insert markdown formatting commands

Date: Fri, 27 Apr 2012 09:28:55 +0300

To: Jameson Graef Rollins, notmuch@notmuchmail.org

Cc:

From: Tomi Ollila


On Fri, Apr 27 2012, Jameson Graef Rollins <jrollins@finestructure.net> wrote:

> On Thu, Apr 26 2012, Tomi Ollila <tomi.ollila@iki.fi> wrote:
>> To make updating the notmuchmail.org wiki 'news' section more
>> straightforward the content of the NEWS file has now been brought
>> to almost the same as the *.mdwn files in the wiki page.
>>
>> The changes are basically insertion of mdwn formatting "commands".
>>
>> More effort has been put into formatting the newer release entries
>> (0.12, 0.11 & 0.10) than older. Commit to format 0.13 entries will
>> be made available separately.
>
> Can we please just make NEWS a directory, which each release getting
> it's own file?  That would obviously make porting to the wiki trivial.

Splitting to separate files is trivial, but that unfortunately is not enough.

Currently there are 3 other things to do:

1) Concatenate lines which start from beginning to line together and
addn '###' to the beginning of it (level 3 header) -- with some execptions.

2) Due to the markdown bug in notmuchmail implementation all lines
that are indented by 2 spaces the indentation is dropped (otherwise
some lines convert incorrectly)

3) Convert '*' -sequences to '`*`' -sequences.

I'll be providing the tool I'm using to do the conversion when the source
for it is ready.


Reading just one NEWS file is easier to everyone who downloads the
tarball. And it is no difference to edit a section in just one NEWS
file compared to separate file when thinking merge conflicts.

> jamie.

Tomi

Thread: