1 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[
2 <!entity % dummy "IGNORE">
3 <!entity supported SYSTEM "supported.sgml">
4 <!entity newfeatures SYSTEM "newfeatures.sgml">
5 <!entity p-intro SYSTEM "privoxy.sgml">
6 <!entity history SYSTEM "history.sgml">
7 <!entity seealso SYSTEM "seealso.sgml">
8 <!entity contacting SYSTEM "contacting.sgml">
9 <!entity copyright SYSTEM "copyright.sgml">
10 <!entity license SYSTEM "license.sgml">
11 <!entity p-version "2.9.15">
12 <!entity p-status "beta">
13 <!entity % p-not-stable "INCLUDE">
14 <!entity % p-stable "IGNORE">
15 <!entity % p-text "IGNORE"> <!-- define we are not a text only doc -->
16 <!entity % p-doc "INCLUDE"> <!-- and we are a formal doc -->
17 <!entity my-copy "©"> <!-- kludge for docbook2man -->
20 File : $Source: /cvsroot/ijbswa/current/doc/source/developer-manual.sgml,v $
22 Purpose : developer manual
23 This file belongs into
24 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
26 $Id: developer-manual.sgml,v 1.51 2002/05/29 00:30:59 mal0rd Exp $
28 Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
31 ========================================================================
32 NOTE: Please read developer-manual/documentation.html before touching
33 anything in this, or other Privoxy documentation.
34 ========================================================================
40 <title>Privoxy Developer Manual</title>
43 <!-- Completely the wrong markup, but very little is allowed -->
44 <!-- in this part of an article. FIXME -->
45 <link linkend="copyright">Copyright</link> &my-copy; 2001, 2002 by
46 <ulink url="http://www.privoxy.org">Privoxy Developers</ulink>
51 <pubdate>$Id: developer-manual.sgml,v 1.51 2002/05/29 00:30:59 mal0rd Exp $</pubdate>
55 Note: this should generate a separate page, and a live link to it.
56 But it doesn't for some mysterious reason. Please leave commented
57 unless it can be fixed proper. For the time being, the copyright
58 statement will be in copyright.smgl.
62 <legalnotice id="legalnotice">
64 text goes here ........
75 This is here to keep vim syntax file from breaking :/
76 If I knew enough to fix it, I would.
77 PLEASE DO NOT REMOVE! HB: hal@foobox.net
82 The developer manual provides guidance on coding, testing, packaging, documentation
83 and other issues of importance to those involved with
84 <application>Privoxy</application> development. It is mandatory (and helpful!) reading
85 for anyone who wants to join the team.
88 <!-- Include privoxy.sgml boilerplate text: -->
90 <!-- &p-intro; Someone interested enough in the project to contribute
91 will already know at this point what Privoxy is. -->
93 <!-- end boilerplate -->
96 You can find the latest version of the this manual at <ulink
97 url="http://www.privoxy.org/developer-manual/">http://www.privoxy.org/developer-manual/</ulink>.
98 Please see <link linkend="contact">the Contact section</link>
99 on how to contact the developers.
102 <!-- Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
109 <!-- ~~~~~ New section ~~~~~ -->
110 <sect1 id="introduction"><title>Introduction</title>
113 I don't like seeing blank space :) So added *something* here.
117 <application>Privoxy</application>, as an heir to
118 <application>Junkbuster</application>, is an Open Source project
119 and licensed under the GPL. As such, <application>Privoxy</application>
120 development is potentially open to anyone who has the time, knowledge,
121 and desire to contribute in any capacity. Our goals are simply to
122 continue the mission, to improve <application>Privoxy</application>, and
123 to make it available to as wide an audience as possible.
126 One does not have to be a programmer to contribute. Packaging, testing,
127 and porting, are all important jobs as well.
130 <!-- ~~~~~ New section ~~~~~ -->
131 <sect2 id="quickstart"><title>Quickstart to Privoxy Development</title>
133 You'll need an account on <ulink
134 url="http://sourceforge.net/">Sourceforge</ulink> to support our
135 development. Mail your ID to <ulink
136 url="mailto:developers@privoxy.org">the list</ulink> and wait until a
137 project manager has added you.
140 For the time being (read, this section is under construction), please
141 refer to the extensive comments in the source code.
146 <!-- ~~~~~ New section ~~~~~ -->
147 <sect1 id="cvs"><title>The CVS Repository</title>
149 If you intend to help us with programming, documentation or packaging
150 you will need write access to our holy grail, the CVS repository.
151 Please read this chapter completely before accessing via CVS.
154 <sect2 id="cvsaccess"><title>Access to CVS</title>
156 The project's CVS repository is hosted on
157 <ulink url="http://sourceforge.net/">SourceForge.</ulink>
158 Please refer to the chapters 6 and 7 in
159 <ulink url="http://sourceforge.net/docman/?group_id=1">SF's site
160 documentation</ulink> for the technical access details for your
161 operating system. For historical reasons, the CVS server is
162 called <literal>cvs.ijbswa.sourceforge.net</literal>, the repository is
163 called <literal>ijbswa</literal>, and the source tree module is called
164 <literal>current</literal>.
168 <sect2 id="cvscommit"><title>CVS Commit Guideline</title>
170 The source tree is the heart of every software project. Every effort must
171 be made to ensure that it is readable, compilable and consistent at all
172 times. We therefore ask anyone with CVS access to strictly adhere to the
173 following guidelines:
176 Never (read: <emphasis>never, ever</emphasis>) be tempted to commit
177 that small change without testing it thoroughly first. When we're
178 close to a public release, ask a fellow developer to review your
182 Your commit message should give a concise overview of <emphasis>what you
183 changed</emphasis> (no big details) and <emphasis>why you changed it</emphasis>
184 Just check previous messages for good examples.
187 Don't use the same message on multiple files, unless it equally applies to
191 If your changes span multiple files, and the code won't recompile unless
192 all changes are committed (e.g. when changing the signature of a function),
193 then commit all files one after another, without long delays in between.
194 If necessary, prepare the commit messages in advance.
197 Before changing things on CVS, make sure that your changes are in line
198 with the team's general consensus on what should be done (see below).
204 <sect2 id="cvswhenask"><title>Discussing Changes First</title>
206 We don't have a too formal policy on this, just use common sense. Hints: If it is..
207 <orderedlist numeration="arabic">
209 ..a bug-fix / clean-up / cosmetic thing: shoot
212 ..a new feature that can be turned off: shoot
215 ..a clear improvement w/o side effects on other parts of the code: shoot
218 ..a matter of taste: <ulink url="mailto:developers@privoxy.org">ask the list</ulink>
221 ..a major redesign of some part of the code: <ulink url="mailto:developers@privoxy.org">ask
227 Note that near a major public release, we get a bit more cautious - if
228 unsure, it doesn't hurt to ask first. There is always the possibility
229 to submit a patch to the <ulink
230 url="http://sourceforge.net/tracker/?atid=311118&group_id=11118&func=browse">patches
231 tracker</ulink> instead.
236 <!-- ~~~~~ New section ~~~~~ -->
237 <sect1 id="documentation"><title>Documentation Guidelines</title>
239 All formal documents are maintained in Docbook SGML and located in the
240 <computeroutput>doc/source/*</computeroutput> directory. You will need
241 <ulink url="http://www.docbook.org">Docbook</ulink>, the Docbook
242 DTD's and the Docbook modular stylesheets (or comparable alternatives),
243 and either <application>jade</application> or
244 <application>openjade</application> (recommended) installed in order to
245 build docs from source. Currently there is <ulink
246 url="../user-manual/index.html"><citetitle>user-manual</citetitle></ulink>,
247 <ulink url="../faq/index.html"><citetitle>FAQ</citetitle></ulink>, and, of
248 course this, the <citetitle>developer-manual</citetitle> in this format.
249 The <citetitle>README</citetitle>, <citetitle>AUTHORS</citetitle>
250 <citetitle>privoxy.1</citetitle> (man page), and
251 <citetitle>config</citetitle> files are also now maintained as Docbook
252 SGML. These files, when built, in the top-level source directory are
253 generated files! Also, the <application>Privoxy</application> <filename>index.html</filename> (and a
254 variation on this file, <filename>privoxy-index.html</filename>,
255 meant for inclusion with doc packages), are maintained as SGML as well.
256 <emphasis>DO NOT edit these directly</emphasis>. Edit the SGML source, or
257 contact someone involved in the documentation (at present Stefan and
261 <filename>config</filename> requires some special handling. The reason it
262 is maintained this way is so that the extensive comments in the file
263 mirror those in <citetitle>user-manual</citetitle>. But the conversion
264 process requires going from SGML to HTML to text to special formatting
265 required for the embedded comments. Some of this does not survive so
266 well. Especially some of the examples that are longer than 80 characters.
267 The build process for this file outputs to <filename>config.new</filename>,
268 which should be reviewed for errors and mis-formatting. Once satisfied
269 that it is correct, then it should be hand copied to
270 <filename>config</filename>.
274 Other, less formal documents (e.g. <filename>LICENSE</filename>,
275 <filename>INSTALL</filename>) are maintained as plain text files in the
276 top-level source directory. At least for the time being.
279 Packagers are encouraged to include this documentation. For those without
280 the ability to build the docs locally, text versions of each are kept in
281 CVS. HTML versions are also now being kept in CVS under
282 <filename>doc/webserver/*</filename>.
285 Formal documents are built with the Makefile targets of
286 <computeroutput>make dok</computeroutput>, or alternately
287 <computeroutput>make redhat-dok</computeroutput>. If you have problems,
288 try both. The build process uses the document SGML sources in
289 <computeroutput>doc/source/*/*</computeroutput> to update all text files in
290 <computeroutput>doc/text/</computeroutput> and to update all HTML
291 documents in <computeroutput>doc/webserver/</computeroutput>.
294 Documentation writers should please make sure documents build
295 successfully before committing to CVS, if possible.
298 How do you update the webserver (i.e. the pages on privoxy.org)?
300 <orderedlist numeration="arabic">
302 First, build the docs by running <computeroutput>make
303 dok</computeroutput> (or alternately <computeroutput>make
304 redhat-dok</computeroutput>).
307 Run <computeroutput>make webserver</computeroutput> which copies all
308 files from <computeroutput>doc/webserver</computeroutput> to the
309 sourceforge webserver via scp.
315 Finished docs should be occasionally submitted to CVS
316 (<filename>doc/webserver/*/*.html</filename>) so that those without
317 the ability to build them locally, have access to them if needed.
318 This is especially important just prior to a new release! Please
319 do this <emphasis>after</emphasis> the <literal>$VERSION</literal> and
320 other release specific data in <filename>configure.in</filename> has been
321 updated (this is done just prior to a new release).
324 <!-- ~~~~~ New section ~~~~~ -->
326 <title>Quickstart to Docbook and SGML</title>
328 If you are not familiar with SGML, it is a markup language similar to HTML.
329 Actually, not a mark up language per se, but a language used to define
330 markup languages. In fact, HTML is an SGML application. Both will use
331 <quote>tags</quote> to format text and other content. SGML tags can be much
332 more varied, and flexible, but do much of the same kinds of things. The tags,
333 or <quote>elements</quote>, are definable in SGML. There is no set
334 <quote>standards</quote>. Since we are using
335 <application>Docbook</application>, our tags are those that are defined by
336 <application>Docbook</application>. Much of how the finish document is
337 rendered is determined by the <quote>stylesheets</quote>.
338 The stylesheets determine how each tag gets translated to HTML, or other
343 Tags in Docbook SGML need to be always <quote>closed</quote>. If not, you
344 will likely generate errors. Example: <literal><title>My
345 Title</title></literal>. They are also case-insensitive, but we
346 strongly suggest using all lower case. This keeps compatibility with
347 [Docbook] <application>XML</application>.
351 Our documents use <quote>sections</quote> for the most part. Sections
352 will be processed into HTML headers (e.g. <literal>h1</literal> for
353 <literal>sect1</literal>). The <application>Docbook</application> stylesheets
354 will use these to also generate the Table of Contents for each doc. Our
355 TOC's are set to a depth of three. Meaning <literal>sect1</literal>,
356 <literal>sect2</literal>, and <literal>sect3</literal> will have TOC
357 entries, but <literal>sect4</literal> will not. Each section requires
358 a <literal><title></literal> element, and at least one
359 <literal><para></literal>. There is a limit of five section
360 levels in Docbook, but generally three should be sufficient for our
365 Some common elements that you likely will use:
371 <emphasis><para></para></emphasis>, paragraph delimiter. Most
372 text needs to be within paragraph elements (there are some exceptions).
375 <emphasis><emphasis></emphasis></emphasis>, the stylesheets
379 <emphasis><filename></filename></emphasis>, files and directories.
382 <emphasis><command></command></emphasis>, command examples.
385 <emphasis><literallayout></literallayout></emphasis>, like
386 <literal><pre></literal>, more or less.
389 <emphasis><itemizedlist></itemizedlist></emphasis>, list with bullets.
392 <emphasis><listitem></listitem></emphasis>, member of the above.
395 <emphasis><screen></screen></emphasis>, screen output, implies
396 <literal><literallayout></literal>.
399 <emphasis><ulink url="example.com"></ulink></emphasis>, like
400 HTML <literal><a></literal> tag.
403 <emphasis><quote></quote></emphasis>, for, doh, quoting text.
409 Look at any of the existing docs for examples of all these and more.
413 You might also find <quote><ulink
414 url="http://www.bureau-cornavin.com/opensource/crash-course/">Writing Documentation
415 Using DocBook - A Crash Course</ulink></quote> useful.
419 <!-- ~~~~~ New section ~~~~~ -->
420 <sect2 id="docstyle">
421 <title><application>Privoxy</application> Documentation Style</title>
423 It will be easier if everyone follows a similar writing style. This
424 just makes it easier to read what someone else has written if it
425 is all done in a similar fashion.
434 All tags should be lower case.
439 Tags delimiting a <emphasis>block</emphasis> of text (even small
440 blocks) should be on their own line. Like:
446 Tags marking individual words, or few words, should be in-line:
448 Just to <emphasis>emphasize</emphasis>, some text goes here.
454 Tags should be nested and step indented for block text like: (except
461 Some text goes here in our list example.
464 </itemizedlist>
467 This makes it easier to find the text amongst the tags ;-)
472 Use white space to separate logical divisions within a document,
473 like between sections. Running everything together consistently
474 makes it harder to read and work on.
479 Do not hesitate to make comments. Comments can either use the
480 <comment> element, or the <!-- --> style comment
481 familiar from HTML. (Note in Docbook v4.x <comment> is
482 replaced by <remark>.)
487 We have an international audience. Refrain from slang, or English
488 idiosyncrasies (too many to list :). Humor also does not translate
494 Try to keep overall line lengths in source files to 80 characters or less
495 for obvious reasons. This is not always possible, with lengthy URLs for
501 Our documents are available in differing formats. Right now, they
502 are just plain text, and HTML, but PDF, and others is always a
503 future possibility. Be careful with URLs (<ulink>), and avoid
507 My favorite site is <ulink url="http://example.com">here</ulink>.
510 This will render as <quote>My favorite site is here</quote>, which is
511 not real helpful in a text doc. Better like this:
514 My favorite site is <ulink url="http://example.com">example.com</ulink>.
519 All documents should be spell checked occasionally.
520 <application>aspell</application> can check SGML with the
521 <literal>-H</literal> option. (<application>ispell</application> I think
532 <!-- ~~~~~ New section ~~~~~ -->
534 <sect2><title>Privoxy Custom Entities</title>
536 <application>Privoxy</application> documentation is using
537 a number of customized <quote>entities</quote> to facilitate
538 documentation maintenance.
541 We are using a set of <quote>boilerplate</quote> files with generic text,
542 that is used by multiple docs. This way we can write something once, and use
543 it repeatedly without having to re-write the same content over and over again.
544 If editing such a file, keep in mind that it should be
545 <emphasis>generic</emphasis>. That is the purpose; so it can be used in varying
546 contexts without additional modifications.
549 We are also using what <application>Docbook</application> calls
550 <quote>internal entities</quote>. These are like variables in
551 programming. Well, sort of. For instance, we have the
552 <literal>p-version</literal> entity that contains the current
553 <application>Privoxy</application> version string. You are strongly
554 encouraged to use these where possible. Some of these obviously
555 require re-setting with each release (done by the Makefile). A sampling of
556 custom entities are listed below. See any of the main docs for examples.
563 Re- <quote>boilerplate</quote> text entities are defined like:
566 <literal><!entity supported SYSTEM "supported.sgml"></literal>
569 In this example, the contents of the file,
570 <filename>supported.sgml</filename> is available for inclusion anywhere
571 in the doc. To make this happen, just reference the now defined
572 entity: <literal>&supported;</literal> (starts with an ampersand
573 and ends with a semi-colon), and the contents will be dumped into
574 the finished doc at that point.
579 Commonly used <quote>internal entities</quote>:
583 <emphasis>p-version</emphasis>: the <application>Privoxy</application>
584 version string, e.g. <quote>&p-version;</quote>.
587 <emphasis>p-status</emphasis>: the project status, either
588 <quote>alpha</quote>, <quote>beta</quote>, or <quote>stable</quote>.
591 <emphasis>p-not-stable</emphasis>: use to conditionally include
592 text in <quote>not stable</quote> releases (e.g. <quote>beta</quote>).
595 <emphasis>p-stable</emphasis>: just the opposite.
598 <emphasis>p-text</emphasis>: this doc is only generated as text.
605 There are others in various places that are defined for a specific
606 purpose. Read the source!
613 <!-- <listitem><para>be consistent with the redirect script (i.e. the <application>Privoxy</application> program -->
614 <!-- points via the redirect URL at sf to valid end-points in the document)</para></listitem> -->
616 <!-- ~~~~~ New section ~~~~~ -->
617 <sect1 id="coding"><title>Coding Guidelines</title>
619 <sect2 id="s1"><title>Introduction</title>
621 <para>This set of standards is designed to make our lives easier. It is
622 developed with the simple goal of helping us keep the "new and improved
623 <application>Privoxy</application>" consistent and reliable. Thus making
624 maintenance easier and increasing chances of success of the
627 <para>And that of course comes back to us as individuals. If we can
628 increase our development and product efficiencies then we can solve more
629 of the request for changes/improvements and in general feel good about
630 ourselves. ;-></para>
634 <sect2 id="s2"><title>Using Comments</title>
637 <sect3 id="s3"><title>Comment, Comment, Comment</title>
639 <para><emphasis>Explanation:</emphasis></para>
641 <para>Comment as much as possible without commenting the obvious.
642 For example do not comment "aVariable is equal to bVariable".
643 Instead explain why aVariable should be equal to the bVariable.
644 Just because a person can read code does not mean they will
645 understand why or what is being done. A reader may spend a lot
646 more time figuring out what is going on when a simple comment
647 or explanation would have prevented the extra research. Please
648 help your brother IJB'ers out!</para>
650 <para>The comments will also help justify the intent of the code.
651 If the comment describes something different than what the code
652 is doing then maybe a programming error is occurring.</para>
654 <para><emphasis>Example:</emphasis></para>
656 /* if page size greater than 1k ... */
657 if ( PageLength() > 1024 )
659 ... "block" the page up ...
662 /* if page size is small, send it in blocks */
663 if ( PageLength() > 1024 )
665 ... "block" the page up ...
668 This demonstrates 2 cases of "what not to do". The first is a
669 "syntax comment". The second is a comment that does not fit what
670 is actually being done.
676 <sect3 id="s4"><title>Use blocks for comments</title>
678 <para><emphasis>Explanation:</emphasis></para>
680 <para>Comments can help or they can clutter. They help when they
681 are differentiated from the code they describe. One line
682 comments do not offer effective separation between the comment
683 and the code. Block identifiers do, by surrounding the code
684 with a clear, definable pattern.</para>
686 <para><emphasis>Example:</emphasis></para>
688 /*********************************************************************
689 * This will stand out clearly in your code!
690 *********************************************************************/
691 if ( thisVariable == thatVariable )
693 DoSomethingVeryImportant();
697 /* unfortunately, this may not */
698 if ( thisVariable == thatVariable )
700 DoSomethingVeryImportant();
704 if ( thisVariable == thatVariable ) /* this may not either */
706 DoSomethingVeryImportant();
709 <para><emphasis>Exception:</emphasis></para>
711 <para>If you are trying to add a small logic comment and do not
712 wish to "disrupt" the flow of the code, feel free to use a 1
713 line comment which is NOT on the same line as the code.</para>
719 <sect3 id="s5"><title>Keep Comments on their own line</title>
721 <para><emphasis>Explanation:</emphasis></para>
723 <para>It goes back to the question of readability. If the comment
724 is on the same line as the code it will be harder to read than
725 the comment that is on its own line.</para>
727 <para>There are three exceptions to this rule, which should be
728 violated freely and often: during the definition of variables,
729 at the end of closing braces, when used to comment
732 <para><emphasis>Example:</emphasis></para>
734 /*********************************************************************
735 * This will stand out clearly in your code,
736 * But the second example won't.
737 *********************************************************************/
738 if ( thisVariable == thatVariable )
740 DoSomethingVeryImportant();
743 if ( thisVariable == thatVariable ) /*can you see me?*/
745 DoSomethingVeryImportant(); /*not easily*/
749 /*********************************************************************
750 * But, the encouraged exceptions:
751 *********************************************************************/
752 int urls_read = 0; /* # of urls read + rejected */
753 int urls_rejected = 0; /* # of urls rejected */
757 DoSomethingVeryImportant();
761 short DoSomethingVeryImportant(
762 short firstparam, /* represents something */
763 short nextparam /* represents something else */ )
767 } /* -END- DoSomethingVeryImportant */
772 <sect3 id="s6"><title>Comment each logical step</title>
774 <para><emphasis>Explanation:</emphasis></para>
776 <para>Logical steps should be commented to help others follow the
777 intent of the written code and comments will make the code more
780 <para>If you have 25 lines of code without a comment, you should
781 probably go back into it to see where you forgot to put
784 <para>Most "for", "while", "do", etc... loops _probably_ need a
785 comment. After all, these are usually major logic
792 <sect3 id="s7"><title>Comment All Functions Thoroughly</title>
794 <para><emphasis>Explanation:</emphasis></para>
796 <para>A reader of the code should be able to look at the comments
797 just prior to the beginning of a function and discern the
798 reason for its existence and the consequences of using it. The
799 reader should not have to read through the code to determine if
800 a given function is safe for a desired use. The proper
801 information thoroughly presented at the introduction of a
802 function not only saves time for subsequent maintenance or
803 debugging, it more importantly aids in code reuse by allowing a
804 user to determine the safety and applicability of any function
805 for the problem at hand. As a result of such benefits, all
806 functions should contain the information presented in the
807 addendum section of this document.</para>
813 <sect3 id="s8"><title>Comment at the end of braces if the
814 content is more than one screen length</title>
816 <para><emphasis>Explanation:</emphasis></para>
818 <para>Each closing brace should be followed on the same line by a
819 comment that describes the origination of the brace if the
820 original brace is off of the screen, or otherwise far away from
821 the closing brace. This will simplify the debugging,
822 maintenance, and readability of the code.</para>
824 <para>As a suggestion , use the following flags to make the
825 comment and its brace more readable:</para>
827 <para>use following a closing brace: } /* -END- if() or while ()
830 <para><emphasis>Example:</emphasis></para>
834 DoSomethingVeryImportant();
835 ...some long list of commands...
836 } /* -END- if x is 1 */
842 DoSomethingVeryImportant();
843 ...some long list of commands...
844 } /* -END- if ( 1 == X ) */
850 <sect2 id="s9"><title>Naming Conventions</title>
854 <sect3 id="s10"><title>Variable Names</title>
856 <para><emphasis>Explanation:</emphasis></para>
858 <para>Use all lowercase, and separate words via an underscore
859 ('_'). Do not start an identifier with an underscore. (ANSI C
860 reserves these for use by the compiler and system headers.) Do
861 not use identifiers which are reserved in ANSI C++. (E.g.
862 template, class, true, false, ...). This is in case we ever
863 decide to port Privoxy to C++.</para>
865 <para><emphasis>Example:</emphasis></para>
867 int ms_iis5_hack = 0;</programlisting>
869 <para><emphasis>Instead of:</emphasis></para>
873 int msiis5hack = 0; int msIis5Hack = 0;
881 <sect3 id="s11"><title>Function Names</title>
883 <para><emphasis>Explanation:</emphasis></para>
885 <para>Use all lowercase, and separate words via an underscore
886 ('_'). Do not start an identifier with an underscore. (ANSI C
887 reserves these for use by the compiler and system headers.) Do
888 not use identifiers which are reserved in ANSI C++. (E.g.
889 template, class, true, false, ...). This is in case we ever
890 decide to port Privoxy to C++.</para>
892 <para><emphasis>Example:</emphasis></para>
894 int load_some_file( struct client_state *csp )</programlisting>
896 <para><emphasis>Instead of:</emphasis></para>
900 int loadsomefile( struct client_state *csp )
901 int loadSomeFile( struct client_state *csp )
909 <sect3 id="s12"><title>Header file prototypes</title>
911 <para><emphasis>Explanation:</emphasis></para>
913 <para>Use a descriptive parameter name in the function prototype
914 in header files. Use the same parameter name in the header file
915 that you use in the c file.</para>
917 <para><emphasis>Example:</emphasis></para>
919 (.h) extern int load_aclfile( struct client_state *csp );
920 (.c) int load_aclfile( struct client_state *csp )</programlisting>
922 <para><emphasis>Instead of:</emphasis>
924 (.h) extern int load_aclfile( struct client_state * ); or
925 (.h) extern int load_aclfile();
926 (.c) int load_aclfile( struct client_state *csp )
934 <sect3 id="s13"><title>Enumerations, and #defines</title>
936 <para><emphasis>Explanation:</emphasis></para>
938 <para>Use all capital letters, with underscores between words. Do
939 not start an identifier with an underscore. (ANSI C reserves
940 these for use by the compiler and system headers.)</para>
942 <para><emphasis>Example:</emphasis></para>
944 (enumeration) : enum Boolean { FALSE, TRUE };
945 (#define) : #define DEFAULT_SIZE 100;</programlisting>
947 <para><emphasis>Note:</emphasis> We have a standard naming scheme for #defines
948 that toggle a feature in the preprocessor: FEATURE_>, where
949 > is a short (preferably 1 or 2 word) description.</para>
951 <para><emphasis>Example:</emphasis></para>
953 #define FEATURE_FORCE 1
956 #define FORCE_PREFIX blah
957 #endif /* def FEATURE_FORCE */
962 <sect3 id="s14"><title>Constants</title>
964 <para><emphasis>Explanation:</emphasis></para>
966 <para>Spell common words out entirely (do not remove vowels).</para>
968 <para>Use only widely-known domain acronyms and abbreviations.
969 Capitalize all letters of an acronym.</para>
971 <para>Use underscore (_) to separate adjacent acronyms and
972 abbreviations. Never terminate a name with an underscore.</para>
974 <para><emphasis>Example:</emphasis></para>
976 #define USE_IMAGE_LIST 1</programlisting>
978 <para><emphasis>Instead of:</emphasis></para>
982 #define USE_IMG_LST 1 or
983 #define _USE_IMAGE_LIST 1 or
984 #define USE_IMAGE_LIST_ 1 or
985 #define use_image_list 1 or
986 #define UseImageList 1
996 <sect2 id="s15"><title>Using Space</title>
1000 <sect3 id="s16"><title>Put braces on a line by themselves.</title>
1002 <para><emphasis>Explanation:</emphasis></para>
1004 <para>The brace needs to be on a line all by itself, not at the
1005 end of the statement. Curly braces should line up with the
1006 construct that they're associated with. This practice makes it
1007 easier to identify the opening and closing braces for a
1010 <para><emphasis>Example:</emphasis></para>
1017 <para><emphasis>Instead of:</emphasis></para>
1019 <para>if ( this == that ) { ... }</para>
1023 <para>if ( this == that ) { ... }</para>
1025 <para><emphasis>Note:</emphasis> In the special case that the if-statement is
1026 inside a loop, and it is trivial, i.e. it tests for a
1027 condition that is obvious from the purpose of the block,
1028 one-liners as above may optically preserve the loop structure
1029 and make it easier to read.</para>
1031 <para><emphasis>Status:</emphasis> developer-discretion.</para>
1033 <para><emphasis>Example exception:</emphasis></para>
1035 while ( more lines are read )
1037 /* Please document what is/is not a comment line here */
1038 if ( it's a comment ) continue;
1040 do_something( line );
1046 <sect3 id="s17"><title>ALL control statements should have a
1049 <para><emphasis>Explanation:</emphasis></para>
1051 <para>Using braces to make a block will make your code more
1052 readable and less prone to error. All control statements should
1053 have a block defined.</para>
1055 <para><emphasis>Example:</emphasis></para>
1063 <para><emphasis>Instead of:</emphasis></para>
1065 <para>if ( this == that ) DoSomething(); DoSomethingElse();</para>
1069 <para>if ( this == that ) DoSomething();</para>
1071 <para><emphasis>Note:</emphasis> The first example in "Instead of" will execute
1072 in a manner other than that which the developer desired (per
1073 indentation). Using code braces would have prevented this
1074 "feature". The "explanation" and "exception" from the point
1075 above also applies.</para>
1081 <sect3 id="s18"><title>Do not belabor/blow-up boolean
1084 <para><emphasis>Example:</emphasis></para>
1086 structure->flag = ( condition );</programlisting>
1088 <para><emphasis>Instead of:</emphasis></para>
1090 <para>if ( condition ) { structure->flag = 1; } else {
1091 structure->flag = 0; }</para>
1093 <para><emphasis>Note:</emphasis> The former is readable and concise. The later
1094 is wordy and inefficient. Please assume that any developer new
1095 to the project has at least a "good" knowledge of C/C++. (Hope
1096 I do not offend by that last comment ... 8-)</para>
1102 <sect3 id="s19"><title>Use white space freely because it is
1105 <para><emphasis>Explanation:</emphasis></para>
1107 <para>Make it readable. The notable exception to using white space
1108 freely is listed in the next guideline.</para>
1110 <para><emphasis>Example:</emphasis></para>
1114 int anotherValue = 0;
1115 int thisVariable = 0;
1117 if ( thisVariable == thatVariable )
1119 firstValue = oldValue + ( ( someValue - anotherValue ) - whatever )
1124 <sect3 id="s20"><title>Don't use white space around structure
1127 <para><emphasis>Explanation:</emphasis></para>
1129 <para>- structure pointer operator ( "->" ) - member operator (
1130 "." ) - functions and parentheses</para>
1132 <para>It is a general coding practice to put pointers, references,
1133 and function parentheses next to names. With spaces, the
1134 connection between the object and variable/function name is not
1137 <para><emphasis>Example:</emphasis></para>
1141 FunctionName();</programlisting>
1143 <para><emphasis>Instead of:</emphasis> aStruct -> aMember; aStruct . aMember;
1144 FunctionName ();</para>
1150 <sect3 id="s21"><title>Make the last brace of a function stand
1153 <para><emphasis>Example:</emphasis></para>
1155 int function1( ... )
1160 } /* -END- function1 */
1163 int function2( ... )
1165 } /* -END- function2 */
1168 <para><emphasis>Instead of:</emphasis></para>
1170 <para>int function1( ... ) { ...code... return( retCode ); } int
1171 function2( ... ) { }</para>
1173 <para><emphasis>Note:</emphasis> Use 1 blank line before the closing brace and 2
1174 lines afterward. This makes the end of function standout to
1175 the most casual viewer. Although function comments help
1176 separate functions, this is still a good coding practice. In
1177 fact, I follow these rules when using blocks in "for", "while",
1178 "do" loops, and long if {} statements too. After all whitespace
1181 <para><emphasis>Status:</emphasis> developer-discretion on the number of blank
1182 lines. Enforced is the end of function comments.</para>
1188 <sect3 id="s22"><title>Use 3 character indentions</title>
1190 <para><emphasis>Explanation:</emphasis></para>
1192 <para>If some use 8 character TABs and some use 3 character TABs,
1193 the code can look *very* ragged. So use 3 character indentions
1194 only. If you like to use TABs, pass your code through a filter
1195 such as "expand -t3" before checking in your code.</para>
1197 <para><emphasis>Example:</emphasis></para>
1199 static const char * const url_code_map[256] =
1205 int function1( ... )
1209 return( ALWAYS_TRUE );
1213 return( HOW_DID_YOU_GET_HERE );
1216 return( NEVER_GETS_HERE );
1225 <sect2 id="s23"><title>Initializing</title>
1229 <sect3 id="s24"><title>Initialize all variables</title>
1231 <para><emphasis>Explanation:</emphasis></para>
1233 <para>Do not assume that the variables declared will not be used
1234 until after they have been assigned a value somewhere else in
1235 the code. Remove the chance of accidentally using an unassigned
1238 <para><emphasis>Example:</emphasis></para>
1242 struct *ptr = NULL;</programlisting>
1244 <para><emphasis>Note:</emphasis> It is much easier to debug a SIGSEGV if the
1245 message says you are trying to access memory address 00000000
1246 and not 129FA012; or arrayPtr[20] causes a SIGSEV vs.
1249 <para><emphasis>Status:</emphasis> developer-discretion if and only if the
1250 variable is assigned a value "shortly after" declaration.</para>
1256 <sect2 id="s25"><title>Functions</title>
1260 <sect3 id="s26"><title>Name functions that return a boolean as a
1263 <para><emphasis>Explanation:</emphasis></para>
1265 <para>Value should be phrased as a question that would logically
1266 be answered as a true or false statement</para>
1268 <para><emphasis>Example:</emphasis></para>
1270 ShouldWeBlockThis();
1277 <sect3 id="s27"><title>Always specify a return type for a
1280 <para><emphasis>Explanation:</emphasis></para>
1282 <para>The default return for a function is an int. To avoid
1283 ambiguity, create a return for a function when the return has a
1284 purpose, and create a void return type if the function does not
1285 need to return anything.</para>
1291 <sect3 id="s28"><title>Minimize function calls when iterating by
1292 using variables</title>
1294 <para><emphasis>Explanation:</emphasis></para>
1296 <para>It is easy to write the following code, and a clear argument
1297 can be made that the code is easy to understand:</para>
1299 <para><emphasis>Example:</emphasis></para>
1301 for ( size_t cnt = 0; cnt < blockListLength(); cnt ++ )
1306 <para><emphasis>Note:</emphasis> Unfortunately, this makes a function call for
1307 each and every iteration. This increases the overhead in the
1308 program, because the compiler has to look up the function each
1309 time, call it, and return a value. Depending on what occurs in
1310 the blockListLength() call, it might even be creating and
1311 destroying structures with each iteration, even though in each
1312 case it is comparing "cnt" to the same value, over and over.
1313 Remember too - even a call to blockListLength() is a function
1314 call, with the same overhead.</para>
1316 <para>Instead of using a function call during the iterations,
1317 assign the value to a variable, and evaluate using the
1320 <para><emphasis>Example:</emphasis></para>
1322 size_t len = blockListLength();
1324 for ( size_t cnt = 0; cnt < len; cnt ++ )
1329 <para><emphasis>Exceptions:</emphasis> if the value of blockListLength() *may*
1330 change or could *potentially* change, then you must code the
1331 function call in the for/while loop.</para>
1337 <sect3 id="s29"><title>Pass and Return by Const Reference</title>
1339 <para><emphasis>Explanation:</emphasis></para>
1341 <para>This allows a developer to define a const pointer and call
1342 your function. If your function does not have the const
1343 keyword, we may not be able to use your function. Consider
1344 strcmp, if it were defined as: extern int strcmp( char *s1,
1347 <para>I could then not use it to compare argv's in main: int main(
1348 int argc, const char *argv[] ) { strcmp( argv[0], "privoxy"
1351 <para>Both these pointers are *const*! If the c runtime library
1352 maintainers do it, we should too.</para>
1358 <sect3 id="s30"><title>Pass and Return by Value</title>
1360 <para><emphasis>Explanation:</emphasis></para>
1362 <para>Most structures cannot fit onto a normal stack entry (i.e.
1363 they are not 4 bytes or less). Aka, a function declaration
1364 like: int load_aclfile( struct client_state csp )</para>
1366 <para>would not work. So, to be consistent, we should declare all
1367 prototypes with "pass by value": int load_aclfile( struct
1368 client_state *csp )</para>
1374 <sect3 id="s31"><title>Names of include files</title>
1376 <para><emphasis>Explanation:</emphasis></para>
1378 <para>Your include statements should contain the file name without
1379 a path. The path should be listed in the Makefile, using -I as
1380 processor directive to search the indicated paths. An exception
1381 to this would be for some proprietary software that utilizes a
1382 partial path to distinguish their header files from system or
1383 other header files.</para>
1385 <para><emphasis>Example:</emphasis></para>
1387 #include <iostream.h> /* This is not a local include */
1388 #include "config.h" /* This IS a local include */
1391 <para><emphasis>Exception:</emphasis></para>
1395 /* This is not a local include, but requires a path element. */
1396 #include <sys/fileName.h>
1400 <para><emphasis>Note:</emphasis> Please! do not add "-I." to the Makefile
1401 without a _very_ good reason. This duplicates the #include
1402 "file.h" behavior.</para>
1408 <sect3 id="s32"><title>Provide multiple inclusion
1411 <para><emphasis>Explanation:</emphasis></para>
1413 <para>Prevents compiler and linker errors resulting from
1414 redefinition of items.</para>
1416 <para>Wrap each header file with the following syntax to prevent
1417 multiple inclusions of the file. Of course, replace PROJECT_H
1418 with your file name, with "." Changed to "_", and make it
1421 <para><emphasis>Example:</emphasis></para>
1423 #ifndef PROJECT_H_INCLUDED
1424 #define PROJECT_H_INCLUDED
1426 #endif /* ndef PROJECT_H_INCLUDED */
1431 <sect3 id="s33"><title>Use `extern "C"` when appropriate</title>
1433 <para><emphasis>Explanation:</emphasis></para>
1435 <para>If our headers are included from C++, they must declare our
1436 functions as `extern "C"`. This has no cost in C, but increases
1437 the potential re-usability of our code.</para>
1439 <para><emphasis>Example:</emphasis></para>
1444 #endif /* def __cplusplus */
1446 ... function definitions here ...
1450 #endif /* def __cplusplus */
1455 <sect3 id="s34"><title>Where Possible, Use Forward Struct
1456 Declaration Instead of Includes</title>
1458 <para><emphasis>Explanation:</emphasis></para>
1460 <para>Useful in headers that include pointers to other struct's.
1461 Modifications to excess header files may cause needless
1464 <para><emphasis>Example:</emphasis></para>
1466 /*********************************************************************
1467 * We're avoiding an include statement here!
1468 *********************************************************************/
1470 extern file_list *xyz;</programlisting>
1472 <para><emphasis>Note:</emphasis> If you declare "file_list xyz;" (without the
1473 pointer), then including the proper header file is necessary.
1474 If you only want to prototype a pointer, however, the header
1475 file is unnecessary.</para>
1477 <para><emphasis>Status:</emphasis> Use with discretion.</para>
1483 <sect2 id="s35"><title>General Coding Practices</title>
1487 <sect3 id="s36"><title>Turn on warnings</title>
1489 <para><emphasis>Explanation</emphasis></para>
1491 <para>Compiler warnings are meant to help you find bugs. You
1492 should turn on as many as possible. With GCC, the switch is
1493 "-Wall". Try and fix as many warnings as possible.</para>
1499 <sect3 id="s37"><title>Provide a default case for all switch
1502 <para><emphasis>Explanation:</emphasis></para>
1504 <para>What you think is guaranteed is never really guaranteed. The
1505 value that you don't think you need to check is the one that
1506 someday will be passed. So, to protect yourself from the
1507 unknown, always have a default step in a switch statement.</para>
1509 <para><emphasis>Example:</emphasis></para>
1511 switch( hash_string( cmd ) )
1513 case hash_actions_file :
1523 ... anomaly code goes here ...
1524 continue; / break; / exit( 1 ); / etc ...
1526 } /* end switch( hash_string( cmd ) ) */</programlisting>
1528 <para><emphasis>Note:</emphasis> If you already have a default condition, you
1529 are obviously exempt from this point. Of note, most of the
1530 WIN32 code calls `DefWindowProc' after the switch statement.
1531 This API call *should* be included in a default statement.</para>
1533 <para><emphasis>Another Note:</emphasis> This is not so much a readability issue
1534 as a robust programming issue. The "anomaly code goes here" may
1535 be no more than a print to the STDERR stream (as in
1536 load_config). Or it may really be an ABEND condition.</para>
1538 <para><emphasis>Status:</emphasis> Programmer discretion is advised.</para>
1544 <sect3 id="s38"><title>Try to avoid falling through cases in a
1545 switch statement.</title>
1547 <para><emphasis>Explanation:</emphasis></para>
1549 <para>In general, you will want to have a 'break' statement within
1550 each 'case' of a switch statement. This allows for the code to
1551 be more readable and understandable, and furthermore can
1552 prevent unwanted surprises if someone else later gets creative
1553 and moves the code around.</para>
1555 <para>The language allows you to plan the fall through from one
1556 case statement to another simply by omitting the break
1557 statement within the case statement. This feature does have
1558 benefits, but should only be used in rare cases. In general,
1559 use a break statement for each case statement.</para>
1561 <para>If you choose to allow fall through, you should comment both
1562 the fact of the fall through and reason why you felt it was
1569 <sect3 id="s39"><title>Use 'long' or 'short' Instead of
1572 <para><emphasis>Explanation:</emphasis></para>
1574 <para>On 32-bit platforms, int usually has the range of long. On
1575 16-bit platforms, int has the range of short.</para>
1577 <para><emphasis>Status:</emphasis> open-to-debate. In the case of most FSF
1578 projects (including X/GNU-Emacs), there are typedefs to int4,
1579 int8, int16, (or equivalence ... I forget the exact typedefs
1580 now). Should we add these to IJB now that we have a "configure"
1587 <sect3 id="s40"><title>Don't mix size_t and other types</title>
1589 <para><emphasis>Explanation:</emphasis></para>
1591 <para>The type of size_t varies across platforms. Do not make
1592 assumptions about whether it is signed or unsigned, or about
1593 how long it is. Do not compare a size_t against another
1594 variable of a different type (or even against a constant)
1595 without casting one of the values. Try to avoid using size_t if
1602 <sect3 id="s41"><title>Declare each variable and struct on its
1605 <para><emphasis>Explanation:</emphasis></para>
1607 <para>It can be tempting to declare a series of variables all on
1608 one line. Don't.</para>
1610 <para><emphasis>Example:</emphasis></para>
1614 long c = 0;</programlisting>
1616 <para><emphasis>Instead of:</emphasis></para>
1618 <para>long a, b, c;</para>
1620 <para><emphasis>Explanation:</emphasis> - there is more room for comments on the
1621 individual variables - easier to add new variables without
1622 messing up the original ones - when searching on a variable to
1623 find its type, there is less clutter to "visually"
1626 <para><emphasis>Exceptions:</emphasis> when you want to declare a bunch of loop
1627 variables or other trivial variables; feel free to declare them
1628 on 1 line. You should, although, provide a good comment on
1629 their functions.</para>
1631 <para><emphasis>Status:</emphasis> developer-discretion.</para>
1637 <sect3 id="s42"><title>Use malloc/zalloc sparingly</title>
1639 <para><emphasis>Explanation:</emphasis></para>
1641 <para>Create a local struct (on the stack) if the variable will
1642 live and die within the context of one function call.</para>
1644 <para>Only "malloc" a struct (on the heap) if the variable's life
1645 will extend beyond the context of one function call.</para>
1647 <para><emphasis>Example:</emphasis></para>
1649 If a function creates a struct and stores a pointer to it in a
1650 list, then it should definitely be allocated via `malloc'.
1655 <sect3 id="s43"><title>The Programmer Who Uses 'malloc' is
1656 Responsible for Ensuring 'free'</title>
1658 <para><emphasis>Explanation:</emphasis></para>
1660 <para>If you have to "malloc" an instance, you are responsible for
1661 insuring that the instance is `free'd, even if the deallocation
1662 event falls within some other programmer's code. You are also
1663 responsible for ensuring that deletion is timely (i.e. not too
1664 soon, not too late). This is known as "low-coupling" and is a
1665 "good thing (tm)". You may need to offer a
1666 free/unload/destructor type function to accommodate this.</para>
1668 <para><emphasis>Example:</emphasis></para>
1670 int load_re_filterfile( struct client_state *csp ) { ... }
1671 static void unload_re_filterfile( void *f ) { ... }</programlisting>
1673 <para><emphasis>Exceptions:</emphasis></para>
1675 <para>The developer cannot be expected to provide `free'ing
1676 functions for C run-time library functions ... such as
1679 <para><emphasis>Status:</emphasis> developer-discretion. The "main" use of this
1680 standard is for allocating and freeing data structures (complex
1687 <sect3 id="s44"><title>Add loaders to the `file_list' structure
1688 and in order</title>
1690 <para><emphasis>Explanation:</emphasis></para>
1692 <para>I have ordered all of the "blocker" file code to be in alpha
1693 order. It is easier to add/read new blockers when you expect a
1694 certain order.</para>
1696 <para><emphasis>Note:</emphasis> It may appear that the alpha order is broken in
1697 places by POPUP tests coming before PCRS tests. But since
1698 POPUPs can also be referred to as KILLPOPUPs, it is clear that
1699 it should come first.</para>
1705 <sect3 id="s45"><title>"Uncertain" new code and/or changes to
1706 existing code, use FIXME</title>
1708 <para><emphasis>Explanation:</emphasis></para>
1710 <para>If you have enough confidence in new code or confidence in
1711 your changes, but are not *quite* sure of the repercussions,
1714 <para>/* FIXME: this code has a logic error on platform XYZ, *
1715 attempting to fix */ #ifdef PLATFORM ...changed code here...
1720 <para>/* FIXME: I think the original author really meant this...
1721 */ ...changed code here...</para>
1725 <para>/* FIXME: new code that *may* break something else... */
1726 ...new code here...</para>
1728 <para><emphasis>Note:</emphasis> If you make it clear that this may or may not
1729 be a "good thing (tm)", it will be easier to identify and
1730 include in the project (or conversely exclude from the
1738 <sect2 id="s46"><title>Addendum: Template for files and function
1739 comment blocks:</title>
1741 <para><emphasis>Example for file comments:</emphasis></para>
1743 const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.46.2.4 2002/05/29 00:30:59 mal0rd Exp $";
1744 /*********************************************************************
1746 * File : $S<!-- Break CVS Substitution -->ource$
1748 * Purpose : (Fill me in with a good description!)
1750 * Copyright : Written by and Copyright (C) 2001 the SourceForge
1751 * Privoxy team. http://www.privoxy.org/
1753 * Based on the Internet Junkbuster originally written
1754 * by and Copyright (C) 1997 Anonymous Coders and
1755 * Junkbusters Corporation. http://www.junkbusters.com
1757 * This program is free software; you can redistribute it
1758 * and/or modify it under the terms of the GNU General
1759 * Public License as published by the Free Software
1760 * Foundation; either version 2 of the License, or (at
1761 * your option) any later version.
1763 * This program is distributed in the hope that it will
1764 * be useful, but WITHOUT ANY WARRANTY; without even the
1765 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1766 * PARTICULAR PURPOSE. See the GNU General Public
1767 * License for more details.
1769 * The GNU General Public License should be included with
1770 * this file. If not, you can view it at
1771 * http://www.gnu.org/copyleft/gpl.html
1772 * or write to the Free Software Foundation, Inc., 59
1773 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1776 * $L<!-- Break CVS Substitution -->og$
1778 *********************************************************************/
1783 ...necessary include files for us to do our work...
1785 const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
1788 <para><emphasis>Note:</emphasis> This declares the rcs variables that should be
1789 added to the "show-proxy-args" page. If this is a brand new
1790 creation by you, you are free to change the "Copyright" section
1791 to represent the rights you wish to maintain.</para>
1793 <para><emphasis>Note:</emphasis> The formfeed character that is present right
1794 after the comment flower box is handy for (X|GNU)Emacs users to
1795 skip the verbiage and get to the heart of the code (via
1796 `forward-page' and `backward-page'). Please include it if you
1799 <para><emphasis>Example for file header comments:</emphasis></para>
1803 #define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.46.2.4 2002/05/29 00:30:59 mal0rd Exp $"
1804 /*********************************************************************
1806 * File : $S<!-- Break CVS Substitution -->ource$
1808 * Purpose : (Fill me in with a good description!)
1810 * Copyright : Written by and Copyright (C) 2001 the SourceForge
1811 * Privoxy team. http://www.privoxy.org/
1813 * Based on the Internet Junkbuster originally written
1814 * by and Copyright (C) 1997 Anonymous Coders and
1815 * Junkbusters Corporation. http://www.junkbusters.com
1817 * This program is free software; you can redistribute it
1818 * and/or modify it under the terms of the GNU General
1819 * Public License as published by the Free Software
1820 * Foundation; either version 2 of the License, or (at
1821 * your option) any later version.
1823 * This program is distributed in the hope that it will
1824 * be useful, but WITHOUT ANY WARRANTY; without even the
1825 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1826 * PARTICULAR PURPOSE. See the GNU General Public
1827 * License for more details.
1829 * The GNU General Public License should be included with
1830 * this file. If not, you can view it at
1831 * http://www.gnu.org/copyleft/gpl.html
1832 * or write to the Free Software Foundation, Inc., 59
1833 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1836 * $L<!-- Break CVS Substitution -->og$
1838 *********************************************************************/
1841 #include "project.h"
1847 ... function headers here ...
1850 /* Revision control strings from this header and associated .c file */
1851 extern const char FILENAME_rcs[];
1852 extern const char FILENAME_h_rcs[];
1859 #endif /* ndef _FILENAME_H */
1868 <para><emphasis>Example for function comments:</emphasis></para>
1870 /*********************************************************************
1872 * Function : FUNCTION_NAME
1874 * Description : (Fill me in with a good description!)
1877 * 1 : param1 = pointer to an important thing
1878 * 2 : x = pointer to something else
1880 * Returns : 0 => Ok, everything else is an error.
1882 *********************************************************************/
1883 int FUNCTION_NAME( void *param1, const char *x )
1891 <para><emphasis>Note:</emphasis> If we all follow this practice, we should be
1892 able to parse our code to create a "self-documenting" web
1899 <!-- ~~~~~ New section ~~~~~ -->
1900 <sect1 id="testing"><title>Testing Guidelines</title>
1904 <!-- ~~~~~ New section ~~~~~ -->
1905 <sect2 id="testing-plan"><title>Testplan for releases</title>
1907 Explain release numbers. major, minor. developer releases. etc.
1909 <orderedlist numeration="arabic">
1911 Remove any existing rpm with rpm -e
1914 Remove any file that was left over. This includes (but is not limited to)
1916 <listitem><para>/var/log/privoxy</para></listitem>
1917 <listitem><para>/etc/privoxy</para></listitem>
1918 <listitem><para>/usr/sbin/privoxy</para></listitem>
1919 <listitem><para>/etc/init.d/privoxy</para></listitem>
1920 <listitem><para>/usr/doc/privoxy*</para></listitem>
1924 Install the rpm. Any error messages?
1926 <listitem><para>start,stop,status <application>Privoxy</application> with the specific script
1927 (e.g. /etc/rc.d/init/privoxy stop). Reboot your machine. Does
1928 autostart work?</para></listitem>
1929 <listitem><para>Start browsing. Does <application>Privoxy</application> work? Logfile written?</para></listitem>
1930 <listitem><para>Remove the rpm. Any error messages? All files removed?</para></listitem>
1935 <!-- ~~~~~ New section ~~~~~ -->
1936 <sect2 id="testing-report"><title>Test reports</title>
1938 Please submit test reports only with the <ulink url="http://sourceforge.net/tracker/?func=add&group_id=11118&atid=395005">test form</ulink>
1939 at sourceforge. Three simple steps:
1942 <listitem><para>Select category: the distribution you test on.</para></listitem>
1943 <listitem><para>Select group: the version of <application>Privoxy</application> that we are about to release.</para></listitem>
1944 <listitem><para>Fill the Summary and Detailed Description with something
1945 intelligent (keep it short and precise).</para>
1948 Do not mail to the mailing list (we cannot keep track on issues there).
1954 <!-- ~~~~~ New section ~~~~~ -->
1955 <sect1 id="newrelease"><title>Releasing a New Version</title>
1957 When we release versions of <application>Privoxy</application>,
1958 our work leaves our cozy secret lab and has to work in the cold
1959 RealWorld[tm]. Once it is released, there is no way to call it
1960 back, so it is very important that great care is taken to ensure
1961 that everything runs fine, and not to introduce problems in the
1965 So when releasing a new version, please adhere exactly to the
1966 procedure outlined in this chapter.
1970 The following programs are required to follow this process:
1971 <filename>ncftpput</filename> (ncftp), <filename>scp, ssh</filename> (ssh),
1972 <filename>gmake</filename> (GNU's version of make), autoconf, cvs.
1975 <sect2 id="versionnumbers">
1976 <title>Version numbers</title>
1979 First you need to determine which version number the release will have.
1980 <application>Privoxy</application> version numbers consist of three numbers,
1981 separated by dots, like in X.Y.Z, where:
1985 X, the version major, is rarely ever changed. It is increased by one if
1986 turning a development branch into stable substantially changes the functionality,
1987 user interface or configuration syntax. Majors 1 and 2 were
1988 <application>Junkbuster</application>, and 3 will be the first stable
1989 <application>Privoxy</application> release.
1994 Y, the version minor, represents the branch within the major version.
1995 At any point in time, there are two branches being maintained:
1996 The stable branch, with an even minor, say, 2N, in which no functionality is
1997 being added and only bug-fixes are made, and 2N+1, the development branch, in
1998 which the further development of <application>Privoxy</application> takes
2000 This enables us to turn the code upside down and inside out, while at the same time
2001 providing and maintaining a stable version.
2002 The minor is reset to zero (and one) when the major is incremented. When a development
2003 branch has matured to the point where it can be turned into stable, the old stable branch
2004 2N is given up (i.e. no longer maintained), the former development branch 2N+1 becomes the
2005 new stable branch 2N+2, and a new development branch 2N+3 is opened.
2010 Z, the point or sub version, represents a release of the software within a branch.
2011 It is therefore incremented immediately before each code freeze.
2012 In development branches, only the even point versions correspond to actual releases,
2013 while the odd ones denote the evolving state of the sources on CVS in between.
2014 It follows that Z is odd on CVS in development branches most of the time. There, it gets
2015 increased to an even number immediately before a code freeze, and is increased to an odd
2016 number again immediately thereafter.
2017 This ensures that builds from CVS snapshots are easily distinguished from released versions.
2018 The point version is reset to zero when the minor changes.
2026 <sect2 id="beforerelease">
2027 <title>Before the Release: Freeze</title>
2029 The following <emphasis>must be done by one of the
2030 developers</emphasis> prior to each new release.
2036 Make sure that everybody who has worked on the code in the last
2037 couple of days has had a chance to yell <quote>no!</quote> in case
2038 they have pending changes/fixes in their pipelines. Announce the
2039 freeze so that nobody will interfere with last minute changes.
2044 Increment the version number (point from odd to even in development
2045 branches!) in <filename>configure.in</filename>.
2050 If <filename>default.action</filename> has changed since last
2051 release (i.e. software release or standalone actions file release),
2052 bump up its version info to A.B in this line:
2056 {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
2060 Then change the version info in doc/webserver/actions/index.php,
2061 line: '$required_actions_file_version = "A.B";'
2066 If the HTML documentation is not in sync with the SGML sources
2067 you need to regenerate and upload it to the webserver. (If in
2068 doubt, just do it.) See the Section "Updating the webserver" in
2069 this manual for details.
2074 <emphasis>Commit all files that were changed in the above steps!</emphasis>
2079 Tag all files in CVS with the version number with
2080 <quote><command>cvs tag v_X_Y_Z</command></quote>.
2081 Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
2086 If the release was in a development branch, increase the point version
2087 from even to odd (X.Y.(Z+1)) again in <filename>configure.in</filename> and
2093 On the webserver, copy the user manual to a new top-level directory
2094 called <filename>X.Y.Z</filename>. This ensures that help links from the CGI
2095 pages, which have the version as a prefix, will go into the right version of the manual.
2096 If this is a development branch release, also symlink <filename>X.Y.(Z-1)</filename>
2097 to <filename>X.Y.Z</filename> and <filename>X.Y.(Z+1)</filename> to
2098 <filename>.</filename> (i.e. dot).
2105 <sect2 id="therelease">
2106 <title>Building and Releasing the Packages</title>
2108 Now the individual packages can be built and released. Note that for
2109 GPL reasons the first package to be released is always the source tarball.
2113 For <emphasis>all</emphasis> types of packages, including the source tarball,
2114 <emphasis>you must make sure that you build from clean sources by exporting
2115 the right version from CVS into an empty directory:</emphasis>.
2120 mkdir dist # delete or choose different name if it already exists
2122 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
2123 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
2128 <emphasis>Do NOT change</emphasis> a single bit, including, but not limited to
2129 version information after export from CVS. This is to make sure that
2130 all release packages, and with them, all future bug reports, are based
2131 on exactly the same code.
2135 Please find additional instructions for the source tarball and the
2136 individual platform dependent binary packages below. And details
2137 on the Sourceforge release process below that.
2140 <sect3 id="pack-guidelines">
2141 <title>Note on Privoxy Packaging</title>
2143 Please keep these general guidelines in mind when putting together
2144 your package. These apply to <emphasis>all</emphasis> platforms!
2150 <application>Privoxy</application> <emphasis>requires</emphasis>
2151 write access to: all <filename>*.action</filename> files, all
2152 logfiles, and the <filename>trust</filename> file. You will
2153 need to determine the best way to do this for your platform.
2158 Please include up to date documentation. At a bare minimum:
2162 <filename>LICENSE</filename> (top-level directory)
2167 <filename>README</filename> (top-level directory)
2172 <filename>AUTHORS</filename> (top-level directory)
2177 <filename>man page</filename> (top-level directory, Unix-like
2183 <filename>The User Manual</filename> (doc/webserver/user-manual/)
2188 <filename>FAQ</filename> (doc/webserver/faq/)
2192 Also suggested: <filename>Developer Manual</filename>
2193 (doc/webserver/developer-manual) and <filename>ChangeLog</filename>
2194 (top-level directory). <filename>FAQ</filename> and the manuals are
2195 HTML docs. There are also text versions in
2196 <filename>doc/text/</filename> which could conceivably also be
2200 The documentation has been designed such that the manuals are linked
2201 to each other from parallel directories, and should be packaged
2202 that way. <filename>privoxy-index.html</filename> can also be
2203 included and can serve as a focal point for docs and other links of
2204 interest (and possibly renamed to <filename>index.html</filename>).
2205 This should be one level up from the manuals. There is a link also
2206 on this page to an HTMLized version of the man page. To avoid 404 for
2207 this, it is in CVS as
2208 <filename>doc/webserver/man-page/privoxy-man-page.html</filename>,
2209 and should be included along with the manuals. There is also a
2210 css stylesheets that can be included for better presentation:
2211 <filename>p_doc.css</filename>. This should be in the same directory
2212 with <filename>privoxy-index.html</filename>, (i.e. one level up from
2213 the manual directories).
2218 <filename>user.action</filename> is designed for local preferences.
2219 Make sure this does not get overwritten!
2224 Other configuration files should be installed as the new defaults,
2225 but all previously installed configuration files should be preserved
2226 as backups. This is just good manners :-)
2231 Please check platform specific notes in this doc, if you haven't
2232 done <quote>Privoxy</quote> packaging before for other platform
2233 specific issues. Conversely, please add any notes that you know
2234 are important for your platform (or contact one of the doc
2235 maintainers to do this if you can't).
2244 <sect3 id="newrelease-tarball"><title>Source Tarball</title>
2246 First, <emphasis>make sure that you have freshly exported the right
2247 version into an empty directory</emphasis>. (See "Building and releasing
2248 packages" above). Then run:
2253 autoheader && autoconf && ./configure
2265 To upload the package to Sourceforge, simply issue
2273 Go to the displayed URL and release the file publicly on Sourceforge.
2274 For the change log field, use the relevant section of the
2275 <filename>ChangeLog</filename> file.
2279 <sect3 id="newrelease-rpm"><title>SuSE, Conectiva or Red Hat RPM</title>
2281 In following text, replace <replaceable class="parameter">dist</replaceable>
2282 with either <quote>rh</quote> for Red Hat or <quote>suse</quote> for SuSE.
2285 First, <emphasis>make sure that you have freshly exported the right
2286 version into an empty directory</emphasis>. (See "Building and releasing
2290 As the only exception to not changing anything after export from CVS,
2291 now examine the file <filename>privoxy-</filename><replaceable class="parameter">dist</replaceable><filename>.spec</filename>
2292 and make sure that the version information and the RPM release number are
2293 correct. The RPM release numbers for each version start at one. Hence it must
2294 be reset to one if this is the first RPM for
2295 <replaceable class="parameter">dist</replaceable> which is built from version
2297 <ulink url="http://sourceforge.net/project/showfiles.php?group_id=11118">file
2298 list</ulink> if unsure. Else, it must be set to the highest already available RPM
2299 release number for that version plus one.
2307 autoheader && autoconf && ./configure
2315 make <replaceable class="parameter">dist</replaceable>-dist
2319 To upload the package to Sourceforge, simply issue
2323 make <replaceable class="parameter">dist</replaceable>-upload <replaceable class="parameter">rpm_packagerev</replaceable>
2327 where <replaceable class="parameter">rpm_packagerev</replaceable> is the
2328 RPM release number as determined above.
2329 Go to the displayed URL and release the file publicly on Sourceforge.
2330 Use the release notes and change log from the source tarball package.
2334 <sect3 id="newrelease-os2"><title>OS/2</title>
2336 First, <emphasis>make sure that you have freshly exported the right
2337 version into an empty directory</emphasis>. (See "Building and releasing
2338 packages" above). Then get the OS/2 Setup module:
2342 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
2346 You will need a mix of development tools.
2347 The main compilation takes place with IBM Visual Age C++.
2348 Some ancillary work takes place with GNU tools, available from
2349 various sources like hobbes.nmsu.edu.
2350 Specificially, you will need <filename>autoheader</filename>,
2351 <filename>autoconf</filename> and <filename>sh</filename> tools.
2352 The packaging takes place with WarpIN, available from various sources, including
2353 its home page: <ulink url="http://www.xworkplace.org/">xworkplace</ulink>.
2356 Change directory to the <filename>os2setup</filename> directory.
2357 Edit the os2build.cmd file to set the final executable filename.
2362 installExeName='privoxyos2_setup_X.Y.Z.exe'
2366 Next, edit the <filename>IJB.wis</filename> file so the release number matches
2367 in the <filename>PACKAGEID</filename> section:
2371 PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
2375 You're now ready to build. Run:
2383 You will find the WarpIN-installable executable in the
2384 <filename>./files</filename> directory. Upload this anonymously to
2385 <filename>uploads.sourceforge.net/incoming</filename>, create a release
2386 for it, and you're done. Use the release notes and Change Log from the
2387 source tarball package.
2391 <sect3 id="newrelease-solaris"><title>Solaris</title>
2393 Login to Sourceforge's compilefarm via ssh:
2397 ssh cf.sourceforge.net
2401 Choose the right operating system (not the Debian one).
2402 When logged in, <emphasis>make sure that you have freshly exported the right
2403 version into an empty directory</emphasis>. (See "Building and releasing
2404 packages" above). Then run:
2409 autoheader && autoconf && ./configure
2421 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2422 solaris-upload</command> on the Sourceforge machine (no ncftpput). You now have
2423 to manually upload the archive to Sourceforge's ftp server and release
2424 the file publicly. Use the release notes and Change Log from the
2425 source tarball package.
2429 <sect3 id="newrelease-windows"><title>Windows</title>
2431 You should ensure you have the latest version of Cygwin (from
2432 <ulink url="http://www.cygwin.com/">http://www.cygwin.com/</ulink>).
2433 Run the following commands from within a Cygwin bash shell.
2436 First, <emphasis>make sure that you have freshly exported the right
2437 version into an empty directory</emphasis>. (See "Building and releasing
2438 packages" above). Then get the Windows setup module:
2442 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co winsetup
2446 Then you can build the package. This is fully automated, and is
2447 controlled by <filename>winsetup/GNUmakefile</filename>.
2448 All you need to do is:
2457 Now you can manually rename <filename>privoxy_setup.exe</filename> to
2458 <filename>privoxy_setup_X_Y_Z.exe</filename>, and upload it to
2459 SourceForge. When releasing the package on SourceForge, use the release notes
2460 and Change Log from the source tarball package.
2464 <sect3 id="newrelease-debian"><title>Debian</title>
2466 First, <emphasis>make sure that you have freshly exported the
2467 right version into an empty directory</emphasis>. (See
2468 "Building and releasing packages" above). Then add a log
2469 entry to <filename>debian/changelog</filename>, if it is not
2470 already there, for example by running:
2474 debchange -v &p-version;-&p-status;-1 "New upstream version"
2482 dpkg-buildpackage -rfakeroot -us -uc -b
2487 <filename>../privoxy_&p-version;-&p-status;-1_i386.deb</filename>
2488 which can be uploaded. To upload the package to Sourceforge, simply
2498 <sect3 id="newrelease-macosx"><title>Mac OSX</title>
2500 First, <emphasis>make sure that you have freshly exported the right
2501 version into an empty directory</emphasis>. (See "Building and releasing
2502 packages" above). Then get the Mac OSX setup module:
2506 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co osxsetup
2519 This will run <filename>autoheader</filename>, <filename>autoconf</filename> and
2520 <filename>configure</filename> as well as <filename>make</filename>.
2521 Finally, it will copy over the necessary files to the ./osxsetup/files directory
2522 for further processing by <filename>PackageMaker</filename>.
2525 Bring up PackageMaker with the PrivoxyPackage.pmsp definition file, modify the package
2526 name to match the release, and hit the "Create package" button.
2527 If you specify ./Privoxy.pkg as the output package name, you can then create
2528 the distributable zip file with the command:
2532 zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
2536 You can then upload <filename>privoxyosx_setup_x.y.z.zip</filename> anonymously to
2537 <filename>uploads.sourceforge.net/incoming</filename>,
2538 create a release for it, and you're done. Use the release notes
2539 and Change Log from the source tarball package.
2543 <sect3 id="newrelease-freebsd"><title>FreeBSD</title>
2545 Login to Sourceforge's compile-farm via ssh:
2549 ssh cf.sourceforge.net
2553 Choose the right operating system.
2554 When logged in, <emphasis>make sure that you have freshly exported the right
2555 version into an empty directory</emphasis>. (See "Building and releasing
2556 packages" above). Then run:
2561 autoheader && autoconf && ./configure
2573 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2574 freebsd-upload</command> on the Sourceforge machine (no ncftpput). You now have
2575 to manually upload the archive to Sourceforge's ftp server and release
2576 the file publicly. Use the release notes and Change Log from the
2577 source tarball package.
2581 <sect3 id="newrelease-hpux"><title>HP-UX 11</title>
2583 First, <emphasis>make sure that you have freshly exported the right
2584 version into an empty directory</emphasis>. (See "Building and releasing
2585 packages" above). Then run:
2590 autoheader && autoconf && ./configure
2598 <sect3 id="newrelease-amiga"><title>Amiga OS</title>
2600 First, <emphasis>make sure that you have freshly exported the right
2601 version into an empty directory</emphasis>. (See "Building and releasing
2602 packages" above). Then run:
2607 autoheader && autoconf && ./configure
2615 <sect3 id="newrelease-aix"><title>AIX</title>
2617 Login to Sourceforge's compilefarm via ssh:
2621 ssh cf.sourceforge.net
2625 Choose the right operating system.
2626 When logged in, <emphasis>make sure that you have freshly exported the right
2627 version into an empty directory</emphasis>. (See "Building and releasing
2628 packages" above). Then run:
2633 autoheader && autoconf && ./configure
2645 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2646 aix-upload</command> on the Sourceforge machine (no ncftpput). You now have
2647 to manually upload the archive to Sourceforge's ftp server and release
2648 the file publicly. Use the release notes and Change Log from the
2649 source tarball package.
2654 <sect2 id="releasing">
2655 <title>Uploading and Releasing Your Package</title>
2657 After the package is ready, it is time to upload it
2658 to SourceForge, and go through the release steps. The upload
2665 Upload to: <ulink url="ftp://upload.sourceforge.net/incoming">ftp://upload.sourceforge.net/incoming</ulink>
2670 user: <literal>anonymous</literal>
2675 password: <literal>ijbswa-developers@lists.sourceforge.net</literal>
2681 Or use the <command>make</command> targets as described above.
2684 Once this done go to <ulink url="http://sourceforge.net/project/admin/editpackages.php?group_id=11118">http://sourceforge.net/project/admin/editpackages.php?group_id=11118</ulink>,
2685 making sure you are logged in. Find your target platform in the
2686 second column, and click <literal>Add Release</literal>. You will
2687 then need to create a new release for your package, using the format
2688 of <literal>$VERSION ($CODE_STATUS)</literal>, e.g. <emphasis>&p-version;
2692 Now just follow the prompts. Be sure to add any appropriate Release
2693 notes. You should see your freshly uploaded packages in
2694 <quote>Step 2. Add Files To This Release</quote>. Check the
2695 appropriate box(es). Remember at each step to hit the
2696 <quote>Refresh/Submit</quote> buttons! You should now see your
2697 file(s) listed in Step 3. Fill out the forms with the appropriate
2698 information for your platform, being sure to hit <quote>Update</quote>
2699 for each file. If anyone is monitoring your platform, check the
2700 <quote>email</quote> box at the very bottom to notify them of
2701 the new package. This should do it!
2704 If you have made errors, or need to make changes, you can go through
2705 essentially the same steps, but select <literal>Edit Release</literal>,
2706 instead of <literal>Add Release</literal>.
2710 <sect2 id="afterrelease">
2711 <title>After the Release</title>
2713 When all (or: most of the) packages have been uploaded and made available,
2714 send an email to the <ulink url="mailto:ijbswa-announce@lists.sourceforge.net">announce
2715 mailing list</ulink>, Subject: "Version X.Y.Z available for download". Be sure to
2717 <ulink url="http://sourceforge.net/project/showfiles.php?group_id=11118">download
2718 location</ulink>, the release notes and the change log.
2724 <!-- ~~~~~ New section ~~~~~ -->
2725 <sect1 id="webserver-update"><title>Update the Webserver</title>
2727 When updating the webserver, please follow these steps to make
2728 sure that no broken links, inconsistent contents or permission
2729 problems will occur:
2732 If you have changed anything in the documentation source SGML files,
2737 make dok # (or make redhat-dok if make dok doesn't work for you)
2741 That will generate <filename>doc/webserver/user-manual</filename>,
2742 <filename>doc/webserver/developer-manual</filename>,
2743 <filename>doc/webserver/faq</filename> and
2744 <filename>doc/webserver/index.html</filename> automatically.
2747 If you changed the manual page source, generate
2748 <filename>doc/webserver/man-page/privoxy-man-page.html</filename>
2749 by running <quote><command>make man</command></quote>. (This is
2750 a separate target due to dependencies on some obscure perl scripts.
2751 See comments in <filename>GNUmakefile</filename>.)
2754 If you want to add new files to the webserver, create them locally in
2755 the <filename>doc/webserver/*</filename> directory (or
2756 create new directories under <filename>doc/webserver</filename>).
2759 Next, commit any changes from the above steps to CVS. All set? Then do
2767 This will do the upload to <ulink url="http://www.privoxy.org/">the
2768 webserver</ulink> (www.privoxy.org) and ensure all files and directories
2769 there are group writable.
2772 Please do <emphasis>NOT</emphasis> use any other means of transferring
2773 files to the webserver to avoid permission problems.
2777 <!-- ~~~~~ New section ~~~~~ -->
2778 <sect1 id="contact"><title>Contacting the developers, Bug Reporting and Feature Requests</title>
2779 <!-- Include contacting.sgml -->
2781 <!-- end contacting -->
2785 <!-- ~~~~~~~~ New section Header ~~~~~~~~~ -->
2786 <sect1 id="copyright"><title>Privoxy Copyright, License and History</title>
2788 <!-- Include copyright.sgml -->
2792 <!-- ~~~~~ New section ~~~~~ -->
2793 <sect2><title>License</title>
2794 <!-- Include copyright.sgml: -->
2796 <!-- end copyright -->
2798 <!-- ~ End section ~ -->
2800 <!-- ~~~~~ New section ~~~~~ -->
2801 <sect2><title>History</title>
2802 <!-- Include history.sgml -->
2809 <!-- ~~~~~ New section ~~~~~ -->
2810 <sect1 id="seealso"><title>See also</title>
2811 <!-- Include seealso.sgml -->
2819 This program is free software; you can redistribute it
2820 and/or modify it under the terms of the GNU General
2821 Public License as published by the Free Software
2822 Foundation; either version 2 of the License, or (at
2823 your option) any later version.
2825 This program is distributed in the hope that it will
2826 be useful, but WITHOUT ANY WARRANTY; without even the
2827 implied warranty of MERCHANTABILITY or FITNESS FOR A
2828 PARTICULAR PURPOSE. See the GNU General Public
2829 License for more details.
2831 The GNU General Public License should be included with
2832 this file. If not, you can view it at
2833 http://www.gnu.org/copyleft/gpl.html
2834 or write to the Free Software Foundation, Inc., 59
2835 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
2837 $Log: developer-manual.sgml,v $
2838 Revision 1.51 2002/05/29 00:30:59 mal0rd
2839 Fixed a little formatting. Clarified debian section.
2841 Revision 1.50 2002/05/28 04:32:45 hal9
2842 Change hints on bundling index.html to privoxy-index.html
2844 Revision 1.49 2002/05/26 17:04:24 hal9
2845 -Spellcheck, very minor edits, and sync across branches
2847 Revision 1.48 2002/05/26 12:48:31 roro
2848 Add releasing information about Debian.
2850 Revision 1.47 2002/05/26 04:55:11 mal0rd
2851 Added debian-dist and debian-upload targets. Also documented usage.
2853 Revision 1.46 2002/05/22 17:15:00 oes
2856 Revision 1.45 2002/05/19 23:01:54 hal9
2857 Add small section on general packaging guidelines (e.g. actions files must
2860 Revision 1.44 2002/05/15 03:55:17 hal9
2861 Fix ulink -> link, and minor modification to release process section for
2864 Revision 1.43 2002/05/10 01:48:19 hal9
2865 This is mostly proposed copyright/licensing additions and changes. Docs
2866 are still GPL, but licensing and copyright are more visible. Also, copyright
2867 changed in doc header comments (eliminate references to JB except FAQ).
2869 Revision 1.42 2002/05/05 20:26:02 hal9
2870 Sorting out license vs copyright in these docs.
2872 Revision 1.41 2002/05/04 08:44:44 swa
2875 Revision 1.40 2002/05/04 00:43:43 hal9
2876 -Remove TOC/first page kludge with proper stylesheet fix.
2877 -Combined the two very brief sections: Intro and Quickstart.
2879 Revision 1.39 2002/05/02 15:08:25 oes
2880 Added explanation about version numbers and RPM package revisions
2882 Revision 1.38 2002/04/29 02:20:31 hal9
2883 Add info on steps for uploading and the release process on SF.
2885 Revision 1.37 2002/04/26 17:23:29 swa
2886 bookmarks cleaned, changed structure of user manual, screen and programlisting cleanups, and numerous other changes that I forgot
2888 Revision 1.36 2002/04/26 05:25:23 hal9
2889 Mass commit to catch a few scattered fixes.
2891 Revision 1.35 2002/04/17 15:16:15 oes
2892 Added link to docbook crash course
2894 Revision 1.34 2002/04/15 23:39:32 oes
2895 - Extended & fixed the release section
2896 - Added CVS guideline sections
2897 - Separated webserver section from release section
2898 - Commented out boilerplate inclusion (If you don't know yet what it is,
2899 you shouldn't mess with its code ;-)
2902 Revision 1.33 2002/04/12 03:49:53 hal9
2903 Spell checked. Clarification on where docs are kept.
2905 Revision 1.32 2002/04/11 21:29:58 jongfoster
2906 Documenting Win32 release procedure
2908 Revision 1.31 2002/04/11 09:32:52 oes
2911 Revision 1.30 2002/04/11 09:24:53 oes
2914 Revision 1.29 2002/04/10 18:45:14 swa
2917 Revision 1.28 2002/04/08 22:59:26 hal9
2918 Version update. Spell chkconfig correctly :)
2920 Revision 1.27 2002/04/08 15:31:18 hal9
2921 Touch ups to documentation section.
2923 Revision 1.26 2002/04/07 23:50:08 hal9
2924 Documentation changes to reflect HTML docs now in CVS, and new generated files
2927 Revision 1.25 2002/04/06 05:07:28 hal9
2928 -Add privoxy-man-page.sgml, for man page.
2929 -Add authors.sgml for AUTHORS (and p-authors.sgml)
2930 -Reworked various aspects of various docs.
2931 -Added additional comments to sub-docs.
2933 Revision 1.24 2002/04/04 21:33:37 hal9
2934 More on documenting the documents.
2936 Revision 1.23 2002/04/04 18:46:47 swa
2937 consistent look. reuse of copyright, history et. al.
2939 Revision 1.22 2002/04/04 17:27:56 swa
2940 more single file to be included at multiple points. make maintaining easier
2942 Revision 1.21 2002/04/04 06:48:37 hal9
2943 Structural changes to allow for conditional inclusion/exclusion of content
2944 based on entity toggles, e.g. 'entity % p-not-stable "INCLUDE"'. And
2945 definition of internal entities, e.g. 'entity p-version "2.9.13"' that will
2946 eventually be set by Makefile.
2947 More boilerplate text for use across multiple docs.
2949 Revision 1.20 2002/04/04 03:28:27 david__schmidt
2952 Revision 1.19 2002/04/03 15:09:42 david__schmidt
2953 Add OS/2 build section
2955 Revision 1.18 2002/04/03 03:51:48 hal9
2958 Revision 1.17 2002/04/03 01:21:17 hal9
2959 Implementing Andreas's suggestions for Release sections.
2961 Revision 1.16 2002/03/31 23:04:40 hal9
2962 Fleshed out the doc section, and added something for an intro so it was not
2965 Revision 1.15 2002/03/30 22:29:47 swa
2968 Revision 1.14 2002/03/30 19:04:08 swa
2969 people release differently. no good.
2970 I want to make parts of the docs only.
2972 Revision 1.13 2002/03/27 01:16:41 hal9
2975 Revision 1.12 2002/03/27 01:02:51 hal9
2976 Touch up on name change...
2978 Revision 1.11 2002/03/26 22:29:55 swa
2979 we have a new homepage!
2981 Revision 1.10 2002/03/24 12:33:01 swa
2984 Revision 1.9 2002/03/24 11:01:05 swa
2987 Revision 1.8 2002/03/23 15:13:11 swa
2988 renamed every reference to the old name with foobar.
2989 fixed "application foobar application" tag, fixed
2990 "the foobar" with "foobar". left junkbustser in cvs
2991 comments and remarks to history untouched.
2993 Revision 1.7 2002/03/11 13:13:27 swa
2994 correct feedback channels
2996 Revision 1.6 2002/02/24 14:25:06 jongfoster
2997 Formatting changes. Now changing the doctype to DocBook XML 4.1
2998 will work - no other changes are needed.
3000 Revision 1.5 2001/10/31 18:16:51 swa
3001 documentation added: howto generate docs in text and html
3002 format, howto move stuff to the webserver.
3004 Revision 1.4 2001/09/23 10:13:48 swa
3005 upload process established. run make webserver and
3006 the documentation is moved to the webserver. documents
3007 are now linked correctly.
3009 Revision 1.3 2001/09/13 15:27:40 swa
3012 Revision 1.2 2001/09/13 15:20:17 swa
3013 merged standards into developer manual
3015 Revision 1.1 2001/09/12 15:36:41 swa
3016 source files for junkbuster documentation
3018 Revision 1.3 2001/09/10 17:43:59 swa
3019 first proposal of a structure.
3021 Revision 1.2 2001/06/13 14:28:31 swa
3022 docs should have an author.
3024 Revision 1.1 2001/06/13 14:20:37 swa
3025 first import of project's documentation for the webserver.
projects / privoxy.git / blob