Re: [PATCH] Remove trailing whitespaces from documentation

From: Stephen Frost <sfrost(at)snowman(dot)net>
To: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
Cc: Vladimir Rusinov <vrusinov(at)google(dot)com>, PostgreSQL-development <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: [PATCH] Remove trailing whitespaces from documentation
Date: 2016-12-14 17:30:28
Message-ID: 20161214173028.GP23417@tamriel.snowman.net
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

* Tom Lane (tgl(at)sss(dot)pgh(dot)pa(dot)us) wrote:
> Stephen Frost <sfrost(at)snowman(dot)net> writes:
> > If we do want to change that, perhaps we should also change psql to not
> > output the trailing whitespace in the first place..?
>
> Yeah, maybe. I seem to recall having looked at that a long time ago
> and deciding that it wasn't worth the trouble, but the code involved
> has probably been restructured since then, so maybe it'd be easier now.
>
> Of course, that would also create a back-patch breakpoint for every
> single regression test expected-file, which is doubling down on the
> PITA factor in a rather major way.

I'm not convinced that any of this is worth the effort. Wouldn't it be
possible, if we are moving the docs to XML, to mark the examples in the
docs in a way similar to LaTeX's 'verbatim' and allow trailing
whitespace there?

We wouldn't be able to use git to complain about trailing whitespace in
the docs then, I don't think, but perhaps we could detect invalid
trailing whitespace when building the docs and complain then. I expect
that most of us build the docs before we commit anything to them anyway.

Thanks!

Stephen

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Vladimir Rusinov 2016-12-14 17:37:02 Re: [PATCH] Remove trailing whitespaces from documentation
Previous Message Vladimir Rusinov 2016-12-14 17:25:49 Re: [PATCH] Remove trailing whitespaces from documentation