|
current/doc/webserver/developer-manual quickstart.html, 1.6, 1.7 coding.htm: msg#00007web.privoxy.cvs
Update of /cvsroot/ijbswa/current/doc/webserver/developer-manual In directory sc8-pr-cvs2.sourceforge.net:/tmp/cvs-serv26899/doc/webserver/developer-manual Modified Files: coding.html contact.html copyright.html cvs.html documentation.html index.html introduction.html newrelease.html seealso.html testing.html webserver-update.html Added Files: quickstart.html Log Message: Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch) with what was really the latest development (the v_3_0_branch branch) Index: coding.html =================================================================== RCS file: /cvsroot/ijbswa/current/doc/webserver/developer-manual/coding.html,v retrieving revision 1.20 retrieving revision 1.21 diff -u -d -r1.20 -r1.21 --- coding.html 5 Sep 2002 23:26:21 -0000 1.20 +++ coding.html 18 Jul 2006 14:48:52 -0000 1.21 @@ -1,11 +1,11 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <HTML ><HEAD ><TITLE >Coding Guidelines</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK REL="HOME" TITLE="Privoxy Developer Manual" HREF="index.html"><LINK @@ -73,13 +73,17 @@ ><H1 CLASS="SECT1" ><A -NAME="CODING">4. Coding Guidelines</H1 +NAME="CODING" +>4. Coding Guidelines</A +></H1 ><DIV CLASS="SECT2" ><H2 CLASS="SECT2" ><A -NAME="S1">4.1. Introduction</H2 +NAME="S1" +>4.1. Introduction</A +></H2 ><P >This set of standards is designed to make our lives easier. It is developed with the simple goal of helping us keep the "new and improved @@ -100,13 +104,17 @@ ><H2 CLASS="SECT2" ><A -NAME="S2">4.2. Using Comments</H2 +NAME="S2" +>4.2. Using Comments</A +></H2 ><DIV CLASS="SECT3" ><H3 CLASS="SECT3" ><A -NAME="S3">4.2.1. Comment, Comment, Comment</H3 +NAME="S3" +>4.2.1. Comment, Comment, Comment</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -168,7 +176,9 @@ ><H3 CLASS="SECT3" ><A -NAME="S4">4.2.2. Use blocks for comments</H3 +NAME="S4" +>4.2.2. Use blocks for comments</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -240,7 +250,9 @@ ><H3 CLASS="SECT3" ><A -NAME="S5">4.2.3. Keep Comments on their own line</H3 +NAME="S5" +>4.2.3. Keep Comments on their own line</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -317,7 +329,9 @@ ><H3 CLASS="SECT3" ><A -NAME="S6">4.2.4. Comment each logical step</H3 +NAME="S6" +>4.2.4. Comment each logical step</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -344,7 +358,9 @@ ><H3 CLASS="SECT3" ><A -NAME="S7">4.2.5. Comment All Functions Thoroughly</H3 +NAME="S7" +>4.2.5. Comment All Functions Thoroughly</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -372,8 +388,10 @@ ><H3 CLASS="SECT3" ><A -NAME="S8">4.2.6. Comment at the end of braces if the - content is more than one screen length</H3 +NAME="S8" +>4.2.6. Comment at the end of braces if the + content is more than one screen length</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -433,13 +451,17 @@ ><H2 CLASS="SECT2" ><A -NAME="S9">4.3. Naming Conventions</H2 +NAME="S9" +>4.3. Naming Conventions</A +></H2 ><DIV CLASS="SECT3" ><H3 CLASS="SECT3" ><A -NAME="S10">4.3.1. Variable Names</H3 +NAME="S10" +>4.3.1. Variable Names</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -503,7 +525,9 @@ ><H3 CLASS="SECT3" ><A -NAME="S11">4.3.2. Function Names</H3 +NAME="S11" +>4.3.2. Function Names</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -568,7 +592,9 @@ ><H3 CLASS="SECT3" ><A -NAME="S12">4.3.3. Header file prototypes</H3 +NAME="S12" +>4.3.3. Header file prototypes</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -631,7 +657,9 @@ ><H3 CLASS="SECT3" ><A -NAME="S13">4.3.4. Enumerations, and #defines</H3 +NAME="S13" +>4.3.4. Enumerations, and #defines</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -705,7 +733,9 @@ ><H3 CLASS="SECT3" ><A -NAME="S14">4.3.5. Constants</H3 +NAME="S14" +>4.3.5. Constants</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -775,13 +805,17 @@ ><H2 CLASS="SECT2" ><A -NAME="S15">4.4. Using Space</H2 +NAME="S15" +>4.4. Using Space</A +></H2 ><DIV CLASS="SECT3" ><H3 CLASS="SECT3" ><A -NAME="S16">4.4.1. Put braces on a line by themselves.</H3 +NAME="S16" +>4.4.1. Put braces on a line by themselves.</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -885,8 +919,10 @@ ><H3 CLASS="SECT3" ><A -NAME="S17">4.4.2. ALL control statements should have a - block</H3 +NAME="S17" +>4.4.2. ALL control statements should have a + block</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -955,8 +991,10 @@ ><H3 CLASS="SECT3" ><A -NAME="S18">4.4.3. Do not belabor/blow-up boolean - expressions</H3 +NAME="S18" +>4.4.3. Do not belabor/blow-up boolean + expressions</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -1005,8 +1043,10 @@ ><H3 CLASS="SECT3" ><A -NAME="S19">4.4.4. Use white space freely because it is - free</H3 +NAME="S19" +>4.4.4. Use white space freely because it is + free</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -1051,8 +1091,10 @@ ><H3 CLASS="SECT3" ><A -NAME="S20">4.4.5. Don't use white space around structure - operators</H3 +NAME="S20" +>4.4.5. Don't use white space around structure + operators</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -1106,8 +1148,10 @@ ><H3 CLASS="SECT3" ><A -NAME="S21">4.4.6. Make the last brace of a function stand - out</H3 +NAME="S21" +>4.4.6. Make the last brace of a function stand + out</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -1178,7 +1222,9 @@ ><H3 CLASS="SECT3" ><A -NAME="S22">4.4.7. Use 3 character indentions</H3 +NAME="S22" +>4.4.7. Use 3 character indentions</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -1238,13 +1284,17 @@ ><H2 CLASS="SECT2" ><A -NAME="S23">4.5. Initializing</H2 +NAME="S23" +>4.5. Initializing</A +></H2 ><DIV CLASS="SECT3" ><H3 CLASS="SECT3" ><A -NAME="S24">4.5.1. Initialize all variables</H3 +NAME="S24" +>4.5.1. Initialize all variables</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -1307,14 +1357,18 @@ ><H2 CLASS="SECT2" ><A -NAME="S25">4.6. Functions</H2 +NAME="S25" +>4.6. Functions</A +></H2 ><DIV CLASS="SECT3" ><H3 CLASS="SECT3" ><A -NAME="S26">4.6.1. Name functions that return a boolean as a - question.</H3 +NAME="S26" +>4.6.1. Name functions that return a boolean as a + question.</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -1354,8 +1408,10 @@ ><H3 CLASS="SECT3" ><A -NAME="S27">4.6.2. Always specify a return type for a - function.</H3 +NAME="S27" +>4.6.2. Always specify a return type for a + function.</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -1375,8 +1431,10 @@ ><H3 CLASS="SECT3" ><A -NAME="S28">4.6.3. Minimize function calls when iterating by - using variables</H3 +NAME="S28" +>4.6.3. Minimize function calls when iterating by + using variables</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -1472,7 +1530,9 @@ ><H3 CLASS="SECT3" ><A -NAME="S29">4.6.4. Pass and Return by Const Reference</H3 +NAME="S29" +>4.6.4. Pass and Return by Const Reference</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -1500,7 +1560,9 @@ ><H3 CLASS="SECT3" ><A -NAME="S30">4.6.5. Pass and Return by Value</H3 +NAME="S30" +>4.6.5. Pass and Return by Value</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -1523,7 +1585,9 @@ ><H3 CLASS="SECT3" ><A -NAME="S31">4.6.6. Names of include files</H3 +NAME="S31" +>4.6.6. Names of include files</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -1599,8 +1663,10 @@ ><H3 CLASS="SECT3" ><A -NAME="S32">4.6.7. Provide multiple inclusion - protection</H3 +NAME="S32" +>4.6.7. Provide multiple inclusion + protection</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -1646,7 +1712,9 @@ ><H3 CLASS="SECT3" ><A -NAME="S33">4.6.8. Use `extern "C"` when appropriate</H3 +NAME="S33" +>4.6.8. Use `extern "C"` when appropriate</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -1694,8 +1762,10 @@ ><H3 CLASS="SECT3" ><A -NAME="S34">4.6.9. Where Possible, Use Forward Struct - Declaration Instead of Includes</H3 +NAME="S34" +>4.6.9. Where Possible, Use Forward Struct + Declaration Instead of Includes</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -1758,13 +1828,17 @@ ><H2 CLASS="SECT2" ><A -NAME="S35">4.7. General Coding Practices</H2 +NAME="S35" +>4.7. General Coding Practices</A +></H2 ><DIV CLASS="SECT3" ><H3 CLASS="SECT3" ><A -NAME="S36">4.7.1. Turn on warnings</H3 +NAME="S36" +>4.7.1. Turn on warnings</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -1783,8 +1857,10 @@ ><H3 CLASS="SECT3" ><A -NAME="S37">4.7.2. Provide a default case for all switch - statements</H3 +NAME="S37" +>4.7.2. Provide a default case for all switch + statements</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -1869,8 +1945,10 @@ ><H3 CLASS="SECT3" ><A -NAME="S38">4.7.3. Try to avoid falling through cases in a - switch statement.</H3 +NAME="S38" +>4.7.3. Try to avoid falling through cases in a + switch statement.</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -1901,8 +1979,10 @@ ><H3 CLASS="SECT3" ><A -NAME="S39">4.7.4. Use 'long' or 'short' Instead of - 'int'</H3 +NAME="S39" +>4.7.4. Use 'long' or 'short' Instead of + 'int'</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -1932,7 +2012,9 @@ ><H3 CLASS="SECT3" ><A -NAME="S40">4.7.5. Don't mix size_t and other types</H3 +NAME="S40" +>4.7.5. Don't mix size_t and other types</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -1954,8 +2036,10 @@ ><H3 CLASS="SECT3" ><A -NAME="S41">4.7.6. Declare each variable and struct on its - own line.</H3 +NAME="S41" +>4.7.6. Declare each variable and struct on its + own line.</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -2036,7 +2120,9 @@ ><H3 CLASS="SECT3" ><A -NAME="S42">4.7.7. Use malloc/zalloc sparingly</H3 +NAME="S42" +>4.7.7. Use malloc/zalloc sparingly</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -2078,8 +2164,10 @@ ><H3 CLASS="SECT3" ><A -NAME="S43">4.7.8. The Programmer Who Uses 'malloc' is - Responsible for Ensuring 'free'</H3 +NAME="S43" +>4.7.8. The Programmer Who Uses 'malloc' is + Responsible for Ensuring 'free'</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -2145,8 +2233,10 @@ ><H3 CLASS="SECT3" ><A -NAME="S44">4.7.9. Add loaders to the `file_list' structure - and in order</H3 +NAME="S44" +>4.7.9. Add loaders to the `file_list' structure + and in order</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -2176,8 +2266,10 @@ ><H3 CLASS="SECT3" ><A -NAME="S45">4.7.10. "Uncertain" new code and/or changes to - existing code, use FIXME</H3 +NAME="S45" +>4.7.10. "Uncertain" new code and/or changes to + existing code, use FIXME</A +></H3 ><P ><SPAN CLASS="emphasis" @@ -2222,8 +2314,10 @@ ><H2 CLASS="SECT2" ><A -NAME="S46">4.8. Addendum: Template for files and function - comment blocks:</H2 +NAME="S46" +>4.8. Addendum: Template for files and function + comment blocks:</A +></H2 ><P ><SPAN CLASS="emphasis" @@ -2274,8 +2368,12 @@ * * Revisions : * $Log$ - * Revision 1.20 2002/09/05 23:26:21 hal9 - * Just regenerating to get fresh version in place of very dated versions. + * Revision 1.21 2006/07/18 14:48:52 david__schmidt + * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch) + * with what was really the latest development (the v_3_0_branch branch) + * + * Revision 1.19.2.7 2004/01/31 00:05:44 oes + * Regenerated from sgml source * * *********************************************************************/ @@ -2364,8 +2462,12 @@ * * Revisions : * $Log$ - * Revision 1.20 2002/09/05 23:26:21 hal9 - * Just regenerating to get fresh version in place of very dated versions. + * Revision 1.21 2006/07/18 14:48:52 david__schmidt + * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch) + * with what was really the latest development (the v_3_0_branch branch) + * + * Revision 1.19.2.7 2004/01/31 00:05:44 oes + * Regenerated from sgml source * * *********************************************************************/ Index: contact.html =================================================================== RCS file: /cvsroot/ijbswa/current/doc/webserver/developer-manual/contact.html,v retrieving revision 1.11 retrieving revision 1.12 diff -u -d -r1.11 -r1.12 --- contact.html 5 Sep 2002 23:26:21 -0000 1.11 +++ contact.html 18 Jul 2006 14:48:53 -0000 1.12 @@ -1,11 +1,11 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <HTML ><HEAD ><TITLE >Contacting the developers, Bug Reporting and Feature Requests</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK REL="HOME" TITLE="Privoxy Developer Manual" HREF="index.html"><LINK @@ -73,7 +73,9 @@ ><H1 CLASS="SECT1" ><A -NAME="CONTACT">8. Contacting the developers, Bug Reporting and Feature Requests</H1 +NAME="CONTACT" +>8. Contacting the developers, Bug Reporting and Feature Requests</A +></H1 ><P > We value your feedback. In fact, we rely on it to improve <SPAN @@ -87,13 +89,15 @@ ><H2 CLASS="SECT2" ><A -NAME="CONTACT-SUPPORT">8.1. Get Support</H2 +NAME="CONTACT-SUPPORT" +>8.1. Get Support</A +></H2 ><P -> For casual users, our support forum at +> For casual users, our <A -HREF="http://sourceforge.net/" +HREF="http://sourceforge.net/tracker/?group_id=11118&atid=211118" TARGET="_top" ->SourceForge</A +>support forum at SourceForge</A > is probably best suited: <A @@ -114,7 +118,9 @@ ><H2 CLASS="SECT2" ><A -NAME="CONTACT-BUGS">8.2. Report Bugs</H2 +NAME="CONTACT-BUGS" +>8.2. Report Bugs</A +></H2 ><P > Please report all bugs <SPAN CLASS="emphasis" @@ -177,7 +183,9 @@ ><H2 CLASS="SECT2" ><A -NAME="CONTACT-FEATURE">8.3. Request New Features</H2 +NAME="CONTACT-FEATURE" +>8.3. Request New Features</A +></H2 ><P > You are welcome to submit ideas on new features or other proposals for improvement through our feature request tracker at @@ -192,7 +200,9 @@ ><H2 CLASS="SECT2" ><A -NAME="CONTACT-ADS">8.4. Report Ads or Other Actions-Related Problems</H2 +NAME="CONTACT-ADS" +>8.4. Report Ads or Other Actions-Related Problems</A +></H2 ><P > Please send feedback on ads that slipped through, innocent images that were > blocked, and any other problems relating to the <TT @@ -233,7 +243,9 @@ ><H2 CLASS="SECT2" ><A -NAME="CONTACT-OTHER">8.5. Other</H2 +NAME="CONTACT-OTHER" +>8.5. Other</A +></H2 ><P >For any other issues, feel free to use the mailing lists. Technically >interested users and people who wish to contribute to the project are also welcome on the developers list! Index: copyright.html =================================================================== RCS file: /cvsroot/ijbswa/current/doc/webserver/developer-manual/copyright.html,v retrieving revision 1.13 retrieving revision 1.14 diff -u -d -r1.13 -r1.14 --- copyright.html 5 Sep 2002 23:26:21 -0000 1.13 +++ copyright.html 18 Jul 2006 14:48:53 -0000 1.14 @@ -1,11 +1,11 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <HTML ><HEAD ><TITLE >Privoxy Copyright, License and History</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK REL="HOME" TITLE="Privoxy Developer Manual" HREF="index.html"><LINK @@ -73,14 +73,16 @@ ><H1 CLASS="SECT1" ><A -NAME="COPYRIGHT">9. Privoxy Copyright, License and History</H1 +NAME="COPYRIGHT" +>9. Privoxy Copyright, License and History</A +></H1 ><P -> Copyright © 2001, 2002 by Privoxy Developers <TT +> Copyright © 2001 - 2004 by Privoxy Developers <CODE CLASS="EMAIL" ><<A HREF="mailto:developers@xxxxxxxxxxx" >developers@xxxxxxxxxxx</A ->></TT +>></CODE ></P ><P > Some source code is based on code Copyright © 1997 by Anonymous Coders @@ -94,7 +96,9 @@ ><H2 CLASS="SECT2" ><A -NAME="AEN1170">9.1. License</H2 +NAME="AEN1177" +>9.1. License</A +></H2 ><P > <SPAN CLASS="APPLICATION" @@ -154,7 +158,9 @@ ><H2 CLASS="SECT2" ><A -NAME="AEN1186">9.2. History</H2 +NAME="AEN1193" +>9.2. History</A +></H2 ><P > In the beginning, there was the <A @@ -231,7 +237,7 @@ CLASS="APPLICATION" >Privoxy</SPAN >, whose first - stable release, 3.0, was released August, 2002. + stable version, 3.0, was released August, 2002. </P ></DIV ></DIV Index: cvs.html =================================================================== RCS file: /cvsroot/ijbswa/current/doc/webserver/developer-manual/cvs.html,v retrieving revision 1.5 retrieving revision 1.6 diff -u -d -r1.5 -r1.6 --- cvs.html 5 Sep 2002 23:26:21 -0000 1.5 +++ cvs.html 18 Jul 2006 14:48:53 -0000 1.6 @@ -1,11 +1,11 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <HTML ><HEAD ><TITLE >The CVS Repository</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK REL="HOME" TITLE="Privoxy Developer Manual" HREF="index.html"><LINK @@ -73,18 +73,23 @@ ><H1 CLASS="SECT1" ><A -NAME="CVS">2. The CVS Repository</H1 +NAME="CVS" +>2. The CVS Repository</A +></H1 ><P -> If you intend to help us with programming, documentation or packaging - you will need write access to our holy grail, the CVS repository. - Please read this chapter completely before accessing via CVS. +> If you become part of the active development team, you will eventually + need write access to our holy grail, the CVS repository. One of the + team members will need to set this up for you. Please read + this chapter completely before accessing via CVS. </P ><DIV CLASS="SECT2" ><H2 CLASS="SECT2" ><A -NAME="CVSACCESS">2.1. Access to CVS</H2 +NAME="CVSACCESS" +>2.1. Access to CVS</A +></H2 ><P > The project's CVS repository is hosted on <A @@ -100,17 +105,17 @@ documentation</A > for the technical access details for your operating system. For historical reasons, the CVS server is - called <TT + called <VAR CLASS="LITERAL" ->cvs.ijbswa.sourceforge.net</TT +>cvs.ijbswa.sourceforge.net</VAR >, the repository is - called <TT + called <VAR CLASS="LITERAL" ->ijbswa</TT +>ijbswa</VAR >, and the source tree module is called - <TT + <VAR CLASS="LITERAL" ->current</TT +>current</VAR >. </P ></DIV @@ -119,12 +124,14 @@ ><H2 CLASS="SECT2" ><A -NAME="CVSBRANCHES">2.2. Branches</H2 +NAME="CVSBRANCHES" +>2.2. Branches</A +></H2 ><P > Within the CVS repository, there are modules and branches. As - mentioned, the sources are in the <TT + mentioned, the sources are in the <VAR CLASS="LITERAL" ->current</TT +>current</VAR > <SPAN CLASS="QUOTE" @@ -139,9 +146,9 @@ </P ><P > Branches are used to fork a sub-development path from the main trunk. - Within the <TT + Within the <VAR CLASS="LITERAL" ->current</TT +>current</VAR > module where the sources are, there is always at least one <SPAN CLASS="QUOTE" @@ -149,30 +156,46 @@ > from the main trunk devoted to a stable release series. The main trunk is where active development takes place for the next stable series (e.g. 3.2.x). - And for testing bugfixes for the stable series. Just prior to each - stable series (e.g. 3.0.x), a branch is created just for stable series - releases (e.g. 3.0.0 -> 3.0.1 -> 3.0.2, etc). Once the initial stable - release of any stable branch has taken place, this branch is - <SPAN + So just prior to each stable series (e.g. 3.0.x), a branch is created + just for stable series releases (e.g. 3.0.0 -> 3.0.1 -> 3.0.2, etc). + Once the initial stable release of any stable branch has taken place, + this branch is <SPAN CLASS="emphasis" ><I CLASS="EMPHASIS" >only used for bugfixes</I ></SPAN ->, which have had prior - testing before being committed to CVS. (See <A +>, which have + had prior testing before being committed to CVS. (See <A HREF="newrelease.html#VERSIONNUMBERS" >Version Numbers</A > below for details on versioning.) </P +><P +> This will result in at least two active branches, which means there may + be occasions that require the same (or similar) item to be + checked into to two different places (assuming its a bugfix and needs + fixing in both the stable and unstable trees). This also means that in + order to have access to both trees, both will have to be checked out + separately. Use the <VAR +CLASS="LITERAL" +>cvs -r</VAR +> flag to check out a + branch, e.g: <VAR +CLASS="LITERAL" +>cvs co -r v_3_0_branch current</VAR +>. + </P ></DIV ><DIV CLASS="SECT2" ><H2 CLASS="SECT2" ><A -NAME="CVSCOMMIT">2.3. CVS Commit Guidelines</H2 +NAME="CVSCOMMIT" +>2.3. CVS Commit Guidelines</A +></H2 ><P > The source tree is the heart of every software project. Every effort > must be made to ensure that it is readable, compilable and consistent at all @@ -255,10 +278,13 @@ > </P ><P -> Stable branches are handled with decidedly more care, especially after - the initial *.*.0 release, and we are just in bugfix mode. In addition - to the above, the below applies only to the stable branch (currently - the v_3_0_branchpoint branch): +> Stable branches are handled with more care, especially after the + initial *.*.0 release, and we are just in bugfix mode. In addition to + the above, the below applies only to the stable branch (currently the + <VAR +CLASS="LITERAL" +>v_3_0_branch</VAR +> branch): </P ><P > <P @@ -266,17 +292,17 @@ ><UL ><LI ><P -> Do <SPAN +> Do not commit <SPAN CLASS="emphasis" ><I CLASS="EMPHASIS" ->not commit anything</I +>anything</I ></SPAN -> into the stable branch, - unless immediately before a new release! There needs to be testing - done before it hits CVS, and to ensure that all changes are - appropriate just to fix whatever the problem is. - </P +> unless your proposed + changes have been well tested first, preferably by other members of the + project, or have prior approval of the project leaders or consensus + of the devel list. + </P ></LI ><LI ><P @@ -298,20 +324,6 @@ ></LI ><LI ><P -> Do not commit <SPAN -CLASS="emphasis" -><I -CLASS="EMPHASIS" ->anything</I -></SPAN -> unless your proposed - changes have been well tested first, by other members of the - project, and have prior approval of the project leaders or consensus - of the devel list. - </P -></LI -><LI -><P > Do not even think about anything except bugfixes. No new features! </P ></LI Index: documentation.html =================================================================== RCS file: /cvsroot/ijbswa/current/doc/webserver/developer-manual/documentation.html,v retrieving revision 1.10 retrieving revision 1.11 diff -u -d -r1.10 -r1.11 --- documentation.html 5 Sep 2002 23:26:21 -0000 1.10 +++ documentation.html 18 Jul 2006 14:48:53 -0000 1.11 @@ -1,11 +1,11 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <HTML ><HEAD ><TITLE >Documentation Guidelines</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK REL="HOME" TITLE="Privoxy Developer Manual" HREF="index.html"><LINK @@ -73,12 +73,14 @@ ><H1 CLASS="SECT1" ><A -NAME="DOCUMENTATION">3. Documentation Guidelines</H1 +NAME="DOCUMENTATION" +>3. Documentation Guidelines</A +></H1 ><P > All formal documents are maintained in Docbook SGML and located in the - <TT + <SAMP CLASS="COMPUTEROUTPUT" ->doc/source/*</TT +>doc/source/*</SAMP > directory. You will need <A HREF="http://www.docbook.org" @@ -197,26 +199,26 @@ </P ><P > Formal documents are built with the Makefile targets of - <TT + <SAMP CLASS="COMPUTEROUTPUT" ->make dok</TT +>make dok</SAMP >, or alternately - <TT + <SAMP CLASS="COMPUTEROUTPUT" ->make redhat-dok</TT +>make redhat-dok</SAMP >. If you have problems, try both. The build process uses the document SGML sources in - <TT + <SAMP CLASS="COMPUTEROUTPUT" ->doc/source/*/*</TT +>doc/source/*/*</SAMP > to update all text files in - <TT + <SAMP CLASS="COMPUTEROUTPUT" ->doc/text/</TT +>doc/text/</SAMP > and to update all HTML - documents in <TT + documents in <SAMP CLASS="COMPUTEROUTPUT" ->doc/webserver/</TT +>doc/webserver/</SAMP >. </P ><P @@ -232,30 +234,30 @@ TYPE="1" ><LI ><P -> First, build the docs by running <TT +> First, build the docs by running <SAMP CLASS="COMPUTEROUTPUT" >make - dok</TT -> (or alternately <TT + dok</SAMP +> (or alternately <SAMP CLASS="COMPUTEROUTPUT" >make - redhat-dok</TT ->). For PDF docs, do <TT + redhat-dok</SAMP +>). For PDF docs, do <SAMP CLASS="COMPUTEROUTPUT" >make - dok-pdf</TT + dok-pdf</SAMP >. </P ></LI ><LI ><P -> Run <TT +> Run <SAMP CLASS="COMPUTEROUTPUT" ->make webserver</TT +>make webserver</SAMP > which copies all - files from <TT + files from <SAMP CLASS="COMPUTEROUTPUT" ->doc/webserver</TT +>doc/webserver</SAMP > to the sourceforge webserver via scp. </P @@ -277,9 +279,9 @@ CLASS="EMPHASIS" >after</I ></SPAN -> the <TT +> the <VAR CLASS="LITERAL" ->$VERSION</TT +>$VERSION</VAR > and other release specific data in <TT CLASS="FILENAME" @@ -292,7 +294,9 @@ ><H2 CLASS="SECT2" ><A -NAME="SGML">3.1. Quickstart to Docbook and SGML</H2 +NAME="SGML" +>3.1. Quickstart to Docbook and SGML</A +></H2 ><P > If you are not familiar with SGML, it is a markup language similar to HTML. Actually, not a mark up language per se, but a language used to define @@ -329,10 +333,10 @@ CLASS="QUOTE" >"closed"</SPAN >. If not, you - will likely generate errors. Example: <TT + will likely generate errors. Example: <VAR CLASS="LITERAL" ><title>My - Title</title></TT + Title</title></VAR >. They are also case-insensitive, but we strongly suggest using all lower case. This keeps compatibility with [Docbook] <SPAN @@ -344,40 +348,40 @@ CLASS="QUOTE" >"sections"</SPAN > for the most part. Sections - will be processed into HTML headers (e.g. <TT + will be processed into HTML headers (e.g. <VAR CLASS="LITERAL" ->h1</TT +>h1</VAR > for - <TT + <VAR CLASS="LITERAL" ->sect1</TT +>sect1</VAR >). The <SPAN CLASS="APPLICATION" >Docbook</SPAN > stylesheets will use these to also generate the Table of Contents for each doc. Our - TOC's are set to a depth of three. Meaning <TT + TOC's are set to a depth of three. Meaning <VAR CLASS="LITERAL" ->sect1</TT +>sect1</VAR >, - <TT + <VAR CLASS="LITERAL" ->sect2</TT ->, and <TT +>sect2</VAR +>, and <VAR CLASS="LITERAL" ->sect3</TT +>sect3</VAR > will have TOC - entries, but <TT + entries, but <VAR CLASS="LITERAL" ->sect4</TT +>sect4</VAR > will not. Each section requires - a <TT + a <VAR CLASS="LITERAL" -><title></TT +><title></VAR > element, and at least one - <TT + <VAR CLASS="LITERAL" -><para></TT +><para></VAR >. There is a limit of five section levels in Docbook, but generally three should be sufficient for our purposes.</P @@ -444,9 +448,9 @@ ><literallayout></literallayout></I ></SPAN >, like - <TT + <VAR CLASS="LITERAL" -><pre></TT +><pre></VAR >, more or less. </TD ></TR @@ -481,9 +485,9 @@ ><screen></screen></I ></SPAN >, screen output, implies - <TT + <VAR CLASS="LITERAL" -><literallayout></TT +><literallayout></VAR >. </TD ></TR @@ -496,9 +500,9 @@ ><ulink url="example.com"></ulink></I ></SPAN >, like - HTML <TT + HTML <VAR CLASS="LITERAL" -><a></TT +><a></VAR > tag. </TD ></TR @@ -536,10 +540,12 @@ ><H2 CLASS="SECT2" ><A -NAME="DOCSTYLE">3.2. <SPAN +NAME="DOCSTYLE" +>3.2. <SPAN CLASS="APPLICATION" >Privoxy</SPAN -> Documentation Style</H2 +> Documentation Style</A +></H2 ><P > It will be easier if everyone follows a similar writing style. This just makes it easier to read what someone else has written if it @@ -659,9 +665,9 @@ CLASS="APPLICATION" >aspell</SPAN > can check SGML with the - <TT + <VAR CLASS="LITERAL" ->-H</TT +>-H</VAR > option. (<SPAN CLASS="APPLICATION" >ispell</SPAN @@ -678,7 +684,9 @@ ><H2 CLASS="SECT2" ><A -NAME="AEN233">3.3. Privoxy Custom Entities</H2 +NAME="AEN233" +>3.3. Privoxy Custom Entities</A +></H2 ><P > <SPAN CLASS="APPLICATION" @@ -717,9 +725,9 @@ >"internal entities"</SPAN >. These are like variables in programming. Well, sort of. For instance, we have the - <TT + <VAR CLASS="LITERAL" ->p-version</TT +>p-version</VAR > entity that contains the current <SPAN CLASS="APPLICATION" @@ -741,9 +749,9 @@ > text entities are defined like: </P ><P -> <TT +> <VAR CLASS="LITERAL" -><!entity supported SYSTEM "supported.sgml"></TT +><!entity supported SYSTEM "supported.sgml"></VAR > </P ><P @@ -753,9 +761,9 @@ >supported.sgml</TT > is available for inclusion anywhere in the doc. To make this happen, just reference the now defined - entity: <TT + entity: <VAR CLASS="LITERAL" ->&supported;</TT +>&supported;</VAR > (starts with an ampersand and ends with a semi-colon), and the contents will be dumped into the finished doc at that point. @@ -787,7 +795,7 @@ > version string, e.g. <SPAN CLASS="QUOTE" ->"3.1.1"</SPAN +>"3.0.3"</SPAN >. </TD ></TR Index: index.html =================================================================== RCS file: /cvsroot/ijbswa/current/doc/webserver/developer-manual/index.html,v retrieving revision 1.20 retrieving revision 1.21 diff -u -d -r1.20 -r1.21 --- index.html 5 Sep 2002 23:26:21 -0000 1.20 +++ index.html 18 Jul 2006 14:48:53 -0000 1.21 @@ -1,11 +1,11 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <HTML ><HEAD ><TITLE >Privoxy Developer Manual</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK REL="NEXT" TITLE="Introduction" HREF="introduction.html"><LINK @@ -26,7 +26,9 @@ ><H1 CLASS="TITLE" ><A -NAME="AEN2">Privoxy Developer Manual</H1 +NAME="AEN2" +>Privoxy Developer Manual</A +></H1 ><P CLASS="PUBDATE" > <SUB @@ -50,9 +52,11 @@ ><DIV ><DIV CLASS="ABSTRACT" -><A -NAME="AEN9"><P +><P ></P +><A +NAME="AEN9" +></A ><P > The developer manual provides guidance on coding, testing, packaging, > documentation and other issues of importance to those involved with @@ -63,7 +67,7 @@ for anyone who wants to join the team.</P ><P > Please note that this document is constantly evolving. This copy represents - the state at the release of version 3.1.1. + the state at the release of version 3.0.3. You can find the latest version of the this manual at <A HREF="http://www.privoxy.org/developer-manual/" TARGET="_top" @@ -598,12 +602,12 @@ ><DL ><DT >9.1. <A -HREF="copyright.html#AEN1170" +HREF="copyright.html#AEN1177" >License</A ></DT ><DT >9.2. <A -HREF="copyright.html#AEN1186" +HREF="copyright.html#AEN1193" >History</A ></DT ></DL Index: introduction.html =================================================================== RCS file: /cvsroot/ijbswa/current/doc/webserver/developer-manual/introduction.html,v retrieving revision 1.4 retrieving revision 1.5 diff -u -d -r1.4 -r1.5 --- introduction.html 5 Sep 2002 23:26:21 -0000 1.4 +++ introduction.html 18 Jul 2006 14:48:53 -0000 1.5 @@ -1,11 +1,11 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <HTML ><HEAD ><TITLE >Introduction</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK REL="HOME" TITLE="Privoxy Developer Manual" HREF="index.html"><LINK @@ -73,7 +73,9 @@ ><H1 CLASS="SECT1" ><A -NAME="INTRODUCTION">1. Introduction</H1 +NAME="INTRODUCTION" +>1. Introduction</A +></H1 ><P > <SPAN CLASS="APPLICATION" @@ -104,20 +106,19 @@ ><H2 CLASS="SECT2" ><A -NAME="QUICKSTART">1.1. Quickstart to Privoxy Development</H2 +NAME="QUICKSTART" +>1.1. Quickstart to Privoxy Development</A +></H2 ><P -> You'll need an account on <A -HREF="http://sourceforge.net/" -TARGET="_top" ->Sourceforge</A -> to support our - development. Mail your ID to <A +> The first step is to join the <A HREF="mailto:developers@xxxxxxxxxxx" TARGET="_top" ->the list</A -> and wait until a - project manager has added you. - </P +>developer's mailing list</A +>. + You can submit your ideas, or even better patches. Patches are best + submitted to the Sourceforge tracker set up for this purpose, but + can be sent to the list for review too. + </P ><P > You will also need to have a cvs package installed, which will entail having ssh installed as well (which seems to be a requirement of @@ -125,8 +126,9 @@ tools is also going to be important (particularly, autoconf and gmake). </P ><P -> For the time being (read, this section is under construction), please - refer to the extensive comments in the source code. +> For the time being (read, this section is under construction), you can + also refer to the extensive comments in the source code. In fact, + reading the code is recommended in any case. </P ></DIV ></DIV Index: newrelease.html =================================================================== RCS file: /cvsroot/ijbswa/current/doc/webserver/developer-manual/newrelease.html,v retrieving revision 1.13 retrieving revision 1.14 diff -u -d -r1.13 -r1.14 --- newrelease.html 5 Sep 2002 23:26:21 -0000 1.13 +++ newrelease.html 18 Jul 2006 14:48:53 -0000 1.14 @@ -1,11 +1,11 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <HTML ><HEAD ><TITLE >Releasing a New Version</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK REL="HOME" TITLE="Privoxy Developer Manual" HREF="index.html"><LINK @@ -73,7 +73,9 @@ ><H1 CLASS="SECT1" ><A -NAME="NEWRELEASE">6. Releasing a New Version</H1 +NAME="NEWRELEASE" +>6. Releasing a New Version</A +></H1 ><P > When we release versions of <SPAN CLASS="APPLICATION" @@ -108,7 +110,9 @@ ><H2 CLASS="SECT2" ><A -NAME="VERSIONNUMBERS">6.1. Version numbers</H2 +NAME="VERSIONNUMBERS" +>6.1. Version numbers</A +></H2 ><P > First you need to determine which version number the release will have. <SPAN @@ -165,6 +169,29 @@ This ensures that builds from CVS snapshots are easily distinguished from released versions. The point version is reset to zero when the minor changes. </P +><P +> Stable branches work a little differently, since there should be + little to no development happening in such branches. Remember, + only bugfixes, which presumably should have had some testing + before being committed. Stable branches will then have their + version reported as <VAR +CLASS="LITERAL" +>0.0.0</VAR +>, during that period + between releases when changes are being added. This is to denote + that this code is <SPAN +CLASS="emphasis" +><I +CLASS="EMPHASIS" +>not for release</I +></SPAN +>. Then + as the release nears, the version is bumped according: e.g. + <VAR +CLASS="LITERAL" +>3.0.1 -> 0.0.0 -> 3.0.2</VAR +>. + </P ></LI ></UL > @@ -173,18 +200,18 @@ > In summary, the main CVS trunk is the development branch where new features are being worked on for the next stable series. This should almost always be where the most activity takes place. There is always at - least one stable branch from the trunk, e.g now it is 3.0, which is only - used to release stable versions. Once the initial .0 release of the - stable branch has been done, then as a rule, only bugfixes that have had - prior testing should be committed to the stable branch. At that point, it - is mostly <SPAN -CLASS="QUOTE" ->"hands off"</SPAN ->. Once there are enough bugfixes to - justify a new release, the version of this branch is again incremented - Example: 3.0.0 -> 3.0.1 -> 3.0.2, etc are all stable releases from within - the stable branch. 3.1.x is currently the main trunk, and where work on - 3.2.x is taking place. If any questions, please post to the devel list + least one stable branch from the trunk, e.g now it is + <VAR +CLASS="LITERAL" +>3.0</VAR +>, which is only used to release stable versions. + Once the initial *.0 release of the stable branch has been done, then as a + rule, only bugfixes that have had prior testing should be committed to + the stable branch. Once there are enough bugfixes to justify a new + release, the version of this branch is again incremented Example: 3.0.0 + -> 3.0.1 -> 3.0.2, etc are all stable releases from within the stable + branch. 3.1.x is currently the main trunk, and where work on 3.2.x is + taking place. If any questions, please post to the devel list <SPAN CLASS="emphasis" ><I @@ -192,7 +219,23 @@ >before</I ></SPAN > committing to a stable branch! - + </P +><P +> Developers should remember too that if they commit a bugfix to the stable + branch, this will more than likely require a separate submission to the + main trunk, since these are separate development trees within CVS. If you + are working on both, then this would require at least two separate check + outs (i.e main trunk, <SPAN +CLASS="emphasis" +><I +CLASS="EMPHASIS" +>and</I +></SPAN +> the stable release branch, + which is <VAR +CLASS="LITERAL" +>v_3_0_branch</VAR +> at the moment). </P ></DIV ><DIV @@ -200,7 +243,9 @@ ><H2 CLASS="SECT2" ><A -NAME="BEFORERELEASE">6.2. Before the Release: Freeze</H2 +NAME="BEFORERELEASE" +>6.2. Before the Release: Freeze</A +></H2 ><P > The following <SPAN CLASS="emphasis" @@ -298,9 +343,9 @@ > link from the main page since we need to keep manuals for various versions available). The CGI pages will link to something like - <TT + <VAR CLASS="LITERAL" ->http://privoxy.org/$(VERSION)/user-manual/</TT +>http://privoxy.org/$(VERSION)/user-manual/</VAR >. This will need to be updated for each new release. There is no Makefile target for this at this time!!! It needs to be done manually. @@ -383,7 +428,9 @@ ><H2 CLASS="SECT2" ><A -NAME="THERELEASE">6.3. Building and Releasing the Packages</H2 +NAME="THERELEASE" +>6.3. Building and Releasing the Packages</A +></H2 ><P > Now the individual packages can be built and released. Note that for GPL reasons the first package to be released is always the source tarball. @@ -446,7 +493,9 @@ ><H3 CLASS="SECT3" ><A -NAME="PACK-GUIDELINES">6.3.1. Note on Privoxy Packaging</H3 +NAME="PACK-GUIDELINES" +>6.3.1. Note on Privoxy Packaging</A +></H3 ><P > Please keep these general guidelines in mind when putting together your package. These apply to <SPAN @@ -692,7 +741,9 @@ ><H3 CLASS="SECT3" ><A -NAME="NEWRELEASE-TARBALL">6.3.2. Source Tarball</H3 +NAME="NEWRELEASE-TARBALL" +>6.3.2. Source Tarball</A +></H3 ><P > First, <SPAN CLASS="emphasis" @@ -770,13 +821,13 @@ ><H3 CLASS="SECT3" ><A -NAME="NEWRELEASE-RPM">6.3.3. SuSE, Conectiva or Red Hat RPM</H3 +NAME="NEWRELEASE-RPM" +>6.3.3. SuSE, Conectiva or Red Hat RPM</A +></H3 ><P -> In following text, replace <TT +> In following text, replace <VAR CLASS="REPLACEABLE" -><I ->dist</I -></TT +>dist</VAR > with either <SPAN CLASS="QUOTE" @@ -802,11 +853,9 @@ now examine the file <TT CLASS="FILENAME" >privoxy-</TT -><TT +><VAR CLASS="REPLACEABLE" -><I ->dist</I -></TT +>dist</VAR ><TT CLASS="FILENAME" >.spec</TT @@ -814,11 +863,9 @@ and make sure that the version information and the RPM release number are correct. The RPM release numbers for each version start at one. Hence it must be reset to one if this is the first RPM for - <TT + <VAR CLASS="REPLACEABLE" -><I ->dist</I -></TT +>dist</VAR > which is built from version X.Y.Z. Check the <A @@ -860,11 +907,9 @@ ><TD ><PRE CLASS="PROGRAMLISTING" -> make <TT +> make <VAR CLASS="REPLACEABLE" -><I ->dist</I -></TT +>dist</VAR >-dist</PRE ></TD ></TR @@ -883,16 +928,12 @@ ><TD ><PRE CLASS="PROGRAMLISTING" -> make <TT +> make <VAR CLASS="REPLACEABLE" -><I ->dist</I -></TT ->-upload <TT +>dist</VAR +>-upload <VAR CLASS="REPLACEABLE" -><I ->rpm_packagerev</I -></TT +>rpm_packagerev</VAR ></PRE ></TD ></TR @@ -900,11 +941,9 @@ > </P ><P -> where <TT +> where <VAR CLASS="REPLACEABLE" -><I ->rpm_packagerev</I -></TT +>rpm_packagerev</VAR > is the RPM release number as determined above. Go to the displayed URL and release the file publicly on Sourceforge. @@ -916,7 +955,9 @@ ><H3 CLASS="SECT3" ><A -NAME="NEWRELEASE-OS2">6.3.4. OS/2</H3 +NAME="NEWRELEASE-OS2" +>6.3.4. OS/2</A +></H3 ><P > First, <SPAN CLASS="emphasis" @@ -1051,7 +1092,9 @@ ><H3 CLASS="SECT3" ><A -NAME="NEWRELEASE-SOLARIS">6.3.5. Solaris</H3 +NAME="NEWRELEASE-SOLARIS" +>6.3.5. Solaris</A +></H3 ><P > Login to Sourceforge's compilefarm via ssh: </P @@ -1132,7 +1175,9 @@ ><H3 CLASS="SECT3" ><A -NAME="NEWRELEASE-WINDOWS">6.3.6. Windows</H3 +NAME="NEWRELEASE-WINDOWS" +>6.3.6. Windows</A +></H3 ><P > You should ensure you have the latest version of Cygwin (from <A @@ -1210,7 +1255,9 @@ ><H3 CLASS="SECT3" ><A -NAME="NEWRELEASE-DEBIAN">6.3.7. Debian</H3 +NAME="NEWRELEASE-DEBIAN" +>6.3.7. Debian</A +></H3 ><P > First, <SPAN CLASS="emphasis" @@ -1236,7 +1283,7 @@ ><TD ><PRE CLASS="PROGRAMLISTING" -> debchange -v 3.1.1-alpha-1 "New upstream version"</PRE +> debchange -v 3.0.3-stable-1 "New upstream version"</PRE ></TD ></TR ></TABLE @@ -1264,7 +1311,7 @@ > This will create <TT CLASS="FILENAME" ->../privoxy_3.1.1-alpha-1_i386.deb</TT +>../privoxy_3.0.3-stable-1_i386.deb</TT > which can be uploaded. To upload the package to Sourceforge, simply issue @@ -1290,7 +1337,9 @@ ><H3 CLASS="SECT3" ><A -NAME="NEWRELEASE-MACOSX">6.3.8. Mac OSX</H3 +NAME="NEWRELEASE-MACOSX" +>6.3.8. Mac OSX</A +></H3 ><P > First, <SPAN CLASS="emphasis" @@ -1396,7 +1445,9 @@ ><H3 CLASS="SECT3" ><A -NAME="NEWRELEASE-FREEBSD">6.3.9. FreeBSD</H3 +NAME="NEWRELEASE-FREEBSD" +>6.3.9. FreeBSD</A +></H3 ><P > Login to Sourceforge's compile-farm via ssh: </P @@ -1477,7 +1528,9 @@ ><H3 CLASS="SECT3" ><A -NAME="NEWRELEASE-HPUX">6.3.10. HP-UX 11</H3 +NAME="NEWRELEASE-HPUX" +>6.3.10. HP-UX 11</A +></H3 ><P > First, <SPAN CLASS="emphasis" @@ -1514,7 +1567,9 @@ ><H3 CLASS="SECT3" ><A -NAME="NEWRELEASE-AMIGA">6.3.11. Amiga OS</H3 +NAME="NEWRELEASE-AMIGA" +>6.3.11. Amiga OS</A +></H3 ><P > First, <SPAN CLASS="emphasis" @@ -1551,7 +1606,9 @@ ><H3 CLASS="SECT3" ><A -NAME="NEWRELEASE-AIX">6.3.12. AIX</H3 +NAME="NEWRELEASE-AIX" +>6.3.12. AIX</A +></H3 ><P > Login to Sourceforge's compilefarm via ssh: </P @@ -1633,7 +1690,9 @@ ><H2 CLASS="SECT2" ><A -NAME="RELEASING">6.4. Uploading and Releasing Your Package</H2 +NAME="RELEASING" +>6.4. Uploading and Releasing Your Package</A +></H2 ><P > After the package is ready, it is time to upload it to SourceForge, and go through the release steps. The upload @@ -1654,17 +1713,17 @@ ></LI ><LI ><P -> user: <TT +> user: <VAR CLASS="LITERAL" ->anonymous</TT +>anonymous</VAR > </P ></LI ><LI ><P -> password: <TT +> password: <VAR CLASS="LITERAL" ->ijbswa-developers@xxxxxxxxxxxxxxxxxxxxx</TT +>ijbswa-developers@xxxxxxxxxxxxxxxxxxxxx</VAR > </P ></LI @@ -1684,19 +1743,19 @@ >http://sourceforge.net/project/admin/editpackages.php?group_id=11118</A >, making sure you are logged in. Find your target platform in the - second column, and click <TT + second column, and click <VAR CLASS="LITERAL" ->Add Release</TT +>Add Release</VAR >. You will then need to create a new release for your package, using the format - of <TT + of <VAR CLASS="LITERAL" ->$VERSION ($CODE_STATUS)</TT +>$VERSION ($CODE_STATUS)</VAR >, e.g. <SPAN CLASS="emphasis" ><I CLASS="EMPHASIS" ->3.1.1 +>3.0.3 (beta)</I ></SPAN >. @@ -1727,13 +1786,13 @@ </P ><P > If you have made errors, or need to make changes, you can go through - essentially the same steps, but select <TT + essentially the same steps, but select <VAR CLASS="LITERAL" ->Edit Release</TT +>Edit Release</VAR >, - instead of <TT + instead of <VAR CLASS="LITERAL" ->Add Release</TT +>Add Release</VAR >. </P ></DIV @@ -1742,7 +1801,9 @@ ><H2 CLASS="SECT2" ><A -NAME="AFTERRELEASE">6.5. After the Release</H2 +NAME="AFTERRELEASE" +>6.5. After the Release</A +></H2 ><P > When all (or: most of the) packages have been uploaded and made > available, send an email to the <A Index: seealso.html =================================================================== RCS file: /cvsroot/ijbswa/current/doc/webserver/developer-manual/seealso.html,v retrieving revision 1.9 retrieving revision 1.10 diff -u -d -r1.9 -r1.10 --- seealso.html 5 Sep 2002 23:26:21 -0000 1.9 +++ seealso.html 18 Jul 2006 14:48:53 -0000 1.10 @@ -1,11 +1,11 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <HTML ><HEAD ><TITLE >See also</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK REL="HOME" TITLE="Privoxy Developer Manual" HREF="index.html"><LINK @@ -66,7 +66,9 @@ ><H1 CLASS="SECT1" ><A -NAME="SEEALSO">10. See also</H1 +NAME="SEEALSO" +>10. See also</A +></H1 ><P > Other references and sites of interest to <SPAN CLASS="APPLICATION" Index: testing.html =================================================================== RCS file: /cvsroot/ijbswa/current/doc/webserver/developer-manual/testing.html,v retrieving revision 1.5 retrieving revision 1.6 diff -u -d -r1.5 -r1.6 --- testing.html 5 Sep 2002 23:26:21 -0000 1.5 +++ testing.html 18 Jul 2006 14:48:53 -0000 1.6 @@ -1,11 +1,11 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <HTML ><HEAD ><TITLE >Testing Guidelines</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK REL="HOME" TITLE="Privoxy Developer Manual" HREF="index.html"><LINK @@ -73,7 +73,9 @@ ><H1 CLASS="SECT1" ><A -NAME="TESTING">5. Testing Guidelines</H1 +NAME="TESTING" +>5. Testing Guidelines</A +></H1 ><P >To be filled.</P ><DIV @@ -81,7 +83,9 @@ ><H2 CLASS="SECT2" ><A -NAME="TESTING-PLAN">5.1. Testplan for releases</H2 +NAME="TESTING-PLAN" +>5.1. Testplan for releases</A +></H2 ><P > Explain release numbers. major, minor. developer releases. etc. @@ -154,7 +158,9 @@ ><H2 CLASS="SECT2" ><A -NAME="TESTING-REPORT">5.2. Test reports</H2 +NAME="TESTING-REPORT" +>5.2. Test reports</A +></H2 ><P >Please submit test reports only with the <A HREF="http://sourceforge.net/tracker/?func=add&group_id=11118&atid=395005" Index: webserver-update.html =================================================================== RCS file: /cvsroot/ijbswa/current/doc/webserver/developer-manual/webserver-update.html,v retrieving revision 1.4 retrieving revision 1.5 diff -u -d -r1.4 -r1.5 --- webserver-update.html 5 Sep 2002 23:26:21 -0000 1.4 +++ webserver-update.html 18 Jul 2006 14:48:53 -0000 1.5 @@ -1,11 +1,11 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <HTML ><HEAD ><TITLE >Update the Webserver</TITLE ><META NAME="GENERATOR" -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ -"><LINK +CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK REL="HOME" TITLE="Privoxy Developer Manual" HREF="index.html"><LINK @@ -73,7 +73,9 @@ ><H1 CLASS="SECT1" ><A -NAME="WEBSERVER-UPDATE">7. Update the Webserver</H1 +NAME="WEBSERVER-UPDATE" +>7. Update the Webserver</A +></H1 ><P > The webserver should be updated at least with each stable release. When updating, please follow these steps to make sure that no broken links, ------------------------------------------------------------------------- Take Surveys. Earn Cash. Influence the Future of IT Join SourceForge.net's Techsay panel and you'll get the chance to share your opinions on IT & business topics through brief surveys -- and earn cash http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV_______________________________________________ ijbswa-commits mailing list ijbswa-commits@xxxxxxxxxxxxxxxxxxxxx https://lists.sourceforge.net/lists/listinfo/ijbswa-commits |
|
| <Prev in Thread] | Current Thread | [Next in Thread> |
|---|---|---|
| News | FAQ | advertise |