Re: [Fuego] [PATCH] Docs: Convert tbwiki pages into .rst files
"Bird, Tim" <[email protected]> Wed, 2 Dec 2020 21:45:46 +0000
| Newsgroups | dev.linux.lists.fuego |
|---|---|
| Message-ID | <BYAPR13MB2503A5AAA8BC9381763DB450FDF30@BYAPR13MB2503.namprd13.prod.outlook.com> |
I committed this patch, and updated a lot of content in the Fuego_directories and Glossary files. I mention one outstanding issue is below... > -----Original Message----- > From: Pooja <[email protected]> > > From: Pooja More <[email protected]> > > Following pages are converted: > Coding_style.rst > Fuego_directories.rst > Glossary.rst > > Signed-off-by: Pooja More <[email protected]> > --- > docs/rst_src/Coding_style.rst | 111 +++++++++++++++ > docs/rst_src/Fuego_directories.rst | 161 +++++++++++++++++++++ > docs/rst_src/Glossary.rst | 277 +++++++++++++++++++++++++++++++++++++ > 3 files changed, 549 insertions(+) > create mode 100644 docs/rst_src/Coding_style.rst > create mode 100644 docs/rst_src/Fuego_directories.rst > create mode 100644 docs/rst_src/Glossary.rst > > diff --git a/docs/rst_src/Coding_style.rst b/docs/rst_src/Coding_style.rst ... > diff --git a/docs/rst_src/Glossary.rst b/docs/rst_src/Glossary.rst > new file mode 100644 > index 0000000..61bb3d7 > --- /dev/null > +++ b/docs/rst_src/Glossary.rst > @@ -0,0 +1,277 @@ > +############## > +Glossary > +############## > + > +Here is a glossary of terms used in this wiki: > + > +Here is a short table that relates a few Jenkins terms to Fuego terms: > + > +show_sort_link=0 > + > +show_edit_links=0 > + > +Table: > + > ++--------------+------------------+------------------------------------------------------------------------------------------------+ > +| Jenkins term |Fuego term |Description | > ++==============+==================+================================================================================== > ==============+ > +|slave |''none'' |this is a long-running jenkins process, that executes jobs. It is usually (?) assigned to a | > +| | |particular node | > ++--------------+------------------+------------------------------------------------------------------------------------------------+ > +|node |board |item being tested (Fuego defines a Jenkins node for each board in the system) | > ++--------------+------------------+------------------------------------------------------------------------------------------------+ > +|job |test |a collection of information needed to perform a single test | > ++--------------+------------------+------------------------------------------------------------------------------------------------+ > +|''none'' |request |a request to run a particular test on a board | > ++--------------+------------------+------------------------------------------------------------------------------------------------+ > +|build |run(or 'test run')|the results from executing the job or test | > ++--------------+------------------+------------------------------------------------------------------------------------------------+ > +|''none'' |plan |the plan has the list of tests and how to run them (which variation, or 'spec' to use) | > ++--------------+------------------+------------------------------------------------------------------------------------------------+ > +|''none'' |spec |the spec indicates a particular variation of a test | > ++--------------+------------------+------------------------------------------------------------------------------------------------+ > + I shortened the lines on this table so that the source is only 80-columns wide. When rendered by sphinx for html output ('make html'), the resulting html file has a table that is not fit to the page. It has a horizontal scroll bar, instead of expanding the table cells vertically and wrapping the text. Can you see if there's a setting that would allow this table to appear without needing a scroll bar? Thanks, -- Tim