[interchange-docs] xmldocs - docelic modified 10 files

docs at icdevgroup.org docs at icdevgroup.org
Wed Jul 5 10:03:30 EDT 2006


User:      docelic
Date:      2006-07-05 14:03:30 GMT
Modified:  .        TODO
Modified:  docbook  literals.ent
Modified:  glossary debug expire link-program locale
Modified:  guides   install.xml
Modified:  refs     DebugFile EncryptProgram
Added:     howtos   expire-sessions
Log:
- TODO: add item
- docbook/literals.ent: Add &WIKIPEDIA; entity
- glossary/*: update entries
- guides/*: add todo notes
- refs/*: small updates
- howtos/*: updates

Revision  Changes    Path
1.88      +1 -0      xmldocs/TODO


rev 1.88, prev_rev 1.87
Index: TODO
===================================================================
RCS file: /var/cvs/xmldocs/TODO,v
retrieving revision 1.87
retrieving revision 1.88
diff -u -r1.87 -r1.88
--- TODO	5 Jul 2006 09:43:42 -0000	1.87
+++ TODO	5 Jul 2006 14:03:30 -0000	1.88
@@ -2,6 +2,7 @@
 - Make xmldocs tarball in ftp autoupdated
 - Change -latest to version number in tarball download
 - bin/whatsnew-update didn't pick up User: from messages
+- some <am> is visible in feature glossary entry
 
 Outstanding:
 =======



1.37      +1 -0      xmldocs/docbook/literals.ent


rev 1.37, prev_rev 1.36
Index: literals.ent
===================================================================
RCS file: /var/cvs/xmldocs/docbook/literals.ent,v
retrieving revision 1.36
retrieving revision 1.37
diff -u -r1.36 -r1.37
--- literals.ent	4 Jul 2006 22:24:42 -0000	1.36
+++ literals.ent	5 Jul 2006 14:03:30 -0000	1.37
@@ -37,6 +37,7 @@
 <!ENTITY WP "<ulink url='http://www.wikipedia.org/'>Wikipedia</ulink>">
 <!ENTITY SWISH-E "<ulink url='http://www.swish-e.org/'>Swish-e</ulink>">
 <!ENTITY GPG "<ulink url='http://www.gnupg.org/'>GPG</ulink>">
+<!ENTITY WIKIPEDIA "<ulink url='http://www.wikipedia.org/'>Wikipedia</ulink>">
 
 
 



1.2       +1 -0      xmldocs/glossary/debug


rev 1.2, prev_rev 1.1
Index: debug
===================================================================
RCS file: /var/cvs/xmldocs/glossary/debug,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- debug	14 Sep 2005 23:10:30 -0000	1.1
+++ debug	5 Jul 2006 14:03:30 -0000	1.2
@@ -0,0 +1 @@
+No debugging options are enabled by default in &IC;.



1.3       +6 -1      xmldocs/glossary/expire


rev 1.3, prev_rev 1.2
Index: expire
===================================================================
RCS file: /var/cvs/xmldocs/glossary/expire,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- expire	4 Jul 2006 22:24:42 -0000	1.2
+++ expire	5 Jul 2006 14:03:30 -0000	1.3
@@ -15,7 +15,8 @@
 reads all catalog entries in &gcf; and runs <command>expire</command> on them.
 </para><para>
 The <command>expire</command> script accepts a <literal>-r</literal> option
-which tells it to reorganize database files and recover lost disk space.
+which, when DBM sessions are used, tells the script to reorganize database
+files and recover lost disk space.
 </para><para>
 On a UNIX server, it's most useful to run <command>expireall</command>
 from <literal>crontab</literal>. As the &IC; user, run
@@ -35,6 +36,10 @@
 <para>
 When file-based sessions are used (no DBM), then you can use a custom
 script like this:
+
+<!-- TODO how come we call -f and then -d. As far as I know, both can't
+succeed for the same file. Also include a note on cleaning tmp/ and 
+the find | xargs lines -->
 
 <programlisting><![CDATA[
 #!perl



1.4       +3 -3      xmldocs/glossary/link-program


rev 1.4, prev_rev 1.3
Index: link-program
===================================================================
RCS file: /var/cvs/xmldocs/glossary/link-program,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- link-program	21 Dec 2005 15:39:46 -0000	1.3
+++ link-program	5 Jul 2006 14:03:30 -0000	1.4
@@ -153,8 +153,8 @@
 </para><para>
 The problem with the above approach, however, is that you might be missing
 critical compiler options, or that the compiler isn't <command>gcc</command>
-at all. To ensure that the C compiler will be invoked properly, help yourself
-with this little ditty:
+at all. To ensure that the C compiler will be invoked properly, use the
+following little ditty instead of the two <command>gcc</command> lines:
 <programlisting><![CDATA[
 perl -e 'do "syscfg"; system("$CC $LIBS $CFLAGS $DEFS vlink.c -o ../bin/vlink");'
 perl -e 'do "syscfg"; system("$CC $LIBS $CFLAGS $DEFS tlink.c -o ../bin/tlink");'
@@ -256,7 +256,7 @@
 In any case, unless you are using <filename>tlink.pl</filename> for a 
 specific reason, and you do have a working compiler, tuning the C source
 files to overcome compilation problems is preferred over using
-Perl implementation of <literal>tlink</literal>.
+Perl implementation of the link program.
 </para>
 </section>
 



1.5       +3 -3      xmldocs/glossary/locale


rev 1.5, prev_rev 1.4
Index: locale
===================================================================
RCS file: /var/cvs/xmldocs/glossary/locale,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- locale	15 Jun 2005 10:30:11 -0000	1.4
+++ locale	5 Jul 2006 14:03:30 -0000	1.5
@@ -119,9 +119,9 @@
 	We've said &conf-HTMLsuffix; is locale-sensitive, but the story gets 
 	much better. In reality, any &conf-Locale; key that matches the name of a
 	config directive, causes the directive to be re-set on locale change &mdash;
-	in other words, all config directives are locale-sensitive! (And now I
-	know you know I am no fan of exclamation marks, but can you say this feature
-	isn't just ingenious?!).
+	in other words, all config directives are locale-sensitive!
+	<!-- TODO not all are locale-sensitive. Come up with a list of those
+	that are -->
 	</para>
 </note>
 </section>



1.5       +2 -0      xmldocs/guides/install.xml


rev 1.5, prev_rev 1.4
Index: install.xml
===================================================================
RCS file: /var/cvs/xmldocs/guides/install.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- install.xml	4 Jul 2006 22:24:42 -0000	1.4
+++ install.xml	5 Jul 2006 14:03:30 -0000	1.5
@@ -202,6 +202,8 @@
 		is located. Also make sure to have write access to it.
 		Each catalog's link program will find its place somewhere beneath it.
 		</para>
+		<!-- TODO mention https and give apache example that would work if
+		paths are adjusted -->
 	</sect2>
 
 	<sect2 id='db'>



1.1                  xmldocs/howtos/expire-sessions


rev 1.1, prev_rev 1.0
Index: expire-sessions
===================================================================
Expire user sessions
</para></question>

<answer><para>
See the &glos-expire; glossary entry.




1.3       +3 -1      xmldocs/refs/DebugFile


rev 1.3, prev_rev 1.2
Index: DebugFile
===================================================================
RCS file: /var/cvs/xmldocs/refs/DebugFile,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- DebugFile	8 Dec 2004 12:39:58 -0000	1.2
+++ DebugFile	5 Jul 2006 14:03:30 -0000	1.3
@@ -36,7 +36,9 @@
 Also, as the <function>::logDebug()</function> statements are disabled
 (commented) 
 by default in Interchange sources, you'll probably want to use a special
-script for managing debug statements.
+script for managing debug statements, or manually uncomment parts of 
+debugging code in question (and restart Interchange, of course &mdash;
+see &howto-daemon-control;).
 __END__
 
 __NAME__ example: Setting DebugFile



1.6       +6 -0      xmldocs/refs/EncryptProgram


rev 1.6, prev_rev 1.5
Index: EncryptProgram
===================================================================
RCS file: /var/cvs/xmldocs/refs/EncryptProgram,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- EncryptProgram	12 Aug 2005 12:41:51 -0000	1.5
+++ EncryptProgram	5 Jul 2006 14:03:30 -0000	1.6
@@ -55,6 +55,12 @@
 </programlisting>
 __END__
 
+__NAME__ example: Specifying EncryptProgram with full path and arguments
+<programlisting>
+EncryptProgram /usr/bin/pgpe -fat -r orders@&def-domain;
+</programlisting>
+__END__
+
 __NAME__ missing
 PORT_OLD
 __END__








More information about the docs mailing list