Changeset 8b67c91 in rtems-docs


Ignore:
Timestamp:
May 19, 2018, 8:32:42 PM (18 months ago)
Author:
Chris Johns <chrisj@…>
Branches:
master
Children:
5ca4172
Parents:
21c1a44
git-author:
Chris Johns <chrisj@…> (05/19/18 20:32:42)
git-committer:
Chris Johns <chrisj@…> (11/03/18 05:36:32)
Message:

user: Add RTEMS executable and test documentation.

Files:
27 added
3 deleted
3 edited

Legend:

Unmodified
Added
Removed
  • README.txt

    r21c1a44 r8b67c91  
    2323created is worth it.
    2424
     25Images can be created from source using PlantUML and Ditaa.
     26
    2527Production Quality Hosts
    2628------------------------
     
    3739NOTE: RedHat Enterprise Linux (RHEL) and Fedora should be the same as CentOS.
    3840
     41Images
     42------
     43
     44All images should be placed int he 'images' directory and referenced from the
     45ReST with a relative path. This lets us shared and control images.
     46
     47We prefer being able to build images from source. This is not always possible
     48so SVG format is preferred with generated PNG images so make sure the quality
     49is consistent when building PDF output.
     50
     51We support the PlantUML image language. The PlantUML home page is:
     52
     53 http://plantuml.com/
     54
     55The page as a link to an 'online demo server' you can use to create images
     56rathre than installing PlantUML. Save you source then View and save the PNG
     57format image. The PlantUML language reference guide is:
     58
     59 http://plantuml.com/PlantUML_Language_Reference_Guide.pdf
     60
     61And the web site has online documentation. The image source extension is
     62'.puml'.
     63
     64We also support Ditaa image language. The Ditaa home page is:
     65
     66 http://ditaa.sourceforge.net/
     67
     68The home page contain the language options. The PlantUML online demo server
     69supports Ditaa so use that resource as an online tool. The Ditaa image source
     70extension is '.ditaa'.
     71
     72You do not need PlantUML or Ditaa install to build our documentation. The
     73online resources can be used. Save the source and the generated PNG file in the
     74same directory under 'images'.
     75
    3976Host Setup
    4077----------
     
    4279HTML builds directly with Sphinx, PDF requires a full Latex (texlive) install,
    4380and building a Single HTML page requires the 'inliner' tool. The
    44 sphinxcontrib-bibtex extension is mandatory.
     81sphinxcontrib-bibtex extension is mandatory. PlantUML requres the Node.js
     82package called 'nde-plantuml' which installs the 'puml' command and Ditaa needs
     83the 'ditaa' command and package. Ditaa images are built using the 'puml'
     84command.
    4585
    4686Please add your host as you set it up.
     
    182222  export PATH=/usr/local/texlive/2016/bin/i386-linux/:${PATH}
    183223  export PATH=${HOME}/.local/bin:${PATH}
    184 
    185224
    186225Arch Linux
  • user/index.rst

    r21c1a44 r8b67c91  
    5252        bsps/index
    5353
     54        exe/index
     55        testing/index
     56        tracing/index
     57
    5458        tools/index
    55 
    56         tracing/index
    5759
    5860        support/index
  • user/tools/tester.rst

    r21c1a44 r8b67c91  
    66.. _rtems-tester-command:
    77
    8 RTEMS Tester and Run Commands
    9 =============================
     8RTEMS Tester and Run
     9====================
    1010
    1111.. index:: Tools, rtems-test, rtems-run
Note: See TracChangeset for help on using the changeset viewer.