[Privoxy-devel] developer docs

[Lee]

On 4/22/18, Ian Silvester <iansilvester at fastmail.fm> wrote:
> My take is add a section in dev doc after 'coding guidelines'  and before
> 'releasing a new version' named as you suggested, and simply add text saying
> "Building Privoxy from source is explained in the User Manual" and link that
> text to the existing section in the User Manual. Your new content then goes
> in a new subsection within the 'building from source' section of the user
> manual.

just to be clear - you'd keep the hierarchy
- Installation
- - Building from Source
in the user manual?  (which I'm fine with)

> In this way we maintain the pretence that our users are all open source
> adherents that build from  source (I guess a certain percentage still are
> ;o)

I like the way you think :)   But my guess is that it's worse than the
3:1 ratio shown on SF:

2016-07-01 to 2018-04-22
source code:  13,021 downloads
win binary :  35,030 downloads (plus another 4,577 for the .zip file)

https://sourceforge.net/projects/ijbswa/files/Sources/3.0.26%20%28stable%29/privoxy-3.0.26-stable-src.tar.gz/stats/timeline?dates=2016-06-23+to+2018-04-22

https://sourceforge.net/projects/ijbswa/files/Win32/3.0.26%20%28stable%29/privoxy_setup_3.0.26.exe/stats/timeline?dates=2016-06-23+to+2018-04-22

Lee



> On Sun, 22 Apr 2018, at 15:50, Lee wrote:
>> On 4/22/18, Fabian Keil <fk at fabiankeil.de> wrote:
>> > Lee <ler762 at gmail.com> wrote:
>> >
>> >> I'd like to add a section in the developer manual for setting up the
>> >> build environment in windows.  Anyone have a problem with adding a
>> >> section before
>> >>   5. Testing Guidelines
>> >> for what all needs to be done so that one can build privoxy?
>> >
>> > We already have a "Building from Source" section in the user manual.
>>
>> If a project has a user guide and a developer guide, I wouldn't look
>> for a 'how2 build it' in the user guide, and certainly not under
>> Installation.  How about moving 'Building from Source' to the
>> developer manual - right after 'Coding Guidelines'?
>>
>> > Maybe it should be improved and referenced from the developer manual
>> > instead of duplicating the content.
>>
>> Link to it from where in the dev manual?
>>
>> There is no 'building privoxy', 'building from source' or anything
>> like that in the dev. docs.
>>
>> The closest thing is under 'Releasing a New Version' and if someone is
>> releasing a new version I very much hope they've already got their
>> build environment set up & tested.
>>
>> Oh the other hand, this isn't worth arguing about, so I'll go with
>> whatever everyone else prefers:
>> - move the 'Building from Source' section from the user manual to the
>> developer manual and add a 'Windows' section underneath
>> - add a 'Windows' section underneath the 'Building from Source'
>> section in the user manual and add a link (links?) <where?> in the dev
>> manual to the user manual.
>>
>> Thanks
>> Lee
>> _______________________________________________
>> Privoxy-devel mailing list
>> Privoxy-devel at lists.privoxy.org
>> https://lists.privoxy.org/mailman/listinfo/privoxy-devel
> _______________________________________________
> Privoxy-devel mailing list
> Privoxy-devel at lists.privoxy.org
> https://lists.privoxy.org/mailman/listinfo/privoxy-devel
>