[dpdk-dev] [PATCH 2/3] docs: adjust line lengths in FreeBSD GSG rst files

Thomas Monjalon thomas.monjalon at 6wind.com
Wed Dec 3 14:23:44 CET 2014


2014-11-24 15:48, Bruce Richardson:
> The FreeBSD GSG rst files had very inconsistent line lengths for text
> within paragraph blocks. Sometimes a line would be very short, while often
> lines would be quite long.
> This patch adjusts the formatting of the rst files so that lines break
> at approx the 80-character mark, as is standard in the DPDK source code.

I'm not sure we should be strict with line lengths in the doc.
The most important thing is to limit the wrapping impact of future patches.
Starting a new sentence at the beginning of the line is often a good way
to keep context lines unchanged when updating only one sentence.
Don't forget that a carriage return in rst has no impact on generated doc.

-- 
Thomas


More information about the dev mailing list