Red Hat Bugzilla – Bug 453071
Config files displayed on single line
Last modified: 2016-06-17 17:06:32 EDT
Description of problem: In various parts of the RHEL5.2 deployment guide, example configuration files are displayed (in a yellow box) with all the text compressed to a single line. This is misleading, confusing and just wrong. Version-Release number of selected component (if applicable): How reproducible: - Look at the Deployment Guide Steps to Reproduce: 1. Visit, e.g. http://www.redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/5.2/html/Deployment_Guide/s2-networkscripts-interfaces-chan.html http://www.redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/5.2/html/Deployment_Guide/s2-networkscripts-interfaces-alias.html http://www.redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/5.2/html/Deployment_Guide/s2-networkscripts-interfaces-ppp0.html 2. Observe configuration files butchered to a single line 3. Cry Actual results: - Entire configuration file mashed to a single line Expected results: - Config file listed with proper newlines. One example can be found at http://kbase.redhat.com/faq/FAQ_85_6313.shtm Additional info: - This probably applies to many other parts of the deployment guide; here I've only listed the three which I stumbled across.
Mike: customers are copying some of these and saving them, resulting in broken systems. Did anything come of the discussion last year about resolving all of these? Thanks, Murray.
Also exists on RHEL5.1 guide http://www.redhat.com/docs/manuals/enterprise/RHEL-5-manual/en-US/RHEL510/Deployment_Guide/s2-networkscripts-interfaces-chan.html and RHEL5 GA http://www.redhat.com/docs/manuals/enterprise/RHEL-5-manual/Deployment_Guide-en-US/s2-networkscripts-interfaces-chan.html
Reference to the problem on 5.1 https://bugzilla.redhat.com/show_bug.cgi?id=426309
And again https://bugzilla.redhat.com/show_bug.cgi?id=438823
I have committed changes to resolve /s2-networkscripts-interfaces-chan.html (Channel Bonding Interfaces). Cheers.
This issue seems to occur if command tags are in screen tags: <screen> <command> blah blah blah </command> </screen>
A specific occurrence of the same problem found in the Installation Guide. https://bugzilla.redhat.com/show_bug.cgi?id=420911
*** Bug 514410 has been marked as a duplicate of this bug. ***
*** Bug 518203 has been marked as a duplicate of this bug. ***
The problem is actually that the computeroutput tag has been used in 837 places in the DocBook source, but that tag does not preserve line breaks in the source. That's what the DocBook manual means when it notes, in the description for computeroutput, that: "Note that computeroutput is not a verbatim environment, but an inline." Agreed that "verbatim environment" could have a secondary, more-explicit warning regarding line breaks... These will all need to be replaced with screen elements.
Hopefully all fixed in 5.4 branch -r21220 with Java 1.6 regex library, ~115 modifications to 25 files: <\s*?screen(\s+?moreinfo="none")?\s*?>\s*?<\s*?computeroutput(\s+?moreinfo="none")?\s*?>((\s|\S)*?)<\s*?/computeroutput\s*?>\s*?<\s*?/screen\s*?> replace with: <screen>$3</screen> Visual diff shows line breaks are now correct in all examples I looked at. <command> els inside <screen> els were preserved (as well as inline <computeroutput> els). Committed. Now going to fix bug 241314 and then to upload corrected books.
Fixed, 5.4, redhat.com/docs: http://www.redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/5.4/html/Deployment_Guide/s1-networkscripts-interfaces.html
*** Bug 438823 has been marked as a duplicate of this bug. ***
*** Bug 452065 has been marked as a duplicate of this bug. ***