[PATCH 8/8] doc: remove redundant subtitles

[Bryce Harrington]

On Fri, Jan 02, 2015 at 06:29:22PM -0800, Bill Spitzak wrote:
> Put the argument lists next to the event/message title, which I
> think makes it a lot easier to understand, and remove redudant
> "values" title from enumerations.
> ---
>  doc/publican/protocol-to-docbook.xsl |   38 ++++++++++++++++++++++------------
>  1 file changed, 25 insertions(+), 13 deletions(-)

Derek, thanks for doing the review on this series!

My xsl knowledge is fairly weak but I think I'm following the changes
okay.  Mostly trusting Bill and Derek know what they're doing, and any
issues that crop up will be obvious when we generate the docs.

Bill, note that patch #5 did not get a Reviewed-by so I have not applied
it.  Maybe it needs more of a content review?  In any case, it looks to
me like a good patch, and if we can get someone to sign off on it I'll
include it.

So at least for 7 of the 8, applied:

   ab3ee6f..6750538  master -> master

Bryce

P.S. Bill btw it'd be a big help if you'd give Reviewed-by's on some of
the other documentation patchsets.  Patchwork collects all the RB's in
the given patch's thread, and for non-trivial changes it really helps to
know the patch has been sanity checked.

> diff --git a/doc/publican/protocol-to-docbook.xsl b/doc/publican/protocol-to-docbook.xsl
> index ca1308f..a886b7f 100644
> --- a/doc/publican/protocol-to-docbook.xsl
> +++ b/doc/publican/protocol-to-docbook.xsl
> @@ -147,7 +147,7 @@
>  </xsl:template>
>  
>  <!-- Request/event list -->
> -<xsl:template match="request|event|enum">
> +<xsl:template match="request|event">
>    <section id="protocol-spec-{../@name}-{name()}-{@name}">
>      <title>
>        <xsl:value-of select="../@name"/>::<xsl:value-of select="@name" />
> @@ -155,23 +155,35 @@
>          - <xsl:value-of select="description/@summary" />
>        </xsl:if>
>      </title>
> -    <xsl:call-template name="break">
> -      <xsl:with-param name="text" select="description" />
> -    </xsl:call-template>
> -    <xsl:if test="arg">
> +    <para>
>        <variablelist>
> -        <title><xsl:value-of select="../@name"/>::<xsl:value-of select="@name" /> arguments</title>
>          <xsl:apply-templates select="arg"/>
>        </variablelist>
> -    </xsl:if>
> -    <xsl:if test="entry">
> -      <variablelist>
> -        <title><xsl:value-of select="../@name"/>::<xsl:value-of select="@name" /> values</title>
> -          <xsl:apply-templates select="entry"/>
> -      </variablelist>
> -    </xsl:if>
> +    </para>
> +    <xsl:call-template name="break">
> +      <xsl:with-param name="text" select="description" />
> +    </xsl:call-template>
> +  </section>
> +</xsl:template>
> +
> +<!-- Enumeration -->
> +<xsl:template match="enum">
> +  <section id="protocol-spec-{../@name}-{name()}-{@name}">
> +    <title>
> +      <xsl:value-of select="../@name"/>::<xsl:value-of select="@name" />
> +      <xsl:if test="description/@summary">
> +        - <xsl:value-of select="description/@summary" />
> +      </xsl:if>
> +    </title>
> +    <xsl:call-template name="break">
> +      <xsl:with-param name="text" select="description" />
> +    </xsl:call-template>
> +    <variablelist>
> +      <xsl:apply-templates select="entry"/>
> +    </variablelist>
>    </section>
>  </xsl:template>
> +
>  </xsl:stylesheet>
>  
>  <!-- vim: set expandtab shiftwidth=2: -->
> -- 
> 1.7.9.5
> 
> _______________________________________________
> wayland-devel mailing list
> wayland-devel at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/wayland-devel