[Privoxy-devel] tidy -indent -wrap can break <pre> formatting

[Fabian Keil]

Lee <ler762 at gmail.com> wrote:

> On 3/13/18, Fabian Keil <fk at fabiankeil.de> wrote:
> > Lee <ler762 at gmail.com> wrote:
> >  
> >> I'm trying to add a FAQ entry and I just can't get the formatting
> >> right.  Turns out the problem is with tidy indent + wrap: short lines
> >> don't get screwed up, long lines are split after <pre> and indented  
> >
> > This is a know issue. I believe it started to occur
> > after the switch to tidy 5.
> >  
> >> Anyone have a problem with changing the line in GNUmakefile.in
> >> TIDY       = tidy -modify -indent -wrap 78 --tidy-mark no
> >> to -wrap 120  
> >
> > I don't have a problem with this work around but obviously
> > would prefer a proper fix.
> >  
> >> And a related question - what's your default window size?  I use
> >> 132x24 Why limit line lengths to less than 80 characters?  
> >
> > I use various Window sizes. 78 is a common limit that
> > is expected to works for most people.  
> 
> I'd be surprised if 120 didn't work for most people, but that's a
> different discussion.
> 
> How do you want me doing branches & commits?
> 
> I started out creating a 'faq' branch, added the new faq entry & tried
> various things to get the formatting right.  I can't figure out a
> work-around other than changing the tidy line wrap to something
> larger, so created a 'tidy' branch off the 'faq' branch and modify
> GNUmakefile.in
> 
> I've been burned with make not actually redoing all the modified
> components, so make clean
> make distclean
> ./configure xxx  && make && make dok
> 
> come back after making a sandwich, check out the generated html and it
> looks good to me so I'm ready to start commiting things
> 
> What to do now?
> 
> Push the changes in both branches up to git.privoxy.org?
> -- I'm sure it'll show up as two seperate commits that way but there's
> nothing to indicate they're related
> 
> Push the 'tidy' branch change up to 'faq' & then push the 'faq'
> changes up to git.privoxy.org?
> -- I'll see two different commits but will anyone else?
> -- it's clear that the proper formatting of the new faq entry depends
> on the tidy line wrap change

Clean up your commits (if necessary), rebase master
on top of your local branches (or cherry-pick the
commits to master) and push master.

This has the advantage that the commit history
remains clean (no "faq" and "tidy" branches on
the remote end) and can be easily audited without
having to follow branches.

> and then what to do with all the generated html files?

Commit and push them to master as well.

> make web-faq  (which seems to only update sourceforge) or ???

You can do that, too.

Pushing documentation to privoxy.org currently isn't possible
with the Makefile yet. I currently use local functions for this.

Fabian
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 833 bytes
Desc: OpenPGP digital signature
URL: <https://lists.privoxy.org/pipermail/privoxy-devel/attachments/20180314/5c9a2fb5/attachment.bin>