spec: Fix the escaping of special characters in Interfaces section

Kristian Høgsberg krh at bitplanet.net
Fri Feb 24 11:34:52 PST 2012


On Fri, Feb 24, 2012 at 1:53 PM, Jesse Barnes <jbarnes at virtuousgeek.org> wrote:
> On Thu, 16 Feb 2012 15:54:41 +0200
> Tiago Vignatti <tiago.vignatti at linux.intel.com> wrote:
>
>> On 02/16/2012 03:46 PM, Michael Hasselmann wrote:
>> > On Thu, 2012-02-16 at 15:40 +0200, Tiago Vignatti wrote:
>> >> On 02/16/2012 01:42 PM, Michael Hasselmann wrote:
>> >>> Hi,
>> >>>
>> >>> just noticed these small issues while going through the available
>> >>> Wayland documentation.
>> >>
>> >> FYI, this short-circuit with the idea of dynamically dump the interfaces
>> >> on the doc - check last commit there mainly:
>> >>
>> >> http://cgit.freedesktop.org/~vignatti/wayland/log/?h=tex
>> >
>> > Ah yes, makes of course more sense to generate that section, since the
>> > information is already available.  And I see that you already included
>> > the escaping for underscores, but not yet for ampersands (they will be
>> > simply skipped, which makes the text a bit funny to read).
>>
>> right, we can deal with ampersand or other tex formats later then.
>>
>> I think the most important now is to decide whether we want an auto-dump
>> of the protocol descriptions on the documentation tex or not. So if is
>> our intention to keep that documentation up to date and alive, then it
>> makes perfect sense for me. I didn't hear anything from Kristian about
>> it yet though.
>
> Yeah I'd like to see it auto-dumped to the website, perhaps with a
> commit hook on the various branches (right now just master and 0.85).
>
> Kristian, any preference?

Did you see Peters work to merge the protocol into a docbook document?
 It's here:

  http://people.freedesktop.org/~whot/Wayland/tmp/en-US/html/

I set up a hook so that when I push to my private repo (can't set up
hooks on git.fdo), the xslt stylesheet Peter submitted earlier gets
run and we put the output here:

  http://wayland.freedesktop.org/protocol.html

but I think we want to go with Peters approach of using docbook and
move the spec latex document into a docbook template that we can merge
the protocol into.

Kristian


More information about the wayland-devel mailing list