Re: Doc: CG remove ugly bars at end of lines in doc (issue4641074)

[pkx166h]

Reviewers: Graham Percival,

Message:
2nd Draft. Thanks for the comments Graham.


http://codereview.appspot.com/4641074/diff/1/Documentation/contributor/build-notes.itexi
File Documentation/contributor/build-notes.itexi (right):

http://codereview.appspot.com/4641074/diff/1/Documentation/contributor/build-notes.itexi#newcode445
Documentation/contributor/build-notes.itexi:445: LOOP=+$(foreach i,
$(SUBDIRS), $(MAKE) PACKAGE=$(PACKAGE) \
On 2011/06/25 16:12:02, Graham Percival wrote:
> I don't think you should change any example showing exact lines from
files.

> Make this @smallexample, but if that still exceeds the line width,
leave it
> alone.

Done.

http://codereview.appspot.com/4641074/diff/1/Documentation/contributor/build-notes.itexi#newcode589
Documentation/contributor/build-notes.itexi:589: Found prerequisite
`out-www/version.itexi' as VPATH \
On 2011/06/25 16:12:02, Graham Percival wrote:
> ditto

Done.

http://codereview.appspot.com/4641074/diff/1/Documentation/contributor/build-notes.itexi#newcode614
Documentation/contributor/build-notes.itexi:614: $(outdir)/%.texi:
$(outdir)/%.tely $(outdir)/version.itexi \
On 2011/06/25 16:12:02, Graham Percival wrote:
> ditto

Done.

http://codereview.appspot.com/4641074/diff/1/Documentation/contributor/build-notes.itexi#newcode627
Documentation/contributor/build-notes.itexi:627: $(outdir)/%.texi:
$(outdir)/%.tely $(outdir)/version.itexi \
On 2011/06/25 16:12:02, Graham Percival wrote:
> ditto

Done.

http://codereview.appspot.com/4641074/diff/1/Documentation/contributor/programming-work.itexi
File Documentation/contributor/programming-work.itexi (right):

http://codereview.appspot.com/4641074/diff/1/Documentation/contributor/programming-work.itexi#newcode405
Documentation/contributor/programming-work.itexi:405: set
statusline=%F%m%r%h%w\ %{&ff}\ %Y\ [ASCII=\%03.3b]\ /
On 2011/06/25 16:12:02, Graham Percival wrote:
> I'm not certain if .vimrc files allow \ continuations.  Could you
either look it
> up, or remove this if you're at all uncertain?

Took 10 mins on Google, it wasn't that clear to me. So I've reverted it
and use @smallexample

Description:
Doc: CG remove ugly bars at end of lines in doc

Caused by 'too long' lines in tely/texi files.

Using a variety of methods to break lines that are not normally broken

use @smallexample or ' \ ' in the case of long CLI syntax

Tracker issue 1691

Some minor text edits to also accommodate the lines lengths.
No new information added, some URLs that I couldn't shrink down
enough have been edited so that the information is still correct
but there are less 'arguments' in the URL itself (i.e. for filtering
on google.code.

Please review this at http://codereview.appspot.com/4641074/

Affected files:
  M Documentation/contributor/administration.itexi
  M Documentation/contributor/build-notes.itexi
  M Documentation/contributor/doc-work.itexi
  M Documentation/contributor/introduction.itexi
  M Documentation/contributor/issues.itexi
  M Documentation/contributor/lsr-work.itexi
  M Documentation/contributor/programming-work.itexi
  M Documentation/contributor/regressions.itexi
  M Documentation/contributor/release-work.itexi
  M Documentation/contributor/source-code.itexi
  M Documentation/contributor/website-work.itexi