[dpdk-dev] [PATCH] doc: add field widths to prog guide glossary

[dpdk-dev] [PATCH] doc: add field widths to prog guide glossary

[John McNamara]

Added explicit field widths to Programmer's Guide
Glossary table to control the PDF output. Previously
the table overflowed the right margin.

This doesn't affect the Html output.

Also, added bold format to colunm headers for clarity.

Signed-off-by: John McNamara <john.mcnamara@intel.com>
---
 doc/guides/prog_guide/glossary.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/doc/guides/prog_guide/glossary.rst b/doc/guides/prog_guide/glossary.rst
index 913946d..657248c 100644
--- a/doc/guides/prog_guide/glossary.rst
+++ b/doc/guides/prog_guide/glossary.rst
@@ -31,8 +31,10 @@
 Glossary
 ========
 
+.. tabularcolumns:: |p{4cm}|p{11cm}|
+
 ===============                   =========================================================================================================
-Term                              Definition
+**Term**                          **Definition**
 ===============                   =========================================================================================================
 ACL                               Access Control List
 
-- 
1.8.1.4

Re: [dpdk-dev] [PATCH] doc: add field widths to prog guide glossary

[Thomas Monjalon]

2015-04-10 15:20, John McNamara:
> Added explicit field widths to Programmer's Guide
> Glossary table to control the PDF output. Previously
> the table overflowed the right margin.

Long tables should be avoided in RST as they are not easy to read or update.
Why not using definition lists?
	http://docutils.sourceforge.net/docs/user/rst/quickref.html#definition-lists

Re: [dpdk-dev] [PATCH] doc: add field widths to prog guide glossary

[Mcnamara, John]

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Friday, April 10, 2015 3:34 PM
> To: Mcnamara, John
> Cc: dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH] doc: add field widths to prog guide
> glossary
> 
> Long tables should be avoided in RST as they are not easy to read or
> update.
> Why not using definition lists?
> 	http://docutils.sourceforge.net/docs/user/rst/quickref.html#definiti
> on-lists

Hi Thomas,

That is a better suggestion. I'll reformat the table as a definition list and resubmit.

John