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

where to maintain DEP8^W autopkgtest spec now



Stefano Zacchiroli [2014-07-31 13:53 +0200]:
> Martin (and myself) would prefer using markdown for maintaining the spec
> in the future; Russ is fine with that too, and would like to use similar
> "light" markups in the future for other sub-policies; Bill would prefer
> docbook, but that doesn't seem to be a strong objection (please correct
> me if I'm wrong). To make things easier for the actual dep-8
> authors/maintainers, I'd therefore like to settle on markdown.

Recently I converted the spec from plain text to ReStructured Text,
and convert them to HTML during package build with rst2html (from
python's docutils). But pandoc can convert between RST, Markdown, and
docbook pretty effortlessly.

RST and Markdown are still nice to look at in text form, while docbook
certainly isn't; but as we can convert all those, I don't mind that
much -- autopkgtest could still build markdown or rst from docbook
during package build.

In fact, I'm fairly impressed:

 $ pandoc README.package-tests.rst -t docbook -o README.package-tests.xml
 $ pandoc -f docbook README.package-tests.xml -o new.rst
 $ diff -u README.package-tests.rst new.rst
 --- README.package-tests.rst	2014-07-30 10:42:38.058970705 +0200
 +++ new.rst	2014-07-31 14:20:24.245631770 +0200
  @@ -220,6 +220,3 @@
  
   in the ``Source:`` paragraph. Future versions of dpkg-source might add
   this automatically when a ``debian/tests/control`` file is present.
  -
  -.. vim: ft=rst tw=72

That's quite a remarkable accuracy :)

Thanks Zack!

Martin

-- 
Martin Pitt                        | http://www.piware.de
Ubuntu Developer (www.ubuntu.com)  | Debian Developer  (www.debian.org)
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: Digital signature
URL: <http://lists.alioth.debian.org/pipermail/autopkgtest-devel/attachments/20140731/a6653b16/attachment.sig>


Reply to: