Re: [dpdk-dev] [PATCH 2/6] qede: add documentation

["Mcnamara, John" <john.mcnamara@intel.com>]

> -----Original Message-----
> From: Harish Patil [mailto:harish.patil@qlogic.com]
> Sent: Wednesday, February 24, 2016 7:18 AM
> To: Mcnamara, John <john.mcnamara@intel.com>; dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH 2/6] qede: add documentation
> 
> >>
> >
> >Again, try wrap the code/console section at 80 chars in some way that
> >still maintains the meaning. Maybe something like the following (with a
> >note to say that the text has been wrapped for clarity):
> >
> > ...
> 
> These are the actual output from the console that was pasted, that’s why
> they are more than 80 chars.
> Sure, will take care of that as you mentioned.

Hi,

I understand that the text is actual output but if you generate the pdf
documentation you will see that the fixed width text goes off the page.
So some sort of compromise is required and wrapping the text is what
is usually done in the DPDK docs.

Since it may be confusing to the end user if they see different output
in the docs and on the console it is probably worth adding a line in the
preceding paragraph to say something like "(text wrapped for clarity)".

John.
--