FrontPage 

Fuego wiki

Login or create account

Issue 0088 in split format

Summary
Integrate test documentation with sphinx build and Jenkins interface ; Owner: Tim ; Reporter: tim ; Status: open ; Priority: medium ; Version: 1.5 ; Subsystem: ftc|core|docker, etc. ; Tags: (words or phrases for searching)
; Summary: Integrate test documentation with sphinx build and Jenkins interface
; Owner: Tim
; Reporter: tim
; Status: open
; Priority: medium
; Version: 1.5
; Subsystem: ftc|core|docker, etc.
; Tags: (words or phrases for searching)

Description [edit section]

= Description =
Make it possible to add and display per-test and per-tguid documentation.
See Test documentation for details.
See [[Test documentation]] for details.
Currently, there is .rst documentation for some tests in the /fuego/docs/rst_src directory. Specifically, as of December 2020, the following files are present: * Benchmark.bonnie * Benchmark.GLMark * Functional.LTP * Functional.Linaro * Functional.fuego_release_test * Functional.template (this is a template, not for a specific test) * Functional.arch_timer * Functional.cmt * Functional.crashme * Functional.expat
Currently, there is .rst documentation for some tests in the
/fuego/docs/rst_src directory.  Specifically, as of December 2020, 
the following files are present:
 * Benchmark.bonnie
 * Benchmark.GLMark
 * Functional.LTP
 * Functional.Linaro
 * Functional.fuego_release_test
 * Functional.template (this is a template, not for a specific test)
 * Functional.arch_timer
 * Functional.cmt
 * Functional.crashme
 * Functional.expat
These should be converted to ftmp files, and moved to 'docs' directories under their respective tests.
These should be converted to ftmp files, and moved to 'docs' directories
under their respective tests.
Also, the system for adding a link to the test documentation should be added somewhere in the system (maybe as part of the chart generator?)
Also, the system for adding a link to the test documentation should
be added somewhere in the system (maybe as part of the chart generator?)

Notes [edit section]

= Notes =
''Put other free-form comments or notes here''
backlink

Fuego Issues List

; backlink: [[Fuego Issues List]]
TBWiki engine 1.8.3 by Tim Bird