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.20">
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.46.2.5 2002/08/09 01:15:12 hal9 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. You have been warned!
34 Failure to abide by this rule will result in the revocation of your license
35 to live a peaceful existence!
36 ========================================================================
42 <title>Privoxy Developer Manual</title>
45 <!-- Completely the wrong markup, but very little is allowed -->
46 <!-- in this part of an article. FIXME -->
47 <link linkend="copyright">Copyright</link> &my-copy; 2001, 2002 by
48 <ulink url="http://www.privoxy.org">Privoxy Developers</ulink>
53 <pubdate>$Id: developer-manual.sgml,v 1.46.2.5 2002/08/09 01:15:12 hal9 Exp $</pubdate>
57 Note: this should generate a separate page, and a live link to it.
58 But it doesn't for some mysterious reason. Please leave commented
59 unless it can be fixed proper. For the time being, the copyright
60 statement will be in copyright.smgl.
64 <legalnotice id="legalnotice">
66 text goes here ........
77 This is here to keep vim syntax file from breaking :/
78 If I knew enough to fix it, I would.
79 PLEASE DO NOT REMOVE! HB: hal@foobox.net
84 The developer manual provides guidance on coding, testing, packaging, documentation
85 and other issues of importance to those involved with
86 <application>Privoxy</application> development. It is mandatory (and helpful!) reading
87 for anyone who wants to join the team.
90 <!-- Include privoxy.sgml boilerplate text: -->
92 <!-- &p-intro; Someone interested enough in the project to contribute
93 will already know at this point what Privoxy is. -->
95 <!-- end boilerplate -->
98 Please note that this document is constantly evolving. This copy represents
99 the state at the release of version &p-version;.
100 You can find the latest version of the this manual at <ulink
101 url="http://www.privoxy.org/developer-manual/">http://www.privoxy.org/developer-manual/</ulink>.
102 Please see <link linkend="contact">the Contact section</link>
103 on how to contact the developers.
106 <!-- Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
113 <!-- ~~~~~ New section ~~~~~ -->
114 <sect1 id="introduction"><title>Introduction</title>
117 I don't like seeing blank space :) So added *something* here.
121 <application>Privoxy</application>, as an heir to
122 <application>Junkbuster</application>, is an Open Source project
123 and licensed under the GPL. As such, <application>Privoxy</application>
124 development is potentially open to anyone who has the time, knowledge,
125 and desire to contribute in any capacity. Our goals are simply to
126 continue the mission, to improve <application>Privoxy</application>, and
127 to make it available to as wide an audience as possible.
130 One does not have to be a programmer to contribute. Packaging, testing,
131 and porting, are all important jobs as well.
134 <!-- ~~~~~ New section ~~~~~ -->
135 <sect2 id="quickstart"><title>Quickstart to Privoxy Development</title>
137 You'll need an account on <ulink
138 url="http://sourceforge.net/">Sourceforge</ulink> to support our
139 development. Mail your ID to <ulink
140 url="mailto:developers@privoxy.org">the list</ulink> and wait until a
141 project manager has added you.
144 For the time being (read, this section is under construction), please
145 refer to the extensive comments in the source code.
150 <!-- ~~~~~ New section ~~~~~ -->
151 <sect1 id="cvs"><title>The CVS Repository</title>
153 If you intend to help us with programming, documentation or packaging
154 you will need write access to our holy grail, the CVS repository.
155 Please read this chapter completely before accessing via CVS.
158 <sect2 id="cvsaccess"><title>Access to CVS</title>
160 The project's CVS repository is hosted on
161 <ulink url="http://sourceforge.net/">SourceForge.</ulink>
162 Please refer to the chapters 6 and 7 in
163 <ulink url="http://sourceforge.net/docman/?group_id=1">SF's site
164 documentation</ulink> for the technical access details for your
165 operating system. For historical reasons, the CVS server is
166 called <literal>cvs.ijbswa.sourceforge.net</literal>, the repository is
167 called <literal>ijbswa</literal>, and the source tree module is called
168 <literal>current</literal>.
172 <sect2 id="cvscommit"><title>CVS Commit Guideline</title>
174 The source tree is the heart of every software project. Every effort must
175 be made to ensure that it is readable, compilable and consistent at all
176 times. We therefore ask anyone with CVS access to strictly adhere to the
177 following guidelines:
180 Never (read: <emphasis>never, ever</emphasis>) be tempted to commit
181 that small change without testing it thoroughly first. When we're
182 close to a public release, ask a fellow developer to review your
186 Your commit message should give a concise overview of <emphasis>what you
187 changed</emphasis> (no big details) and <emphasis>why you changed it</emphasis>
188 Just check previous messages for good examples.
191 Don't use the same message on multiple files, unless it equally applies to
195 If your changes span multiple files, and the code won't recompile unless
196 all changes are committed (e.g. when changing the signature of a function),
197 then commit all files one after another, without long delays in between.
198 If necessary, prepare the commit messages in advance.
201 Before changing things on CVS, make sure that your changes are in line
202 with the team's general consensus on what should be done (see below).
205 Don't commit into the stable branch, unless immediately before a new
206 release. (See <link linkend="versionnumbers">Version Numbers</link> below
207 for details.) Collect your changes on the <ulink
208 url="http://sourceforge.net/tracker/?atid=311118&group_id=11118&func=browse">patches
209 tracker</ulink> instead.
215 <sect2 id="cvswhenask"><title>Discussing Changes First</title>
217 We don't have a too formal policy on this, just use common sense. Hints: If it is..
218 <orderedlist numeration="arabic">
220 ..a bug-fix / clean-up / cosmetic thing: shoot
223 ..a new feature that can be turned off: shoot
226 ..a clear improvement w/o side effects on other parts of the code: shoot
229 ..a matter of taste: <ulink url="mailto:developers@privoxy.org">ask the list</ulink>
232 ..a major redesign of some part of the code: <ulink url="mailto:developers@privoxy.org">ask
238 Note that near a major public release, we get a bit more cautious - if
239 unsure, it doesn't hurt to ask first. There is always the possibility
240 to submit a patch to the <ulink
241 url="http://sourceforge.net/tracker/?atid=311118&group_id=11118&func=browse">patches
242 tracker</ulink> instead.
247 <!-- ~~~~~ New section ~~~~~ -->
248 <sect1 id="documentation"><title>Documentation Guidelines</title>
250 All formal documents are maintained in Docbook SGML and located in the
251 <computeroutput>doc/source/*</computeroutput> directory. You will need
252 <ulink url="http://www.docbook.org">Docbook</ulink>, the Docbook
253 DTD's and the Docbook modular stylesheets (or comparable alternatives),
254 and either <application>jade</application> or
255 <application>openjade</application> (recommended) installed in order to
256 build docs from source. Currently there is <ulink
257 url="../user-manual/index.html"><citetitle>user-manual</citetitle></ulink>,
258 <ulink url="../faq/index.html"><citetitle>FAQ</citetitle></ulink>, and, of
259 course this, the <citetitle>developer-manual</citetitle> in this format.
260 The <citetitle>README</citetitle>, <citetitle>AUTHORS</citetitle>
261 <citetitle>privoxy.1</citetitle> (man page), and
262 <citetitle>config</citetitle> files are also now maintained as Docbook
263 SGML. These files, when built, in the top-level source directory are
264 generated files! Also, the <application>Privoxy</application> <filename>index.html</filename> (and a
265 variation on this file, <filename>privoxy-index.html</filename>,
266 meant for inclusion with doc packages), are maintained as SGML as well.
267 <emphasis>DO NOT edit these directly</emphasis>. Edit the SGML source, or
268 contact someone involved in the documentation (at present Stefan and
272 <filename>config</filename> requires some special handling. The reason it
273 is maintained this way is so that the extensive comments in the file
274 mirror those in <citetitle>user-manual</citetitle>. But the conversion
275 process requires going from SGML to HTML to text to special formatting
276 required for the embedded comments. Some of this does not survive so
277 well. Especially some of the examples that are longer than 80 characters.
278 The build process for this file outputs to <filename>config.new</filename>,
279 which should be reviewed for errors and mis-formatting. Once satisfied
280 that it is correct, then it should be hand copied to
281 <filename>config</filename>.
285 Other, less formal documents (e.g. <filename>LICENSE</filename>,
286 <filename>INSTALL</filename>) are maintained as plain text files in the
287 top-level source directory. At least for the time being.
290 Packagers are encouraged to include this documentation. For those without
291 the ability to build the docs locally, text versions of each are kept in
292 CVS. HTML versions are also now being kept in CVS under
293 <filename>doc/webserver/*</filename>.
296 Formal documents are built with the Makefile targets of
297 <computeroutput>make dok</computeroutput>, or alternately
298 <computeroutput>make redhat-dok</computeroutput>. If you have problems,
299 try both. The build process uses the document SGML sources in
300 <computeroutput>doc/source/*/*</computeroutput> to update all text files in
301 <computeroutput>doc/text/</computeroutput> and to update all HTML
302 documents in <computeroutput>doc/webserver/</computeroutput>.
305 Documentation writers should please make sure documents build
306 successfully before committing to CVS, if possible.
309 How do you update the webserver (i.e. the pages on privoxy.org)?
311 <orderedlist numeration="arabic">
313 First, build the docs by running <computeroutput>make
314 dok</computeroutput> (or alternately <computeroutput>make
315 redhat-dok</computeroutput>).
318 Run <computeroutput>make webserver</computeroutput> which copies all
319 files from <computeroutput>doc/webserver</computeroutput> to the
320 sourceforge webserver via scp.
326 Finished docs should be occasionally submitted to CVS
327 (<filename>doc/webserver/*/*.html</filename>) so that those without
328 the ability to build them locally, have access to them if needed.
329 This is especially important just prior to a new release! Please
330 do this <emphasis>after</emphasis> the <literal>$VERSION</literal> and
331 other release specific data in <filename>configure.in</filename> has been
332 updated (this is done just prior to a new release).
335 <!-- ~~~~~ New section ~~~~~ -->
337 <title>Quickstart to Docbook and SGML</title>
339 If you are not familiar with SGML, it is a markup language similar to HTML.
340 Actually, not a mark up language per se, but a language used to define
341 markup languages. In fact, HTML is an SGML application. Both will use
342 <quote>tags</quote> to format text and other content. SGML tags can be much
343 more varied, and flexible, but do much of the same kinds of things. The tags,
344 or <quote>elements</quote>, are definable in SGML. There is no set
345 <quote>standards</quote>. Since we are using
346 <application>Docbook</application>, our tags are those that are defined by
347 <application>Docbook</application>. Much of how the finish document is
348 rendered is determined by the <quote>stylesheets</quote>.
349 The stylesheets determine how each tag gets translated to HTML, or other
354 Tags in Docbook SGML need to be always <quote>closed</quote>. If not, you
355 will likely generate errors. Example: <literal><title>My
356 Title</title></literal>. They are also case-insensitive, but we
357 strongly suggest using all lower case. This keeps compatibility with
358 [Docbook] <application>XML</application>.
362 Our documents use <quote>sections</quote> for the most part. Sections
363 will be processed into HTML headers (e.g. <literal>h1</literal> for
364 <literal>sect1</literal>). The <application>Docbook</application> stylesheets
365 will use these to also generate the Table of Contents for each doc. Our
366 TOC's are set to a depth of three. Meaning <literal>sect1</literal>,
367 <literal>sect2</literal>, and <literal>sect3</literal> will have TOC
368 entries, but <literal>sect4</literal> will not. Each section requires
369 a <literal><title></literal> element, and at least one
370 <literal><para></literal>. There is a limit of five section
371 levels in Docbook, but generally three should be sufficient for our
376 Some common elements that you likely will use:
382 <emphasis><para></para></emphasis>, paragraph delimiter. Most
383 text needs to be within paragraph elements (there are some exceptions).
386 <emphasis><emphasis></emphasis></emphasis>, the stylesheets
390 <emphasis><filename></filename></emphasis>, files and directories.
393 <emphasis><command></command></emphasis>, command examples.
396 <emphasis><literallayout></literallayout></emphasis>, like
397 <literal><pre></literal>, more or less.
400 <emphasis><itemizedlist></itemizedlist></emphasis>, list with bullets.
403 <emphasis><listitem></listitem></emphasis>, member of the above.
406 <emphasis><screen></screen></emphasis>, screen output, implies
407 <literal><literallayout></literal>.
410 <emphasis><ulink url="example.com"></ulink></emphasis>, like
411 HTML <literal><a></literal> tag.
414 <emphasis><quote></quote></emphasis>, for, doh, quoting text.
420 Look at any of the existing docs for examples of all these and more.
424 You might also find <quote><ulink
425 url="http://www.bureau-cornavin.com/opensource/crash-course/">Writing Documentation
426 Using DocBook - A Crash Course</ulink></quote> useful.
430 <!-- ~~~~~ New section ~~~~~ -->
431 <sect2 id="docstyle">
432 <title><application>Privoxy</application> Documentation Style</title>
434 It will be easier if everyone follows a similar writing style. This
435 just makes it easier to read what someone else has written if it
436 is all done in a similar fashion.
445 All tags should be lower case.
450 Tags delimiting a <emphasis>block</emphasis> of text (even small
451 blocks) should be on their own line. Like:
457 Tags marking individual words, or few words, should be in-line:
459 Just to <emphasis>emphasize</emphasis>, some text goes here.
465 Tags should be nested and step indented for block text like: (except
472 Some text goes here in our list example.
475 </itemizedlist>
478 This makes it easier to find the text amongst the tags ;-)
483 Use white space to separate logical divisions within a document,
484 like between sections. Running everything together consistently
485 makes it harder to read and work on.
490 Do not hesitate to make comments. Comments can either use the
491 <comment> element, or the <!-- --> style comment
492 familiar from HTML. (Note in Docbook v4.x <comment> is
493 replaced by <remark>.)
498 We have an international audience. Refrain from slang, or English
499 idiosyncrasies (too many to list :). Humor also does not translate
505 Try to keep overall line lengths in source files to 80 characters or less
506 for obvious reasons. This is not always possible, with lengthy URLs for
512 Our documents are available in differing formats. Right now, they
513 are just plain text, and HTML, but PDF, and others is always a
514 future possibility. Be careful with URLs (<ulink>), and avoid
518 My favorite site is <ulink url="http://example.com">here</ulink>.
521 This will render as <quote>My favorite site is here</quote>, which is
522 not real helpful in a text doc. Better like this:
525 My favorite site is <ulink url="http://example.com">example.com</ulink>.
530 All documents should be spell checked occasionally.
531 <application>aspell</application> can check SGML with the
532 <literal>-H</literal> option. (<application>ispell</application> I think
543 <!-- ~~~~~ New section ~~~~~ -->
545 <sect2><title>Privoxy Custom Entities</title>
547 <application>Privoxy</application> documentation is using
548 a number of customized <quote>entities</quote> to facilitate
549 documentation maintenance.
552 We are using a set of <quote>boilerplate</quote> files with generic text,
553 that is used by multiple docs. This way we can write something once, and use
554 it repeatedly without having to re-write the same content over and over again.
555 If editing such a file, keep in mind that it should be
556 <emphasis>generic</emphasis>. That is the purpose; so it can be used in varying
557 contexts without additional modifications.
560 We are also using what <application>Docbook</application> calls
561 <quote>internal entities</quote>. These are like variables in
562 programming. Well, sort of. For instance, we have the
563 <literal>p-version</literal> entity that contains the current
564 <application>Privoxy</application> version string. You are strongly
565 encouraged to use these where possible. Some of these obviously
566 require re-setting with each release (done by the Makefile). A sampling of
567 custom entities are listed below. See any of the main docs for examples.
574 Re- <quote>boilerplate</quote> text entities are defined like:
577 <literal><!entity supported SYSTEM "supported.sgml"></literal>
580 In this example, the contents of the file,
581 <filename>supported.sgml</filename> is available for inclusion anywhere
582 in the doc. To make this happen, just reference the now defined
583 entity: <literal>&supported;</literal> (starts with an ampersand
584 and ends with a semi-colon), and the contents will be dumped into
585 the finished doc at that point.
590 Commonly used <quote>internal entities</quote>:
594 <emphasis>p-version</emphasis>: the <application>Privoxy</application>
595 version string, e.g. <quote>&p-version;</quote>.
598 <emphasis>p-status</emphasis>: the project status, either
599 <quote>alpha</quote>, <quote>beta</quote>, or <quote>stable</quote>.
602 <emphasis>p-not-stable</emphasis>: use to conditionally include
603 text in <quote>not stable</quote> releases (e.g. <quote>beta</quote>).
606 <emphasis>p-stable</emphasis>: just the opposite.
609 <emphasis>p-text</emphasis>: this doc is only generated as text.
616 There are others in various places that are defined for a specific
617 purpose. Read the source!
624 <!-- <listitem><para>be consistent with the redirect script (i.e. the <application>Privoxy</application> program -->
625 <!-- points via the redirect URL at sf to valid end-points in the document)</para></listitem> -->
627 <!-- ~~~~~ New section ~~~~~ -->
628 <sect1 id="coding"><title>Coding Guidelines</title>
630 <sect2 id="s1"><title>Introduction</title>
632 <para>This set of standards is designed to make our lives easier. It is
633 developed with the simple goal of helping us keep the "new and improved
634 <application>Privoxy</application>" consistent and reliable. Thus making
635 maintenance easier and increasing chances of success of the
638 <para>And that of course comes back to us as individuals. If we can
639 increase our development and product efficiencies then we can solve more
640 of the request for changes/improvements and in general feel good about
641 ourselves. ;-></para>
645 <sect2 id="s2"><title>Using Comments</title>
648 <sect3 id="s3"><title>Comment, Comment, Comment</title>
650 <para><emphasis>Explanation:</emphasis></para>
652 <para>Comment as much as possible without commenting the obvious.
653 For example do not comment "aVariable is equal to bVariable".
654 Instead explain why aVariable should be equal to the bVariable.
655 Just because a person can read code does not mean they will
656 understand why or what is being done. A reader may spend a lot
657 more time figuring out what is going on when a simple comment
658 or explanation would have prevented the extra research. Please
659 help your brother IJB'ers out!</para>
661 <para>The comments will also help justify the intent of the code.
662 If the comment describes something different than what the code
663 is doing then maybe a programming error is occurring.</para>
665 <para><emphasis>Example:</emphasis></para>
667 /* if page size greater than 1k ... */
668 if ( PageLength() > 1024 )
670 ... "block" the page up ...
673 /* if page size is small, send it in blocks */
674 if ( PageLength() > 1024 )
676 ... "block" the page up ...
679 This demonstrates 2 cases of "what not to do". The first is a
680 "syntax comment". The second is a comment that does not fit what
681 is actually being done.
687 <sect3 id="s4"><title>Use blocks for comments</title>
689 <para><emphasis>Explanation:</emphasis></para>
691 <para>Comments can help or they can clutter. They help when they
692 are differentiated from the code they describe. One line
693 comments do not offer effective separation between the comment
694 and the code. Block identifiers do, by surrounding the code
695 with a clear, definable pattern.</para>
697 <para><emphasis>Example:</emphasis></para>
699 /*********************************************************************
700 * This will stand out clearly in your code!
701 *********************************************************************/
702 if ( thisVariable == thatVariable )
704 DoSomethingVeryImportant();
708 /* unfortunately, this may not */
709 if ( thisVariable == thatVariable )
711 DoSomethingVeryImportant();
715 if ( thisVariable == thatVariable ) /* this may not either */
717 DoSomethingVeryImportant();
720 <para><emphasis>Exception:</emphasis></para>
722 <para>If you are trying to add a small logic comment and do not
723 wish to "disrupt" the flow of the code, feel free to use a 1
724 line comment which is NOT on the same line as the code.</para>
730 <sect3 id="s5"><title>Keep Comments on their own line</title>
732 <para><emphasis>Explanation:</emphasis></para>
734 <para>It goes back to the question of readability. If the comment
735 is on the same line as the code it will be harder to read than
736 the comment that is on its own line.</para>
738 <para>There are three exceptions to this rule, which should be
739 violated freely and often: during the definition of variables,
740 at the end of closing braces, when used to comment
743 <para><emphasis>Example:</emphasis></para>
745 /*********************************************************************
746 * This will stand out clearly in your code,
747 * But the second example won't.
748 *********************************************************************/
749 if ( thisVariable == thatVariable )
751 DoSomethingVeryImportant();
754 if ( thisVariable == thatVariable ) /*can you see me?*/
756 DoSomethingVeryImportant(); /*not easily*/
760 /*********************************************************************
761 * But, the encouraged exceptions:
762 *********************************************************************/
763 int urls_read = 0; /* # of urls read + rejected */
764 int urls_rejected = 0; /* # of urls rejected */
768 DoSomethingVeryImportant();
772 short DoSomethingVeryImportant(
773 short firstparam, /* represents something */
774 short nextparam /* represents something else */ )
778 } /* -END- DoSomethingVeryImportant */
783 <sect3 id="s6"><title>Comment each logical step</title>
785 <para><emphasis>Explanation:</emphasis></para>
787 <para>Logical steps should be commented to help others follow the
788 intent of the written code and comments will make the code more
791 <para>If you have 25 lines of code without a comment, you should
792 probably go back into it to see where you forgot to put
795 <para>Most "for", "while", "do", etc... loops _probably_ need a
796 comment. After all, these are usually major logic
803 <sect3 id="s7"><title>Comment All Functions Thoroughly</title>
805 <para><emphasis>Explanation:</emphasis></para>
807 <para>A reader of the code should be able to look at the comments
808 just prior to the beginning of a function and discern the
809 reason for its existence and the consequences of using it. The
810 reader should not have to read through the code to determine if
811 a given function is safe for a desired use. The proper
812 information thoroughly presented at the introduction of a
813 function not only saves time for subsequent maintenance or
814 debugging, it more importantly aids in code reuse by allowing a
815 user to determine the safety and applicability of any function
816 for the problem at hand. As a result of such benefits, all
817 functions should contain the information presented in the
818 addendum section of this document.</para>
824 <sect3 id="s8"><title>Comment at the end of braces if the
825 content is more than one screen length</title>
827 <para><emphasis>Explanation:</emphasis></para>
829 <para>Each closing brace should be followed on the same line by a
830 comment that describes the origination of the brace if the
831 original brace is off of the screen, or otherwise far away from
832 the closing brace. This will simplify the debugging,
833 maintenance, and readability of the code.</para>
835 <para>As a suggestion , use the following flags to make the
836 comment and its brace more readable:</para>
838 <para>use following a closing brace: } /* -END- if() or while ()
841 <para><emphasis>Example:</emphasis></para>
845 DoSomethingVeryImportant();
846 ...some long list of commands...
847 } /* -END- if x is 1 */
853 DoSomethingVeryImportant();
854 ...some long list of commands...
855 } /* -END- if ( 1 == X ) */
861 <sect2 id="s9"><title>Naming Conventions</title>
865 <sect3 id="s10"><title>Variable Names</title>
867 <para><emphasis>Explanation:</emphasis></para>
869 <para>Use all lowercase, and separate words via an underscore
870 ('_'). Do not start an identifier with an underscore. (ANSI C
871 reserves these for use by the compiler and system headers.) Do
872 not use identifiers which are reserved in ANSI C++. (E.g.
873 template, class, true, false, ...). This is in case we ever
874 decide to port Privoxy to C++.</para>
876 <para><emphasis>Example:</emphasis></para>
878 int ms_iis5_hack = 0;</programlisting>
880 <para><emphasis>Instead of:</emphasis></para>
884 int msiis5hack = 0; int msIis5Hack = 0;
892 <sect3 id="s11"><title>Function Names</title>
894 <para><emphasis>Explanation:</emphasis></para>
896 <para>Use all lowercase, and separate words via an underscore
897 ('_'). Do not start an identifier with an underscore. (ANSI C
898 reserves these for use by the compiler and system headers.) Do
899 not use identifiers which are reserved in ANSI C++. (E.g.
900 template, class, true, false, ...). This is in case we ever
901 decide to port Privoxy to C++.</para>
903 <para><emphasis>Example:</emphasis></para>
905 int load_some_file( struct client_state *csp )</programlisting>
907 <para><emphasis>Instead of:</emphasis></para>
911 int loadsomefile( struct client_state *csp )
912 int loadSomeFile( struct client_state *csp )
920 <sect3 id="s12"><title>Header file prototypes</title>
922 <para><emphasis>Explanation:</emphasis></para>
924 <para>Use a descriptive parameter name in the function prototype
925 in header files. Use the same parameter name in the header file
926 that you use in the c file.</para>
928 <para><emphasis>Example:</emphasis></para>
930 (.h) extern int load_aclfile( struct client_state *csp );
931 (.c) int load_aclfile( struct client_state *csp )</programlisting>
933 <para><emphasis>Instead of:</emphasis>
935 (.h) extern int load_aclfile( struct client_state * ); or
936 (.h) extern int load_aclfile();
937 (.c) int load_aclfile( struct client_state *csp )
945 <sect3 id="s13"><title>Enumerations, and #defines</title>
947 <para><emphasis>Explanation:</emphasis></para>
949 <para>Use all capital letters, with underscores between words. Do
950 not start an identifier with an underscore. (ANSI C reserves
951 these for use by the compiler and system headers.)</para>
953 <para><emphasis>Example:</emphasis></para>
955 (enumeration) : enum Boolean { FALSE, TRUE };
956 (#define) : #define DEFAULT_SIZE 100;</programlisting>
958 <para><emphasis>Note:</emphasis> We have a standard naming scheme for #defines
959 that toggle a feature in the preprocessor: FEATURE_>, where
960 > is a short (preferably 1 or 2 word) description.</para>
962 <para><emphasis>Example:</emphasis></para>
964 #define FEATURE_FORCE 1
967 #define FORCE_PREFIX blah
968 #endif /* def FEATURE_FORCE */
973 <sect3 id="s14"><title>Constants</title>
975 <para><emphasis>Explanation:</emphasis></para>
977 <para>Spell common words out entirely (do not remove vowels).</para>
979 <para>Use only widely-known domain acronyms and abbreviations.
980 Capitalize all letters of an acronym.</para>
982 <para>Use underscore (_) to separate adjacent acronyms and
983 abbreviations. Never terminate a name with an underscore.</para>
985 <para><emphasis>Example:</emphasis></para>
987 #define USE_IMAGE_LIST 1</programlisting>
989 <para><emphasis>Instead of:</emphasis></para>
993 #define USE_IMG_LST 1 or
994 #define _USE_IMAGE_LIST 1 or
995 #define USE_IMAGE_LIST_ 1 or
996 #define use_image_list 1 or
997 #define UseImageList 1
1007 <sect2 id="s15"><title>Using Space</title>
1011 <sect3 id="s16"><title>Put braces on a line by themselves.</title>
1013 <para><emphasis>Explanation:</emphasis></para>
1015 <para>The brace needs to be on a line all by itself, not at the
1016 end of the statement. Curly braces should line up with the
1017 construct that they're associated with. This practice makes it
1018 easier to identify the opening and closing braces for a
1021 <para><emphasis>Example:</emphasis></para>
1028 <para><emphasis>Instead of:</emphasis></para>
1030 <para>if ( this == that ) { ... }</para>
1034 <para>if ( this == that ) { ... }</para>
1036 <para><emphasis>Note:</emphasis> In the special case that the if-statement is
1037 inside a loop, and it is trivial, i.e. it tests for a
1038 condition that is obvious from the purpose of the block,
1039 one-liners as above may optically preserve the loop structure
1040 and make it easier to read.</para>
1042 <para><emphasis>Status:</emphasis> developer-discretion.</para>
1044 <para><emphasis>Example exception:</emphasis></para>
1046 while ( more lines are read )
1048 /* Please document what is/is not a comment line here */
1049 if ( it's a comment ) continue;
1051 do_something( line );
1057 <sect3 id="s17"><title>ALL control statements should have a
1060 <para><emphasis>Explanation:</emphasis></para>
1062 <para>Using braces to make a block will make your code more
1063 readable and less prone to error. All control statements should
1064 have a block defined.</para>
1066 <para><emphasis>Example:</emphasis></para>
1074 <para><emphasis>Instead of:</emphasis></para>
1076 <para>if ( this == that ) DoSomething(); DoSomethingElse();</para>
1080 <para>if ( this == that ) DoSomething();</para>
1082 <para><emphasis>Note:</emphasis> The first example in "Instead of" will execute
1083 in a manner other than that which the developer desired (per
1084 indentation). Using code braces would have prevented this
1085 "feature". The "explanation" and "exception" from the point
1086 above also applies.</para>
1092 <sect3 id="s18"><title>Do not belabor/blow-up boolean
1095 <para><emphasis>Example:</emphasis></para>
1097 structure->flag = ( condition );</programlisting>
1099 <para><emphasis>Instead of:</emphasis></para>
1101 <para>if ( condition ) { structure->flag = 1; } else {
1102 structure->flag = 0; }</para>
1104 <para><emphasis>Note:</emphasis> The former is readable and concise. The later
1105 is wordy and inefficient. Please assume that any developer new
1106 to the project has at least a "good" knowledge of C/C++. (Hope
1107 I do not offend by that last comment ... 8-)</para>
1113 <sect3 id="s19"><title>Use white space freely because it is
1116 <para><emphasis>Explanation:</emphasis></para>
1118 <para>Make it readable. The notable exception to using white space
1119 freely is listed in the next guideline.</para>
1121 <para><emphasis>Example:</emphasis></para>
1125 int anotherValue = 0;
1126 int thisVariable = 0;
1128 if ( thisVariable == thatVariable )
1130 firstValue = oldValue + ( ( someValue - anotherValue ) - whatever )
1135 <sect3 id="s20"><title>Don't use white space around structure
1138 <para><emphasis>Explanation:</emphasis></para>
1140 <para>- structure pointer operator ( "->" ) - member operator (
1141 "." ) - functions and parentheses</para>
1143 <para>It is a general coding practice to put pointers, references,
1144 and function parentheses next to names. With spaces, the
1145 connection between the object and variable/function name is not
1148 <para><emphasis>Example:</emphasis></para>
1152 FunctionName();</programlisting>
1154 <para><emphasis>Instead of:</emphasis> aStruct -> aMember; aStruct . aMember;
1155 FunctionName ();</para>
1161 <sect3 id="s21"><title>Make the last brace of a function stand
1164 <para><emphasis>Example:</emphasis></para>
1166 int function1( ... )
1171 } /* -END- function1 */
1174 int function2( ... )
1176 } /* -END- function2 */
1179 <para><emphasis>Instead of:</emphasis></para>
1181 <para>int function1( ... ) { ...code... return( retCode ); } int
1182 function2( ... ) { }</para>
1184 <para><emphasis>Note:</emphasis> Use 1 blank line before the closing brace and 2
1185 lines afterward. This makes the end of function standout to
1186 the most casual viewer. Although function comments help
1187 separate functions, this is still a good coding practice. In
1188 fact, I follow these rules when using blocks in "for", "while",
1189 "do" loops, and long if {} statements too. After all whitespace
1192 <para><emphasis>Status:</emphasis> developer-discretion on the number of blank
1193 lines. Enforced is the end of function comments.</para>
1199 <sect3 id="s22"><title>Use 3 character indentions</title>
1201 <para><emphasis>Explanation:</emphasis></para>
1203 <para>If some use 8 character TABs and some use 3 character TABs,
1204 the code can look *very* ragged. So use 3 character indentions
1205 only. If you like to use TABs, pass your code through a filter
1206 such as "expand -t3" before checking in your code.</para>
1208 <para><emphasis>Example:</emphasis></para>
1210 static const char * const url_code_map[256] =
1216 int function1( ... )
1220 return( ALWAYS_TRUE );
1224 return( HOW_DID_YOU_GET_HERE );
1227 return( NEVER_GETS_HERE );
1236 <sect2 id="s23"><title>Initializing</title>
1240 <sect3 id="s24"><title>Initialize all variables</title>
1242 <para><emphasis>Explanation:</emphasis></para>
1244 <para>Do not assume that the variables declared will not be used
1245 until after they have been assigned a value somewhere else in
1246 the code. Remove the chance of accidentally using an unassigned
1249 <para><emphasis>Example:</emphasis></para>
1253 struct *ptr = NULL;</programlisting>
1255 <para><emphasis>Note:</emphasis> It is much easier to debug a SIGSEGV if the
1256 message says you are trying to access memory address 00000000
1257 and not 129FA012; or arrayPtr[20] causes a SIGSEV vs.
1260 <para><emphasis>Status:</emphasis> developer-discretion if and only if the
1261 variable is assigned a value "shortly after" declaration.</para>
1267 <sect2 id="s25"><title>Functions</title>
1271 <sect3 id="s26"><title>Name functions that return a boolean as a
1274 <para><emphasis>Explanation:</emphasis></para>
1276 <para>Value should be phrased as a question that would logically
1277 be answered as a true or false statement</para>
1279 <para><emphasis>Example:</emphasis></para>
1281 ShouldWeBlockThis();
1288 <sect3 id="s27"><title>Always specify a return type for a
1291 <para><emphasis>Explanation:</emphasis></para>
1293 <para>The default return for a function is an int. To avoid
1294 ambiguity, create a return for a function when the return has a
1295 purpose, and create a void return type if the function does not
1296 need to return anything.</para>
1302 <sect3 id="s28"><title>Minimize function calls when iterating by
1303 using variables</title>
1305 <para><emphasis>Explanation:</emphasis></para>
1307 <para>It is easy to write the following code, and a clear argument
1308 can be made that the code is easy to understand:</para>
1310 <para><emphasis>Example:</emphasis></para>
1312 for ( size_t cnt = 0; cnt < blockListLength(); cnt ++ )
1317 <para><emphasis>Note:</emphasis> Unfortunately, this makes a function call for
1318 each and every iteration. This increases the overhead in the
1319 program, because the compiler has to look up the function each
1320 time, call it, and return a value. Depending on what occurs in
1321 the blockListLength() call, it might even be creating and
1322 destroying structures with each iteration, even though in each
1323 case it is comparing "cnt" to the same value, over and over.
1324 Remember too - even a call to blockListLength() is a function
1325 call, with the same overhead.</para>
1327 <para>Instead of using a function call during the iterations,
1328 assign the value to a variable, and evaluate using the
1331 <para><emphasis>Example:</emphasis></para>
1333 size_t len = blockListLength();
1335 for ( size_t cnt = 0; cnt < len; cnt ++ )
1340 <para><emphasis>Exceptions:</emphasis> if the value of blockListLength() *may*
1341 change or could *potentially* change, then you must code the
1342 function call in the for/while loop.</para>
1348 <sect3 id="s29"><title>Pass and Return by Const Reference</title>
1350 <para><emphasis>Explanation:</emphasis></para>
1352 <para>This allows a developer to define a const pointer and call
1353 your function. If your function does not have the const
1354 keyword, we may not be able to use your function. Consider
1355 strcmp, if it were defined as: extern int strcmp( char *s1,
1358 <para>I could then not use it to compare argv's in main: int main(
1359 int argc, const char *argv[] ) { strcmp( argv[0], "privoxy"
1362 <para>Both these pointers are *const*! If the c runtime library
1363 maintainers do it, we should too.</para>
1369 <sect3 id="s30"><title>Pass and Return by Value</title>
1371 <para><emphasis>Explanation:</emphasis></para>
1373 <para>Most structures cannot fit onto a normal stack entry (i.e.
1374 they are not 4 bytes or less). Aka, a function declaration
1375 like: int load_aclfile( struct client_state csp )</para>
1377 <para>would not work. So, to be consistent, we should declare all
1378 prototypes with "pass by value": int load_aclfile( struct
1379 client_state *csp )</para>
1385 <sect3 id="s31"><title>Names of include files</title>
1387 <para><emphasis>Explanation:</emphasis></para>
1389 <para>Your include statements should contain the file name without
1390 a path. The path should be listed in the Makefile, using -I as
1391 processor directive to search the indicated paths. An exception
1392 to this would be for some proprietary software that utilizes a
1393 partial path to distinguish their header files from system or
1394 other header files.</para>
1396 <para><emphasis>Example:</emphasis></para>
1398 #include <iostream.h> /* This is not a local include */
1399 #include "config.h" /* This IS a local include */
1402 <para><emphasis>Exception:</emphasis></para>
1406 /* This is not a local include, but requires a path element. */
1407 #include <sys/fileName.h>
1411 <para><emphasis>Note:</emphasis> Please! do not add "-I." to the Makefile
1412 without a _very_ good reason. This duplicates the #include
1413 "file.h" behavior.</para>
1419 <sect3 id="s32"><title>Provide multiple inclusion
1422 <para><emphasis>Explanation:</emphasis></para>
1424 <para>Prevents compiler and linker errors resulting from
1425 redefinition of items.</para>
1427 <para>Wrap each header file with the following syntax to prevent
1428 multiple inclusions of the file. Of course, replace PROJECT_H
1429 with your file name, with "." Changed to "_", and make it
1432 <para><emphasis>Example:</emphasis></para>
1434 #ifndef PROJECT_H_INCLUDED
1435 #define PROJECT_H_INCLUDED
1437 #endif /* ndef PROJECT_H_INCLUDED */
1442 <sect3 id="s33"><title>Use `extern "C"` when appropriate</title>
1444 <para><emphasis>Explanation:</emphasis></para>
1446 <para>If our headers are included from C++, they must declare our
1447 functions as `extern "C"`. This has no cost in C, but increases
1448 the potential re-usability of our code.</para>
1450 <para><emphasis>Example:</emphasis></para>
1455 #endif /* def __cplusplus */
1457 ... function definitions here ...
1461 #endif /* def __cplusplus */
1466 <sect3 id="s34"><title>Where Possible, Use Forward Struct
1467 Declaration Instead of Includes</title>
1469 <para><emphasis>Explanation:</emphasis></para>
1471 <para>Useful in headers that include pointers to other struct's.
1472 Modifications to excess header files may cause needless
1475 <para><emphasis>Example:</emphasis></para>
1477 /*********************************************************************
1478 * We're avoiding an include statement here!
1479 *********************************************************************/
1481 extern file_list *xyz;</programlisting>
1483 <para><emphasis>Note:</emphasis> If you declare "file_list xyz;" (without the
1484 pointer), then including the proper header file is necessary.
1485 If you only want to prototype a pointer, however, the header
1486 file is unnecessary.</para>
1488 <para><emphasis>Status:</emphasis> Use with discretion.</para>
1494 <sect2 id="s35"><title>General Coding Practices</title>
1498 <sect3 id="s36"><title>Turn on warnings</title>
1500 <para><emphasis>Explanation</emphasis></para>
1502 <para>Compiler warnings are meant to help you find bugs. You
1503 should turn on as many as possible. With GCC, the switch is
1504 "-Wall". Try and fix as many warnings as possible.</para>
1510 <sect3 id="s37"><title>Provide a default case for all switch
1513 <para><emphasis>Explanation:</emphasis></para>
1515 <para>What you think is guaranteed is never really guaranteed. The
1516 value that you don't think you need to check is the one that
1517 someday will be passed. So, to protect yourself from the
1518 unknown, always have a default step in a switch statement.</para>
1520 <para><emphasis>Example:</emphasis></para>
1522 switch( hash_string( cmd ) )
1524 case hash_actions_file :
1534 ... anomaly code goes here ...
1535 continue; / break; / exit( 1 ); / etc ...
1537 } /* end switch( hash_string( cmd ) ) */</programlisting>
1539 <para><emphasis>Note:</emphasis> If you already have a default condition, you
1540 are obviously exempt from this point. Of note, most of the
1541 WIN32 code calls `DefWindowProc' after the switch statement.
1542 This API call *should* be included in a default statement.</para>
1544 <para><emphasis>Another Note:</emphasis> This is not so much a readability issue
1545 as a robust programming issue. The "anomaly code goes here" may
1546 be no more than a print to the STDERR stream (as in
1547 load_config). Or it may really be an ABEND condition.</para>
1549 <para><emphasis>Status:</emphasis> Programmer discretion is advised.</para>
1555 <sect3 id="s38"><title>Try to avoid falling through cases in a
1556 switch statement.</title>
1558 <para><emphasis>Explanation:</emphasis></para>
1560 <para>In general, you will want to have a 'break' statement within
1561 each 'case' of a switch statement. This allows for the code to
1562 be more readable and understandable, and furthermore can
1563 prevent unwanted surprises if someone else later gets creative
1564 and moves the code around.</para>
1566 <para>The language allows you to plan the fall through from one
1567 case statement to another simply by omitting the break
1568 statement within the case statement. This feature does have
1569 benefits, but should only be used in rare cases. In general,
1570 use a break statement for each case statement.</para>
1572 <para>If you choose to allow fall through, you should comment both
1573 the fact of the fall through and reason why you felt it was
1580 <sect3 id="s39"><title>Use 'long' or 'short' Instead of
1583 <para><emphasis>Explanation:</emphasis></para>
1585 <para>On 32-bit platforms, int usually has the range of long. On
1586 16-bit platforms, int has the range of short.</para>
1588 <para><emphasis>Status:</emphasis> open-to-debate. In the case of most FSF
1589 projects (including X/GNU-Emacs), there are typedefs to int4,
1590 int8, int16, (or equivalence ... I forget the exact typedefs
1591 now). Should we add these to IJB now that we have a "configure"
1598 <sect3 id="s40"><title>Don't mix size_t and other types</title>
1600 <para><emphasis>Explanation:</emphasis></para>
1602 <para>The type of size_t varies across platforms. Do not make
1603 assumptions about whether it is signed or unsigned, or about
1604 how long it is. Do not compare a size_t against another
1605 variable of a different type (or even against a constant)
1606 without casting one of the values. Try to avoid using size_t if
1613 <sect3 id="s41"><title>Declare each variable and struct on its
1616 <para><emphasis>Explanation:</emphasis></para>
1618 <para>It can be tempting to declare a series of variables all on
1619 one line. Don't.</para>
1621 <para><emphasis>Example:</emphasis></para>
1625 long c = 0;</programlisting>
1627 <para><emphasis>Instead of:</emphasis></para>
1629 <para>long a, b, c;</para>
1631 <para><emphasis>Explanation:</emphasis> - there is more room for comments on the
1632 individual variables - easier to add new variables without
1633 messing up the original ones - when searching on a variable to
1634 find its type, there is less clutter to "visually"
1637 <para><emphasis>Exceptions:</emphasis> when you want to declare a bunch of loop
1638 variables or other trivial variables; feel free to declare them
1639 on 1 line. You should, although, provide a good comment on
1640 their functions.</para>
1642 <para><emphasis>Status:</emphasis> developer-discretion.</para>
1648 <sect3 id="s42"><title>Use malloc/zalloc sparingly</title>
1650 <para><emphasis>Explanation:</emphasis></para>
1652 <para>Create a local struct (on the stack) if the variable will
1653 live and die within the context of one function call.</para>
1655 <para>Only "malloc" a struct (on the heap) if the variable's life
1656 will extend beyond the context of one function call.</para>
1658 <para><emphasis>Example:</emphasis></para>
1660 If a function creates a struct and stores a pointer to it in a
1661 list, then it should definitely be allocated via `malloc'.
1666 <sect3 id="s43"><title>The Programmer Who Uses 'malloc' is
1667 Responsible for Ensuring 'free'</title>
1669 <para><emphasis>Explanation:</emphasis></para>
1671 <para>If you have to "malloc" an instance, you are responsible for
1672 insuring that the instance is `free'd, even if the deallocation
1673 event falls within some other programmer's code. You are also
1674 responsible for ensuring that deletion is timely (i.e. not too
1675 soon, not too late). This is known as "low-coupling" and is a
1676 "good thing (tm)". You may need to offer a
1677 free/unload/destructor type function to accommodate this.</para>
1679 <para><emphasis>Example:</emphasis></para>
1681 int load_re_filterfile( struct client_state *csp ) { ... }
1682 static void unload_re_filterfile( void *f ) { ... }</programlisting>
1684 <para><emphasis>Exceptions:</emphasis></para>
1686 <para>The developer cannot be expected to provide `free'ing
1687 functions for C run-time library functions ... such as
1690 <para><emphasis>Status:</emphasis> developer-discretion. The "main" use of this
1691 standard is for allocating and freeing data structures (complex
1698 <sect3 id="s44"><title>Add loaders to the `file_list' structure
1699 and in order</title>
1701 <para><emphasis>Explanation:</emphasis></para>
1703 <para>I have ordered all of the "blocker" file code to be in alpha
1704 order. It is easier to add/read new blockers when you expect a
1705 certain order.</para>
1707 <para><emphasis>Note:</emphasis> It may appear that the alpha order is broken in
1708 places by POPUP tests coming before PCRS tests. But since
1709 POPUPs can also be referred to as KILLPOPUPs, it is clear that
1710 it should come first.</para>
1716 <sect3 id="s45"><title>"Uncertain" new code and/or changes to
1717 existing code, use FIXME</title>
1719 <para><emphasis>Explanation:</emphasis></para>
1721 <para>If you have enough confidence in new code or confidence in
1722 your changes, but are not *quite* sure of the repercussions,
1725 <para>/* FIXME: this code has a logic error on platform XYZ, *
1726 attempting to fix */ #ifdef PLATFORM ...changed code here...
1731 <para>/* FIXME: I think the original author really meant this...
1732 */ ...changed code here...</para>
1736 <para>/* FIXME: new code that *may* break something else... */
1737 ...new code here...</para>
1739 <para><emphasis>Note:</emphasis> If you make it clear that this may or may not
1740 be a "good thing (tm)", it will be easier to identify and
1741 include in the project (or conversely exclude from the
1749 <sect2 id="s46"><title>Addendum: Template for files and function
1750 comment blocks:</title>
1752 <para><emphasis>Example for file comments:</emphasis></para>
1754 const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.46.2.5 2002/08/09 01:15:12 hal9 Exp $";
1755 /*********************************************************************
1757 * File : $S<!-- Break CVS Substitution -->ource$
1759 * Purpose : (Fill me in with a good description!)
1761 * Copyright : Written by and Copyright (C) 2001 the SourceForge
1762 * Privoxy team. http://www.privoxy.org/
1764 * Based on the Internet Junkbuster originally written
1765 * by and Copyright (C) 1997 Anonymous Coders and
1766 * Junkbusters Corporation. http://www.junkbusters.com
1768 * This program is free software; you can redistribute it
1769 * and/or modify it under the terms of the GNU General
1770 * Public License as published by the Free Software
1771 * Foundation; either version 2 of the License, or (at
1772 * your option) any later version.
1774 * This program is distributed in the hope that it will
1775 * be useful, but WITHOUT ANY WARRANTY; without even the
1776 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1777 * PARTICULAR PURPOSE. See the GNU General Public
1778 * License for more details.
1780 * The GNU General Public License should be included with
1781 * this file. If not, you can view it at
1782 * http://www.gnu.org/copyleft/gpl.html
1783 * or write to the Free Software Foundation, Inc., 59
1784 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1787 * $L<!-- Break CVS Substitution -->og$
1789 *********************************************************************/
1794 ...necessary include files for us to do our work...
1796 const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
1799 <para><emphasis>Note:</emphasis> This declares the rcs variables that should be
1800 added to the "show-proxy-args" page. If this is a brand new
1801 creation by you, you are free to change the "Copyright" section
1802 to represent the rights you wish to maintain.</para>
1804 <para><emphasis>Note:</emphasis> The formfeed character that is present right
1805 after the comment flower box is handy for (X|GNU)Emacs users to
1806 skip the verbiage and get to the heart of the code (via
1807 `forward-page' and `backward-page'). Please include it if you
1810 <para><emphasis>Example for file header comments:</emphasis></para>
1814 #define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.46.2.5 2002/08/09 01:15:12 hal9 Exp $"
1815 /*********************************************************************
1817 * File : $S<!-- Break CVS Substitution -->ource$
1819 * Purpose : (Fill me in with a good description!)
1821 * Copyright : Written by and Copyright (C) 2001 the SourceForge
1822 * Privoxy team. http://www.privoxy.org/
1824 * Based on the Internet Junkbuster originally written
1825 * by and Copyright (C) 1997 Anonymous Coders and
1826 * Junkbusters Corporation. http://www.junkbusters.com
1828 * This program is free software; you can redistribute it
1829 * and/or modify it under the terms of the GNU General
1830 * Public License as published by the Free Software
1831 * Foundation; either version 2 of the License, or (at
1832 * your option) any later version.
1834 * This program is distributed in the hope that it will
1835 * be useful, but WITHOUT ANY WARRANTY; without even the
1836 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1837 * PARTICULAR PURPOSE. See the GNU General Public
1838 * License for more details.
1840 * The GNU General Public License should be included with
1841 * this file. If not, you can view it at
1842 * http://www.gnu.org/copyleft/gpl.html
1843 * or write to the Free Software Foundation, Inc., 59
1844 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1847 * $L<!-- Break CVS Substitution -->og$
1849 *********************************************************************/
1852 #include "project.h"
1858 ... function headers here ...
1861 /* Revision control strings from this header and associated .c file */
1862 extern const char FILENAME_rcs[];
1863 extern const char FILENAME_h_rcs[];
1870 #endif /* ndef _FILENAME_H */
1879 <para><emphasis>Example for function comments:</emphasis></para>
1881 /*********************************************************************
1883 * Function : FUNCTION_NAME
1885 * Description : (Fill me in with a good description!)
1888 * 1 : param1 = pointer to an important thing
1889 * 2 : x = pointer to something else
1891 * Returns : 0 => Ok, everything else is an error.
1893 *********************************************************************/
1894 int FUNCTION_NAME( void *param1, const char *x )
1902 <para><emphasis>Note:</emphasis> If we all follow this practice, we should be
1903 able to parse our code to create a "self-documenting" web
1910 <!-- ~~~~~ New section ~~~~~ -->
1911 <sect1 id="testing"><title>Testing Guidelines</title>
1915 <!-- ~~~~~ New section ~~~~~ -->
1916 <sect2 id="testing-plan"><title>Testplan for releases</title>
1918 Explain release numbers. major, minor. developer releases. etc.
1920 <orderedlist numeration="arabic">
1922 Remove any existing rpm with rpm -e
1925 Remove any file that was left over. This includes (but is not limited to)
1927 <listitem><para>/var/log/privoxy</para></listitem>
1928 <listitem><para>/etc/privoxy</para></listitem>
1929 <listitem><para>/usr/sbin/privoxy</para></listitem>
1930 <listitem><para>/etc/init.d/privoxy</para></listitem>
1931 <listitem><para>/usr/doc/privoxy*</para></listitem>
1935 Install the rpm. Any error messages?
1937 <listitem><para>start,stop,status <application>Privoxy</application> with the specific script
1938 (e.g. /etc/rc.d/init/privoxy stop). Reboot your machine. Does
1939 autostart work?</para></listitem>
1940 <listitem><para>Start browsing. Does <application>Privoxy</application> work? Logfile written?</para></listitem>
1941 <listitem><para>Remove the rpm. Any error messages? All files removed?</para></listitem>
1946 <!-- ~~~~~ New section ~~~~~ -->
1947 <sect2 id="testing-report"><title>Test reports</title>
1949 Please submit test reports only with the <ulink url="http://sourceforge.net/tracker/?func=add&group_id=11118&atid=395005">test form</ulink>
1950 at sourceforge. Three simple steps:
1953 <listitem><para>Select category: the distribution you test on.</para></listitem>
1954 <listitem><para>Select group: the version of <application>Privoxy</application> that we are about to release.</para></listitem>
1955 <listitem><para>Fill the Summary and Detailed Description with something
1956 intelligent (keep it short and precise).</para>
1959 Do not mail to the mailing list (we cannot keep track on issues there).
1965 <!-- ~~~~~ New section ~~~~~ -->
1966 <sect1 id="newrelease"><title>Releasing a New Version</title>
1968 When we release versions of <application>Privoxy</application>,
1969 our work leaves our cozy secret lab and has to work in the cold
1970 RealWorld[tm]. Once it is released, there is no way to call it
1971 back, so it is very important that great care is taken to ensure
1972 that everything runs fine, and not to introduce problems in the
1976 So when releasing a new version, please adhere exactly to the
1977 procedure outlined in this chapter.
1981 The following programs are required to follow this process:
1982 <filename>ncftpput</filename> (ncftp), <filename>scp, ssh</filename> (ssh),
1983 <filename>gmake</filename> (GNU's version of make), autoconf, cvs.
1986 <sect2 id="versionnumbers">
1987 <title>Version numbers</title>
1990 First you need to determine which version number the release will have.
1991 <application>Privoxy</application> version numbers consist of three numbers,
1992 separated by dots, like in X.Y.Z, where:
1996 X, the version major, is rarely ever changed. It is increased by one if
1997 turning a development branch into stable substantially changes the functionality,
1998 user interface or configuration syntax. Majors 1 and 2 were
1999 <application>Junkbuster</application>, and 3 will be the first stable
2000 <application>Privoxy</application> release.
2005 Y, the version minor, represents the branch within the major version.
2006 At any point in time, there are two branches being maintained:
2007 The stable branch, with an even minor, say, 2N, in which no functionality is
2008 being added and only bug-fixes are made, and 2N+1, the development branch, in
2009 which the further development of <application>Privoxy</application> takes
2011 This enables us to turn the code upside down and inside out, while at the same time
2012 providing and maintaining a stable version.
2013 The minor is reset to zero (and one) when the major is incremented. When a development
2014 branch has matured to the point where it can be turned into stable, the old stable branch
2015 2N is given up (i.e. no longer maintained), the former development branch 2N+1 becomes the
2016 new stable branch 2N+2, and a new development branch 2N+3 is opened.
2021 Z, the point or sub version, represents a release of the software within a branch.
2022 It is therefore incremented immediately before each code freeze.
2023 In development branches, only the even point versions correspond to actual releases,
2024 while the odd ones denote the evolving state of the sources on CVS in between.
2025 It follows that Z is odd on CVS in development branches most of the time. There, it gets
2026 increased to an even number immediately before a code freeze, and is increased to an odd
2027 number again immediately thereafter.
2028 This ensures that builds from CVS snapshots are easily distinguished from released versions.
2029 The point version is reset to zero when the minor changes.
2037 <sect2 id="beforerelease">
2038 <title>Before the Release: Freeze</title>
2040 The following <emphasis>must be done by one of the
2041 developers</emphasis> prior to each new release.
2047 Make sure that everybody who has worked on the code in the last
2048 couple of days has had a chance to yell <quote>no!</quote> in case
2049 they have pending changes/fixes in their pipelines. Announce the
2050 freeze so that nobody will interfere with last minute changes.
2055 Increment the version number (point from odd to even in development
2056 branches!) in <filename>configure.in</filename>. (RPM spec files
2057 will need to be incremented as well.)
2062 If <filename>default.action</filename> has changed since last
2063 release (i.e. software release or standalone actions file release),
2064 bump up its version info to A.B in this line:
2068 {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
2072 Then change the version info in doc/webserver/actions/index.php,
2073 line: '$required_actions_file_version = "A.B";'
2078 All documentation should be rebuild after the version bump.
2079 Finished docs should be then be committed to CVS (for those
2080 without the ability to build these). Some docs may require
2081 rather obscure processing tools. <filename>config</filename>,
2082 the man page (and the html version of the man page), and the PDF docs
2083 fall in this category. REAMDE, the man page, AUTHORS, and config
2084 should all also be committed to CVS for other packageers. The
2085 formal docs should be uploaded to the webserver. See the
2086 Section "Updating the webserver" in this manual for details.
2091 All developers should look at the <filename>ChangeLog</filename> and
2092 make sure noteworthy changes are referenced.
2097 <emphasis>Commit all files that were changed in the above steps!</emphasis>
2102 Tag all files in CVS with the version number with
2103 <quote><command>cvs tag v_X_Y_Z</command></quote>.
2104 Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
2109 If the release was in a development branch, increase the point version
2110 from even to odd (X.Y.(Z+1)) again in <filename>configure.in</filename> and
2116 On the webserver, copy the user manual to a new top-level directory
2117 called <filename>X.Y.Z</filename>. This ensures that help links from the CGI
2118 pages, which have the version as a prefix, will go into the right version of the manual.
2119 If this is a development branch release, also symlink <filename>X.Y.(Z-1)</filename>
2120 to <filename>X.Y.Z</filename> and <filename>X.Y.(Z+1)</filename> to
2121 <filename>.</filename> (i.e. dot).
2128 <sect2 id="therelease">
2129 <title>Building and Releasing the Packages</title>
2131 Now the individual packages can be built and released. Note that for
2132 GPL reasons the first package to be released is always the source tarball.
2136 For <emphasis>all</emphasis> types of packages, including the source tarball,
2137 <emphasis>you must make sure that you build from clean sources by exporting
2138 the right version from CVS into an empty directory</emphasis> (just press return when
2139 asked for a password):
2144 mkdir dist # delete or choose different name if it already exists
2146 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
2147 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
2152 <emphasis>Do NOT change</emphasis> a single bit, including, but not limited to
2153 version information after export from CVS. This is to make sure that
2154 all release packages, and with them, all future bug reports, are based
2155 on exactly the same code.
2159 Please find additional instructions for the source tarball and the
2160 individual platform dependent binary packages below. And details
2161 on the Sourceforge release process below that.
2164 <sect3 id="pack-guidelines">
2165 <title>Note on Privoxy Packaging</title>
2167 Please keep these general guidelines in mind when putting together
2168 your package. These apply to <emphasis>all</emphasis> platforms!
2174 <application>Privoxy</application> <emphasis>requires</emphasis>
2175 write access to: all <filename>*.action</filename> files, all
2176 logfiles, and the <filename>trust</filename> file. You will
2177 need to determine the best way to do this for your platform.
2182 Please include up to date documentation. At a bare minimum:
2186 <filename>LICENSE</filename> (top-level directory)
2191 <filename>README</filename> (top-level directory)
2196 <filename>AUTHORS</filename> (top-level directory)
2201 <filename>man page</filename> (top-level directory, Unix-like
2207 <filename>The User Manual</filename> (doc/webserver/user-manual/)
2212 <filename>FAQ</filename> (doc/webserver/faq/)
2216 Also suggested: <filename>Developer Manual</filename>
2217 (doc/webserver/developer-manual) and <filename>ChangeLog</filename>
2218 (top-level directory). <filename>FAQ</filename> and the manuals are
2219 HTML docs. There are also text versions in
2220 <filename>doc/text/</filename> which could conceivably also be
2224 The documentation has been designed such that the manuals are linked
2225 to each other from parallel directories, and should be packaged
2226 that way. <filename>privoxy-index.html</filename> can also be
2227 included and can serve as a focal point for docs and other links of
2228 interest (and possibly renamed to <filename>index.html</filename>).
2229 This should be one level up from the manuals. There is a link also
2230 on this page to an HTMLized version of the man page. To avoid 404 for
2231 this, it is in CVS as
2232 <filename>doc/webserver/man-page/privoxy-man-page.html</filename>,
2233 and should be included along with the manuals. There is also a
2234 css stylesheets that can be included for better presentation:
2235 <filename>p_doc.css</filename>. This should be in the same directory
2236 with <filename>privoxy-index.html</filename>, (i.e. one level up from
2237 the manual directories).
2242 <filename>user.action</filename> is designed for local preferences.
2243 Make sure this does not get overwritten!
2248 Other configuration files should be installed as the new defaults,
2249 but all previously installed configuration files should be preserved
2250 as backups. This is just good manners :-)
2255 Please check platform specific notes in this doc, if you haven't
2256 done <quote>Privoxy</quote> packaging before for other platform
2257 specific issues. Conversely, please add any notes that you know
2258 are important for your platform (or contact one of the doc
2259 maintainers to do this if you can't).
2264 Packagers should do a <quote>clean</quote> install of their
2265 package after building it. So any previous installs should be
2266 removed first to ensure the integrity of the newly built package.
2267 Then run the package for a while to make sure there are no
2268 obvious problems, before uploading.
2277 <sect3 id="newrelease-tarball"><title>Source Tarball</title>
2279 First, <emphasis>make sure that you have freshly exported the right
2280 version into an empty directory</emphasis>. (See "Building and releasing
2281 packages" above). Then run:
2286 autoheader && autoconf && ./configure
2298 To upload the package to Sourceforge, simply issue
2306 Go to the displayed URL and release the file publicly on Sourceforge.
2307 For the change log field, use the relevant section of the
2308 <filename>ChangeLog</filename> file.
2312 <sect3 id="newrelease-rpm"><title>SuSE, Conectiva or Red Hat RPM</title>
2314 In following text, replace <replaceable class="parameter">dist</replaceable>
2315 with either <quote>rh</quote> for Red Hat or <quote>suse</quote> for SuSE.
2318 First, <emphasis>make sure that you have freshly exported the right
2319 version into an empty directory</emphasis>. (See "Building and releasing
2323 As the only exception to not changing anything after export from CVS,
2324 now examine the file <filename>privoxy-</filename><replaceable class="parameter">dist</replaceable><filename>.spec</filename>
2325 and make sure that the version information and the RPM release number are
2326 correct. The RPM release numbers for each version start at one. Hence it must
2327 be reset to one if this is the first RPM for
2328 <replaceable class="parameter">dist</replaceable> which is built from version
2330 <ulink url="http://sourceforge.net/project/showfiles.php?group_id=11118">file
2331 list</ulink> if unsure. Else, it must be set to the highest already available RPM
2332 release number for that version plus one.
2340 autoheader && autoconf && ./configure
2348 make <replaceable class="parameter">dist</replaceable>-dist
2352 To upload the package to Sourceforge, simply issue
2356 make <replaceable class="parameter">dist</replaceable>-upload <replaceable class="parameter">rpm_packagerev</replaceable>
2360 where <replaceable class="parameter">rpm_packagerev</replaceable> is the
2361 RPM release number as determined above.
2362 Go to the displayed URL and release the file publicly on Sourceforge.
2363 Use the release notes and change log from the source tarball package.
2367 <sect3 id="newrelease-os2"><title>OS/2</title>
2369 First, <emphasis>make sure that you have freshly exported the right
2370 version into an empty directory</emphasis>. (See "Building and releasing
2371 packages" above). Then get the OS/2 Setup module:
2375 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
2379 You will need a mix of development tools.
2380 The main compilation takes place with IBM Visual Age C++.
2381 Some ancillary work takes place with GNU tools, available from
2382 various sources like hobbes.nmsu.edu.
2383 Specificially, you will need <filename>autoheader</filename>,
2384 <filename>autoconf</filename> and <filename>sh</filename> tools.
2385 The packaging takes place with WarpIN, available from various sources, including
2386 its home page: <ulink url="http://www.xworkplace.org/">xworkplace</ulink>.
2389 Change directory to the <filename>os2setup</filename> directory.
2390 Edit the os2build.cmd file to set the final executable filename.
2395 installExeName='privoxyos2_setup_X.Y.Z.exe'
2399 Next, edit the <filename>IJB.wis</filename> file so the release number matches
2400 in the <filename>PACKAGEID</filename> section:
2404 PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
2408 You're now ready to build. Run:
2416 You will find the WarpIN-installable executable in the
2417 <filename>./files</filename> directory. Upload this anonymously to
2418 <filename>uploads.sourceforge.net/incoming</filename>, create a release
2419 for it, and you're done. Use the release notes and Change Log from the
2420 source tarball package.
2424 <sect3 id="newrelease-solaris"><title>Solaris</title>
2426 Login to Sourceforge's compilefarm via ssh:
2430 ssh cf.sourceforge.net
2434 Choose the right operating system (not the Debian one).
2435 When logged in, <emphasis>make sure that you have freshly exported the right
2436 version into an empty directory</emphasis>. (See "Building and releasing
2437 packages" above). Then run:
2442 autoheader && autoconf && ./configure
2454 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2455 solaris-upload</command> on the Sourceforge machine (no ncftpput). You now have
2456 to manually upload the archive to Sourceforge's ftp server and release
2457 the file publicly. Use the release notes and Change Log from the
2458 source tarball package.
2462 <sect3 id="newrelease-windows"><title>Windows</title>
2464 You should ensure you have the latest version of Cygwin (from
2465 <ulink url="http://www.cygwin.com/">http://www.cygwin.com/</ulink>).
2466 Run the following commands from within a Cygwin bash shell.
2469 First, <emphasis>make sure that you have freshly exported the right
2470 version into an empty directory</emphasis>. (See "Building and releasing
2471 packages" above). Then get the Windows setup module:
2475 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co winsetup
2479 Then you can build the package. This is fully automated, and is
2480 controlled by <filename>winsetup/GNUmakefile</filename>.
2481 All you need to do is:
2490 Now you can manually rename <filename>privoxy_setup.exe</filename> to
2491 <filename>privoxy_setup_X_Y_Z.exe</filename>, and upload it to
2492 SourceForge. When releasing the package on SourceForge, use the release notes
2493 and Change Log from the source tarball package.
2497 <sect3 id="newrelease-debian"><title>Debian</title>
2499 First, <emphasis>make sure that you have freshly exported the
2500 right version into an empty directory</emphasis>. (See
2501 "Building and releasing packages" above). Then add a log
2502 entry to <filename>debian/changelog</filename>, if it is not
2503 already there, for example by running:
2507 debchange -v &p-version;-&p-status;-1 "New upstream version"
2515 dpkg-buildpackage -rfakeroot -us -uc -b
2520 <filename>../privoxy_&p-version;-&p-status;-1_i386.deb</filename>
2521 which can be uploaded. To upload the package to Sourceforge, simply
2531 <sect3 id="newrelease-macosx"><title>Mac OSX</title>
2533 First, <emphasis>make sure that you have freshly exported the right
2534 version into an empty directory</emphasis>. (See "Building and releasing
2535 packages" above). Then get the Mac OSX setup module:
2539 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co osxsetup
2552 This will run <filename>autoheader</filename>, <filename>autoconf</filename> and
2553 <filename>configure</filename> as well as <filename>make</filename>.
2554 Finally, it will copy over the necessary files to the ./osxsetup/files directory
2555 for further processing by <filename>PackageMaker</filename>.
2558 Bring up PackageMaker with the PrivoxyPackage.pmsp definition file, modify the package
2559 name to match the release, and hit the "Create package" button.
2560 If you specify ./Privoxy.pkg as the output package name, you can then create
2561 the distributable zip file with the command:
2565 zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
2569 You can then upload <filename>privoxyosx_setup_x.y.z.zip</filename> anonymously to
2570 <filename>uploads.sourceforge.net/incoming</filename>,
2571 create a release for it, and you're done. Use the release notes
2572 and Change Log from the source tarball package.
2576 <sect3 id="newrelease-freebsd"><title>FreeBSD</title>
2578 Login to Sourceforge's compile-farm via ssh:
2582 ssh cf.sourceforge.net
2586 Choose the right operating system.
2587 When logged in, <emphasis>make sure that you have freshly exported the right
2588 version into an empty directory</emphasis>. (See "Building and releasing
2589 packages" above). Then run:
2594 autoheader && autoconf && ./configure
2606 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2607 freebsd-upload</command> on the Sourceforge machine (no ncftpput). You now have
2608 to manually upload the archive to Sourceforge's ftp server and release
2609 the file publicly. Use the release notes and Change Log from the
2610 source tarball package.
2614 <sect3 id="newrelease-hpux"><title>HP-UX 11</title>
2616 First, <emphasis>make sure that you have freshly exported the right
2617 version into an empty directory</emphasis>. (See "Building and releasing
2618 packages" above). Then run:
2623 autoheader && autoconf && ./configure
2631 <sect3 id="newrelease-amiga"><title>Amiga OS</title>
2633 First, <emphasis>make sure that you have freshly exported the right
2634 version into an empty directory</emphasis>. (See "Building and releasing
2635 packages" above). Then run:
2640 autoheader && autoconf && ./configure
2648 <sect3 id="newrelease-aix"><title>AIX</title>
2650 Login to Sourceforge's compilefarm via ssh:
2654 ssh cf.sourceforge.net
2658 Choose the right operating system.
2659 When logged in, <emphasis>make sure that you have freshly exported the right
2660 version into an empty directory</emphasis>. (See "Building and releasing
2661 packages" above). Then run:
2666 autoheader && autoconf && ./configure
2678 which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
2679 aix-upload</command> on the Sourceforge machine (no ncftpput). You now have
2680 to manually upload the archive to Sourceforge's ftp server and release
2681 the file publicly. Use the release notes and Change Log from the
2682 source tarball package.
2687 <sect2 id="releasing">
2688 <title>Uploading and Releasing Your Package</title>
2690 After the package is ready, it is time to upload it
2691 to SourceForge, and go through the release steps. The upload
2698 Upload to: <ulink url="ftp://upload.sourceforge.net/incoming">ftp://upload.sourceforge.net/incoming</ulink>
2703 user: <literal>anonymous</literal>
2708 password: <literal>ijbswa-developers@lists.sourceforge.net</literal>
2714 Or use the <command>make</command> targets as described above.
2717 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>,
2718 making sure you are logged in. Find your target platform in the
2719 second column, and click <literal>Add Release</literal>. You will
2720 then need to create a new release for your package, using the format
2721 of <literal>$VERSION ($CODE_STATUS)</literal>, e.g. <emphasis>&p-version;
2725 Now just follow the prompts. Be sure to add any appropriate Release
2726 notes. You should see your freshly uploaded packages in
2727 <quote>Step 2. Add Files To This Release</quote>. Check the
2728 appropriate box(es). Remember at each step to hit the
2729 <quote>Refresh/Submit</quote> buttons! You should now see your
2730 file(s) listed in Step 3. Fill out the forms with the appropriate
2731 information for your platform, being sure to hit <quote>Update</quote>
2732 for each file. If anyone is monitoring your platform, check the
2733 <quote>email</quote> box at the very bottom to notify them of
2734 the new package. This should do it!
2737 If you have made errors, or need to make changes, you can go through
2738 essentially the same steps, but select <literal>Edit Release</literal>,
2739 instead of <literal>Add Release</literal>.
2743 <sect2 id="afterrelease">
2744 <title>After the Release</title>
2746 When all (or: most of the) packages have been uploaded and made available,
2747 send an email to the <ulink url="mailto:ijbswa-announce@lists.sourceforge.net">announce
2748 mailing list</ulink>, Subject: "Version X.Y.Z available for download". Be sure to
2750 <ulink url="http://sourceforge.net/project/showfiles.php?group_id=11118">download
2751 location</ulink>, the release notes and the change log.
2757 <!-- ~~~~~ New section ~~~~~ -->
2758 <sect1 id="webserver-update"><title>Update the Webserver</title>
2760 When updating the webserver, please follow these steps to make
2761 sure that no broken links, inconsistent contents or permission
2762 problems will occur:
2765 If you have changed anything in the documentation source SGML files,
2770 make dok # (or make redhat-dok if make dok doesn't work for you)
2774 That will generate <filename>doc/webserver/user-manual</filename>,
2775 <filename>doc/webserver/developer-manual</filename>,
2776 <filename>doc/webserver/faq</filename> and
2777 <filename>doc/webserver/index.html</filename> automatically.
2780 If you changed the manual page source, generate
2781 <filename>doc/webserver/man-page/privoxy-man-page.html</filename>
2782 by running <quote><command>make man</command></quote>. (This is
2783 a separate target due to dependencies on some obscure perl scripts.
2784 See comments in <filename>GNUmakefile</filename>.)
2787 If you want to add new files to the webserver, create them locally in
2788 the <filename>doc/webserver/*</filename> directory (or
2789 create new directories under <filename>doc/webserver</filename>).
2792 Next, commit any changes from the above steps to CVS. All set? Then do
2800 This will do the upload to <ulink url="http://www.privoxy.org/">the
2801 webserver</ulink> (www.privoxy.org) and ensure all files and directories
2802 there are group writable.
2805 Please do <emphasis>NOT</emphasis> use any other means of transferring
2806 files to the webserver to avoid permission problems.
2810 <!-- ~~~~~ New section ~~~~~ -->
2811 <sect1 id="contact"><title>Contacting the developers, Bug Reporting and Feature Requests</title>
2812 <!-- Include contacting.sgml -->
2814 <!-- end contacting -->
2818 <!-- ~~~~~~~~ New section Header ~~~~~~~~~ -->
2819 <sect1 id="copyright"><title>Privoxy Copyright, License and History</title>
2821 <!-- Include copyright.sgml -->
2825 <!-- ~~~~~ New section ~~~~~ -->
2826 <sect2><title>License</title>
2827 <!-- Include copyright.sgml: -->
2829 <!-- end copyright -->
2831 <!-- ~ End section ~ -->
2833 <!-- ~~~~~ New section ~~~~~ -->
2834 <sect2><title>History</title>
2835 <!-- Include history.sgml -->
2842 <!-- ~~~~~ New section ~~~~~ -->
2843 <sect1 id="seealso"><title>See also</title>
2844 <!-- Include seealso.sgml -->
2852 This program is free software; you can redistribute it
2853 and/or modify it under the terms of the GNU General
2854 Public License as published by the Free Software
2855 Foundation; either version 2 of the License, or (at
2856 your option) any later version.
2858 This program is distributed in the hope that it will
2859 be useful, but WITHOUT ANY WARRANTY; without even the
2860 implied warranty of MERCHANTABILITY or FITNESS FOR A
2861 PARTICULAR PURPOSE. See the GNU General Public
2862 License for more details.
2864 The GNU General Public License should be included with
2865 this file. If not, you can view it at
2866 http://www.gnu.org/copyleft/gpl.html
2867 or write to the Free Software Foundation, Inc., 59
2868 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
2870 $Log: developer-manual.sgml,v $
2871 Revision 1.46.2.5 2002/08/09 01:15:12 hal9
2872 Added some notes on pre-release steps (test builds first, update ChangeLog).
2874 Revision 1.46.2.4 2002/05/29 00:30:59 mal0rd
2875 Fixed a little formatting. Clarified debian section.
2877 Revision 1.46.2.3 2002/05/28 04:32:45 hal9
2878 Change hints on bundling index.html to privoxy-index.html
2880 Revision 1.46.2.2 2002/05/26 17:04:24 hal9
2881 -Spellcheck, very minor edits, and sync across branches
2883 Revision 1.48 2002/05/26 12:48:31 roro
2884 Add releasing information about Debian.
2886 Revision 1.47 2002/05/26 04:55:11 mal0rd
2887 Added debian-dist and debian-upload targets. Also documented usage.
2889 Revision 1.46 2002/05/22 17:15:00 oes
2892 Revision 1.45 2002/05/19 23:01:54 hal9
2893 Add small section on general packaging guidelines (e.g. actions files must
2896 Revision 1.44 2002/05/15 03:55:17 hal9
2897 Fix ulink -> link, and minor modification to release process section for
2900 Revision 1.43 2002/05/10 01:48:19 hal9
2901 This is mostly proposed copyright/licensing additions and changes. Docs
2902 are still GPL, but licensing and copyright are more visible. Also, copyright
2903 changed in doc header comments (eliminate references to JB except FAQ).
2905 Revision 1.42 2002/05/05 20:26:02 hal9
2906 Sorting out license vs copyright in these docs.
2908 Revision 1.41 2002/05/04 08:44:44 swa
2911 Revision 1.40 2002/05/04 00:43:43 hal9
2912 -Remove TOC/first page kludge with proper stylesheet fix.
2913 -Combined the two very brief sections: Intro and Quickstart.
2915 Revision 1.39 2002/05/02 15:08:25 oes
2916 Added explanation about version numbers and RPM package revisions
2918 Revision 1.38 2002/04/29 02:20:31 hal9
2919 Add info on steps for uploading and the release process on SF.
2921 Revision 1.37 2002/04/26 17:23:29 swa
2922 bookmarks cleaned, changed structure of user manual, screen and programlisting cleanups, and numerous other changes that I forgot
2924 Revision 1.36 2002/04/26 05:25:23 hal9
2925 Mass commit to catch a few scattered fixes.
2927 Revision 1.35 2002/04/17 15:16:15 oes
2928 Added link to docbook crash course
2930 Revision 1.34 2002/04/15 23:39:32 oes
2931 - Extended & fixed the release section
2932 - Added CVS guideline sections
2933 - Separated webserver section from release section
2934 - Commented out boilerplate inclusion (If you don't know yet what it is,
2935 you shouldn't mess with its code ;-)
2938 Revision 1.33 2002/04/12 03:49:53 hal9
2939 Spell checked. Clarification on where docs are kept.
2941 Revision 1.32 2002/04/11 21:29:58 jongfoster
2942 Documenting Win32 release procedure
2944 Revision 1.31 2002/04/11 09:32:52 oes
2947 Revision 1.30 2002/04/11 09:24:53 oes
2950 Revision 1.29 2002/04/10 18:45:14 swa
2953 Revision 1.28 2002/04/08 22:59:26 hal9
2954 Version update. Spell chkconfig correctly :)
2956 Revision 1.27 2002/04/08 15:31:18 hal9
2957 Touch ups to documentation section.
2959 Revision 1.26 2002/04/07 23:50:08 hal9
2960 Documentation changes to reflect HTML docs now in CVS, and new generated files
2963 Revision 1.25 2002/04/06 05:07:28 hal9
2964 -Add privoxy-man-page.sgml, for man page.
2965 -Add authors.sgml for AUTHORS (and p-authors.sgml)
2966 -Reworked various aspects of various docs.
2967 -Added additional comments to sub-docs.
2969 Revision 1.24 2002/04/04 21:33:37 hal9
2970 More on documenting the documents.
2972 Revision 1.23 2002/04/04 18:46:47 swa
2973 consistent look. reuse of copyright, history et. al.
2975 Revision 1.22 2002/04/04 17:27:56 swa
2976 more single file to be included at multiple points. make maintaining easier
2978 Revision 1.21 2002/04/04 06:48:37 hal9
2979 Structural changes to allow for conditional inclusion/exclusion of content
2980 based on entity toggles, e.g. 'entity % p-not-stable "INCLUDE"'. And
2981 definition of internal entities, e.g. 'entity p-version "2.9.13"' that will
2982 eventually be set by Makefile.
2983 More boilerplate text for use across multiple docs.
2985 Revision 1.20 2002/04/04 03:28:27 david__schmidt
2988 Revision 1.19 2002/04/03 15:09:42 david__schmidt
2989 Add OS/2 build section
2991 Revision 1.18 2002/04/03 03:51:48 hal9
2994 Revision 1.17 2002/04/03 01:21:17 hal9
2995 Implementing Andreas's suggestions for Release sections.
2997 Revision 1.16 2002/03/31 23:04:40 hal9
2998 Fleshed out the doc section, and added something for an intro so it was not
3001 Revision 1.15 2002/03/30 22:29:47 swa
3004 Revision 1.14 2002/03/30 19:04:08 swa
3005 people release differently. no good.
3006 I want to make parts of the docs only.
3008 Revision 1.13 2002/03/27 01:16:41 hal9
3011 Revision 1.12 2002/03/27 01:02:51 hal9
3012 Touch up on name change...
3014 Revision 1.11 2002/03/26 22:29:55 swa
3015 we have a new homepage!
3017 Revision 1.10 2002/03/24 12:33:01 swa
3020 Revision 1.9 2002/03/24 11:01:05 swa
3023 Revision 1.8 2002/03/23 15:13:11 swa
3024 renamed every reference to the old name with foobar.
3025 fixed "application foobar application" tag, fixed
3026 "the foobar" with "foobar". left junkbustser in cvs
3027 comments and remarks to history untouched.
3029 Revision 1.7 2002/03/11 13:13:27 swa
3030 correct feedback channels
3032 Revision 1.6 2002/02/24 14:25:06 jongfoster
3033 Formatting changes. Now changing the doctype to DocBook XML 4.1
3034 will work - no other changes are needed.
3036 Revision 1.5 2001/10/31 18:16:51 swa
3037 documentation added: howto generate docs in text and html
3038 format, howto move stuff to the webserver.
3040 Revision 1.4 2001/09/23 10:13:48 swa
3041 upload process established. run make webserver and
3042 the documentation is moved to the webserver. documents
3043 are now linked correctly.
3045 Revision 1.3 2001/09/13 15:27:40 swa
3048 Revision 1.2 2001/09/13 15:20:17 swa
3049 merged standards into developer manual
3051 Revision 1.1 2001/09/12 15:36:41 swa
3052 source files for junkbuster documentation
3054 Revision 1.3 2001/09/10 17:43:59 swa
3055 first proposal of a structure.
3057 Revision 1.2 2001/06/13 14:28:31 swa
3058 docs should have an author.
3060 Revision 1.1 2001/06/13 14:20:37 swa
3061 first import of project's documentation for the webserver.
projects / privoxy.git / blob