hbase-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Misty Stanley-Jones (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (HBASE-11199) One-time effort to pretty-print the Docbook XML, to make further patch review easier
Date Mon, 19 May 2014 00:15:38 GMT

     [ https://issues.apache.org/jira/browse/HBASE-11199?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Misty Stanley-Jones updated HBASE-11199:
----------------------------------------

    Attachment: HBASE-11199.patch

So, Oxygen has a reasonable pretty-print system for Docbook XML. You just go to the text view
(non-wysiwyg), cmd+A to select-all, cmd+shift+P to pretty-print. It ignores <programlisting>,
<screen>, <literallayout>, and others that seem reasonable. It wraps long lines
when possible, as well. at around 100 characters, occasionally overflowing a character or
two because of word breaks. Let me know if you want any of these settings tweaked and I will
do it and re-submit the patch. 

I can also look around for a command-line reformatter which we  could hook in with the automatic
builds or somehow with the check-in process, if you like that approach. I know that they exist
because I've used one before, and specifically had it set up with reasonable defaults for
Docbook. I just can't remember what it was called!

> One-time effort to pretty-print the Docbook XML, to make further patch review easier
> ------------------------------------------------------------------------------------
>
>                 Key: HBASE-11199
>                 URL: https://issues.apache.org/jira/browse/HBASE-11199
>             Project: HBase
>          Issue Type: Task
>          Components: documentation
>            Reporter: Misty Stanley-Jones
>            Assignee: Misty Stanley-Jones
>         Attachments: HBASE-11199.patch
>
>
> Careful not to pretty-print literal layouts and document (at least in this JIRA) the
pretty-printing process for next time.



--
This message was sent by Atlassian JIRA
(v6.2#6252)

Mime
View raw message