Bug 12918 - Unadequate format in programlisting
Unadequate format in programlisting
Status: NEW
Product: Samba 4.1 and newer
Classification: Unclassified
Component: Documentation
unspecified
All All
: P5 normal
: ---
Assigned To: Samba Documentation QA Contact~
Samba Documentation QA Contact~
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2017-07-20 06:54 UTC by Michio MATSUYAMA
Modified: 2017-07-20 11:57 UTC (History)
0 users

See Also:


Attachments
Unadequate format in programlisting (56.11 KB, patch)
2017-07-20 06:54 UTC, Michio MATSUYAMA
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Michio MATSUYAMA 2017-07-20 06:54:09 UTC
Created attachment 13405 [details]
Unadequate format in programlisting

Most XML files for manpages which use programlisting tag are not adequate in the typing manner, so the output would also be not adequate.  This is because the characters within the programlisting tags have the unneccessary blanks or tabs in the head position of each lines, as will be output exactly as seen, and this cause unadequate results in the output.  Few files, such as pdbedit.8.xml, rpcclient.1.xml, wbinfo.1.xml, are good in the point of this view.  But, especially vfs_shell_snap.8.xml is the worst one, please look in the htmlman version, its hyperlinks created for other option pages look bad because of having the unneccessary line breaks in the middle of smbconfoption tags.

Here is a sample,  manpages/idmap_tdb2.8.xml:

diff --git a/docs-xml/manpages/idmap_tdb2.8.xml b/docs-xml/manpages/idmap_tdb2.8.xml
index 5b4fe2e..4f93f7b 100644
--- a/docs-xml/manpages/idmap_tdb2.8.xml
+++ b/docs-xml/manpages/idmap_tdb2.8.xml
@@ -79,10 +79,9 @@
 	</para>
 
 	<programlisting>
-	SIDTOID S-1-xxxx
-	IDTOSID UID xxxx
-	IDTOSID GID xxxx
-	</programlisting>
+SIDTOID S-1-xxxx
+IDTOSID UID xxxx
+IDTOSID GID xxxx</programlisting>
 
 	<para>
 	And it should return one of the following responses as a single line of


Note that there should be no blanks or tags before '</programlisting>' tag.  If not, an unnesseary blank line would create at the end of this programlising content.

I have found several pages that, I am afraid, should modify, and these are shown in an attachment diff file.
Comment 1 Michio MATSUYAMA 2017-07-20 11:57:58 UTC
Wrong explanation I had before.

Again:
Note that there should be no blanks or tags before '</programlisting>' tag.  If there exists a blank or tag, an unnesseary blank line would create at the end of this programlising content.