Re: new release documentation

On 1/6/13, Fabian Keil <[email protected]> wrote:
> Lee <[email protected]> wrote:
>
>> On 1/5/13, Lee <[email protected]> wrote:
>> > The developer manual builds OK for me and the user manual looks like
>> > it's just (mainly?) missing a few "</sect3>" lines.
>
> Apparently even the syntax errors don't always "work" cross-platform ...

My docbook software is less forgiving than yours?

>> > I'll start working on the fixes unless someone else would rather do it.
>>
>> Well.. that was easy!  Copyright date needs to be bumped, Ian isn't
>> listed as a developer and 3.0.20 isn't marked as beta are the obvious
>> things that need fixing.
>
> Are you referring to the "Current Privoxy Team" section?

Yes, but it's my mistake.  I was looking at the privoxy man page on my
system and it hadn't been regenerated.  What I get now for the man
page is
man2html: bad invocation

*sigh*

doc/webserver/user-manual/copyright.html looks good.

>
> I agree that Ian is a developer, but so are the rest of the
> listed team members including yourself.
>
> In my opinion it would make more sense to simply not explicitly
> declare David and myself developers to prevent any confusion.
>
> Another option would be to invent fancy titles for everyone ...
>
>> Suggestions on how to share the results welcome.  I created a .zip
>> file of current/doc/webserver but at 807KB it's probably too large to
>> email as an attachment.
>
> In general you can simply push documentation changes to CVS
> (which I just did for the less problematic HTML parts), preferably
> after checking the diff to make sure there aren't too many gratuitous
> white-space changes.

I think I better not do that -- at least until I can get my output
closer to yours.
see below

> Theoretically the dok-tidy target should prevent this for the
> HTML parts, but I don't know if the output is stable across
> platforms.

Is 'make dok-tidy' a separate step one has to do manually?
I do a 'make dok' and it
- doesn't run tidy on anything
- doesn't run man2html even though the previous invocation failed
- says "Documentation created." at the end

I get  lots of cvs merge errors for things in
/cvsroot/ijbswa/current/doc/webserver and my html source clearly has
not been run through tidy:

RCS file: /cvsroot/ijbswa/current/doc/webserver/index.html,v
retrieving revision 1.63
retrieving revision 1.64
Merging differences between 1.63 and 1.64 into index.html
rcsmerge: warning: conflicts during merge
cvs checkout: conflicts found in current/doc/webserver/index.html

RCS file: /cvsroot/ijbswa/current/doc/webserver/developer-manual/copyright.html,v
retrieving revision 1.37
retrieving revision 1.38
Merging differences between 1.37 and 1.38 into copyright.html
rcsmerge: warning: conflicts during merge
cvs checkout: conflicts found in
current/doc/webserver/developer-manual/copyright.html

RCS file: /cvsroot/ijbswa/current/doc/webserver/developer-manual/newrelease.html,v
retrieving revision 1.45
retrieving revision 1.46
Merging differences between 1.45 and 1.46 into newrelease.html
rcsmerge: warning: conflicts during merge
cvs checkout: conflicts found in
current/doc/webserver/developer-manual/newrelease.html

RCS file: /cvsroot/ijbswa/current/doc/webserver/faq/copyright.html,v
retrieving revision 1.54
retrieving revision 1.55
Merging differences between 1.54 and 1.55 into copyright.html
rcsmerge: warning: conflicts during merge
cvs checkout: conflicts found in current/doc/webserver/faq/copyright.html

RCS file: /cvsroot/ijbswa/current/doc/webserver/user-manual/actions-file.html,v
retrieving revision 1.70
retrieving revision 1.71
Merging differences between 1.70 and 1.71 into actions-file.html
rcsmerge: warning: conflicts during merge
cvs checkout: conflicts found in
current/doc/webserver/user-manual/actions-file.html

RCS file: /cvsroot/ijbswa/current/doc/webserver/user-manual/appendix.html,v
retrieving revision 1.81
retrieving revision 1.82
Merging differences between 1.81 and 1.82 into appendix.html
rcsmerge: warning: conflicts during merge
cvs checkout: conflicts found in current/doc/webserver/user-manual/appendix.html

RCS file: /cvsroot/ijbswa/current/doc/webserver/user-manual/config.html,v
retrieving revision 1.54
retrieving revision 1.55
Merging differences between 1.54 and 1.55 into config.html
rcsmerge: warning: conflicts during merge
cvs checkout: conflicts found in current/doc/webserver/user-manual/config.html

RCS file: /cvsroot/ijbswa/current/doc/webserver/user-manual/copyright.html,v
retrieving revision 1.80
retrieving revision 1.81
Merging differences between 1.80 and 1.81 into copyright.html
rcsmerge: warning: conflicts during merge
cvs checkout: conflicts found in
current/doc/webserver/user-manual/copyright.html

RCS file: /cvsroot/ijbswa/current/doc/webserver/user-manual/filter-file.html,v
retrieving revision 1.69
retrieving revision 1.70
Merging differences between 1.69 and 1.70 into filter-file.html
rcsmerge: warning: conflicts during merge
cvs checkout: conflicts found in
current/doc/webserver/user-manual/filter-file.html

RCS file: /cvsroot/ijbswa/current/doc/webserver/user-manual/index.html,v
retrieving revision 1.86
retrieving revision 1.87
Merging differences between 1.86 and 1.87 into index.html
rcsmerge: warning: conflicts during merge
cvs checkout: conflicts found in current/doc/webserver/user-manual/index.html

RCS file: /cvsroot/ijbswa/current/doc/webserver/user-manual/introduction.html,v
retrieving revision 1.52
retrieving revision 1.53
Merging differences between 1.52 and 1.53 into introduction.html
rcsmerge: warning: conflicts during merge
cvs checkout: conflicts found in
current/doc/webserver/user-manual/introduction.html


> In my experience generating the HTML parts causes usually less
> problems than the text parts (config, README ...) which at least
> on my system always need manual intervention afterwards.
>
> If the HTML generation fails you usually get some kind of error,
> but the text generation just silently produces garbage.

Yes, a lot of garbage in at least config.new on my system, but it
seems to be messing up just the long lines.

Oh well..  it looks like I can help with updating sgml files but not
with generating the final documentation :(

Lee

------------------------------------------------------------------------------
Master Visual Studio, SharePoint, SQL, ASP.NET, C# 2012, HTML5, CSS,
MVC, Windows 8 Apps, JavaScript and much more. Keep your skills current
with LearnDevNow - 3,200 step-by-step video tutorials by Microsoft
MVPs and experts. ON SALE this month only -- learn more at:
http://p.sf.net/sfu/learnmore_123012