changeset 8348:d95c4e31bb2d

recommend limited line width in code examples
author Thorsten Meyer <thorsten.meyier@gmx.de>
date Thu, 16 Oct 2008 22:01:10 +0200
parents fa78cb8d8a5c
children 02beb5be5683
files doc/ChangeLog doc/interpreter/contrib.txi
diffstat 2 files changed, 17 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/doc/ChangeLog	Thu Nov 27 10:28:24 2008 +0100
+++ b/doc/ChangeLog	Thu Oct 16 22:01:10 2008 +0200
@@ -55,6 +55,10 @@
 	* interpreter/func.txi: Document private directories and function
 	precedence here.
 	
+2008-10-16  Thorsten Meyer  <thorsten.meyier@gmx.de>
+        * interpreter/contrib.txi: added recommendation of limited
+          line width in code examples
+          
 2008-10-03  Thorsten Meyer  <thorsten.meyier@gmx.de>
 
 	* interpreter/contrib.txi: added example for mercurial queues
--- a/doc/interpreter/contrib.txi	Thu Nov 27 10:28:24 2008 +0100
+++ b/doc/interpreter/contrib.txi	Thu Oct 16 22:01:10 2008 +0200
@@ -306,5 +306,17 @@
 
 The M4 macro language is mainly used for autoconf configuration files. You should
 follow normal M4 rules when contributing to these files. Some M4 files come
-from external source, namely the Autoconf archive @url{http://autoconf-archive.cryp.to}.
+from external source, namely the Autoconf archive
+@url{http://autoconf-archive.cryp.to}.
 
+If you give a code example in the documentation written in texinfo with the 
+@code{@@example} environment, you should be aware that the text within such an 
+environment will not be wrapped. It is recommended that you keep the lines
+short enough to fit on pages in the generated pdf or ps documents. Here is a 
+ruler (in an @code{@@example} environment) for finding the appropriate line 
+width:
+
+@example
+         1         2         3         4         5         6         7         8
+12345678901234567890123456789012345678901234567890123456789012345678901234567890
+@end example