akhiezer wrote:

Hi,


A high percentage of lfs/blfs book-commits' patches, could be a lot
more readable - and therefore less fragile/error-prone - if the xml
tags were kept on separate lines from the code.

This would be do-able while still avoiding pitfalls like the old
'vertical-formatting' in *roff/&c.


For example, most of the following diff is caused by formatting of the
original & new xml, as opposed to changes in the shell/&c commands;
and as such makes the change/patch much less readable and therefore
more fragile/error-prone for editors/&c.

-<screen><userinput>echo "/opt/llvm3/lib" >> /etc/ld.so.conf &amp;&amp;
-mkdir -v build                           &amp;&amp;

^^^^^^^^^^^^^^^^^^^^^^^ End of Example ^^^^^^^^^^^^^^^^^^^^^^^^^^


If the original xml were formatted thus:
====
<screen><userinput>
echo "/opt/llvm3/lib" >> /etc/ld.so.conf &amp;&amp;
mkdir -v build                           &amp;&amp;
cd       build                           &amp;&amp;

That creates unwanted blank lines on the page. We do what we can to keep things readable, but we are constrained by the docbook syntax (and that is really a good thing overall).

  -- Bruce


--
http://lists.linuxfromscratch.org/listinfo/blfs-dev
FAQ: http://www.linuxfromscratch.org/blfs/faq.html
Unsubscribe: See the above information page

Reply via email to