Wireshark · Wireshark-dev: Re: [Wireshark-dev] Lightweight markup for release notes

[Jaap Keuter <jaap.keuter@xxxxxxxxx>]

On 03/15/2013 01:17 AM, Gerald Combs wrote:
> On 3/4/13 3:39 PM, Gerald Combs wrote:
>> On 3/4/13 2:33 PM, Jaap Keuter wrote:
>>> On 03/04/2013 08:45 PM, Gerald Combs wrote:
>>>> Would anyone object to using a lighter-weight markup language for the
>>>> release notes such as Markdown or reStructuredText?
>>>
>>> I myself have been looking into AsciiDoc, for use with the Users and Developers
>>> Guide. It seems to me that the two projects you mentioned are a bit stale?
>>> AsciiDoc seems more capable of being used throughout as Wireshark's
>>> documentation format, maybe.
>>
>> Markdown and reStructuredText are used in a wide variety if places, e.g.
>> GitHub, Stack Exchange, Python (documentation), and our Q&A site.
>>
>> The specifications themselves are a different story. Markdown in
>> particular has fragmented a bit, which has caused a bit of concern:
>> http://www.codinghorror.com/blog/2012/10/the-future-of-markdown.html
> 
> Asciidoc let me create ws-buglink:<bug number> and cve-idlink:<CVE
> number> macros, which was enough to get me to use it. I switched the
> release notes over in r48307.

Looks clean, I guess you have some more files defining these macros?

> BTW, It looks like Asciidoc and Sphinx both have blockdiag extensions,
> which opens up interesting possibilities for network and packet
> diagrams: http://blockdiag.com/en/nwdiag/

That's cool indeed.

Thanks,
Jaap