[Privoxy-devel] developer docs

[Ian Silvester]

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. 

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) 

Ian


My PGP public key[http://silvester.org.uk/IanSilvesterPGPPublicKey.asc]

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