Changeset d5b631f in rtems-docs


Ignore:
Timestamp:
Feb 27, 2019, 9:36:39 PM (9 months ago)
Author:
Chris Johns <chrisj@…>
Branches:
master
Children:
1393ba0
Parents:
921037f
git-author:
Chris Johns <chrisj@…> (02/27/19 21:36:39)
git-committer:
Chris Johns <chrisj@…> (02/28/19 22:52:59)
Message:

User: Change output block to type none.

Location:
user
Files:
27 edited

Legend:

Unmodified
Added
Removed
  • user/bsps/bsps-powerpc.rst

    r921037f rd5b631f  
    9595image.  Use the following commands:
    9696
    97 .. code-block:: shell
     97.. code-block:: none
    9898
    9999    powerpc-rtems5-objcopy -O binary app.exe app.bin
     
    103103Use the following U-Boot commands to boot an application via TFTP download:
    104104
    105 .. code-block:: shell
     105.. code-block:: none
    106106
    107107    tftpboot ${loadaddr} app.img && run loadfdt && bootm ${loadaddr} - ${fdt_addr} ; reset
  • user/bsps/bsps-x86_64.rst

    r921037f rd5b631f  
    4141Quick instructions (which may fall out of date) are:
    4242
    43 .. code-block:: shell
     43.. code-block:: none
    4444
    4545    $ git clone git://github.com/tianocore/edk2.git
     
    6464You can find the ``OVMF.fd`` file like this as well in the edk2 directory:
    6565
    66 .. code-block:: shell
     66.. code-block:: none
    6767
    6868    $ find . -name "*.fd"
     
    8383replacing paths as appropriate.
    8484
    85 .. code-block:: shell
     85.. code-block:: none
    8686
    8787  $ qemu-img create freebsd.img 8G
     
    115115On the host
    116116
    117 .. code-block:: shell
     117.. code-block:: none
    118118
    119119   # Upload hello.exe anywhere accessible within the host
     
    122122Then on the guest (FreeBSD), login with ``root`` and
    123123
    124 .. code-block:: shell
     124.. code-block:: none
    125125
    126126   # Back the FreeBSD kernel up
  • user/bsps/index.rst

    r921037f rd5b631f  
    1919You can see the current BSP list in the RTEMS sources by asking RTEMS with:
    2020
    21 .. code-block:: shell
     21.. code-block:: none
    2222
    2323    $ ./rtems-bsps
  • user/exe/initialization.rst

    r921037f rd5b631f  
    8686sample application in the RTEMS kernel's testsuite::
    8787
    88 .. code-block:: shell
     88.. code-block:: none
    8989
    9090 $ rtems-exeinfo --init arm-rtems5/c/xilinx_zynq_zedboard/testsuites/samples/hello.exe
  • user/exe/loader.rst

    r921037f rd5b631f  
    457457into the base image.
    458458
    459 .. code-block:: shell
     459.. code-block:: none
    460460
    461461 $ sparc-rtems5-gcc -mcpu=cypress foo.o -lrtemsbsp -lrtemscpu -o foo.pre
     
    485485file. First create the symbol table's executable object file:
    486486
    487 .. code-block:: shell
     487.. code-block:: none
    488488
    489489 $ sparc-rtems5-gcc -mcpu=cypress foo.o -lrtemsbsp -lrtemscpu -o foo.exe
     
    631631in a library with a single command.
    632632
    633 .. code-block:: shell
     633.. code-block:: none
    634634
    635635  $ sparc-rtems5-strip libc.a
  • user/hardware/architectures.rst

    r921037f rd5b631f  
    2626``-print-multi-lib`` option:
    2727
    28 .. code-block:: shell
     28.. code-block:: none
    2929
    3030    $ sparc-rtems5-gcc -print-multi-lib
     
    5757with the ``-print-multi-directory`` option:
    5858
    59 .. code-block:: shell
     59.. code-block:: none
    6060
    6161    $ sparc-rtems5-gcc -print-multi-directory -mcpu=leon3
  • user/hosts/os.rst

    r921037f rd5b631f  
    5353    applications can be set with the following in a BASH shell:
    5454
    55     .. code-block:: shell
     55    .. code-block:: none
    5656
    5757      $ export PATH=$HOME/development/rtems/4.11/bin:$PATH
     
    7676    checkout the 4.11 branch of the RSB:
    7777
    78     .. code-block:: shell
     78    .. code-block:: none
    7979
    8080      $ git checkout -t origin/4.11
  • user/hosts/posix.rst

    r921037f rd5b631f  
    5656The following packages are required on a fresh Archlinux 64bit installation:
    5757
    58 .. code-block:: shell
     58.. code-block:: none
    5959
    6060  # pacman -S base-devel gdb xz unzip ncurses git zlib
     
    6464provide a manual override:
    6565
    66 .. code-block:: shell
     66.. code-block:: none
    6767
    6868  # pacman -R texinfo
     
    7777The following packages are required on a minimal CentOS 6.3 64bit installation:
    7878
    79 .. code-block:: shell
     79.. code-block:: none
    8080
    8181  # yum install autoconf automake binutils gcc gcc-c++ gdb make patch \
     
    9494packages:
    9595
    96 .. code-block:: shell
     96.. code-block:: none
    9797
    9898  # yum install ncurses-devel python-devel git bison gcc cvs gcc-c++ \
     
    107107required:
    108108
    109 .. code-block:: shell
     109.. code-block:: none
    110110
    111111  $ sudo apt-get install autoconf automake bison flex binutils gcc g++ gdb \
     
    125125Xubuntu. A minimal installation was used and the following packages installed:
    126126
    127 .. code-block:: shell
     127.. code-block:: none
    128128
    129129  $ sudu apt-get build-dep gcc-defaults g++ gdb git unzip pax bison \
     
    148148than the usual zlib-dev):
    149149
    150 .. code-block:: shell
     150.. code-block:: none
    151151
    152152  # sudo apt-get install zlib1g-dev
     
    168168version. You need to install some ports. They are:
    169169
    170 .. code-block:: shell
     170.. code-block:: none
    171171
    172172  # cd /usr/ports
     
    176176ports:
    177177
    178 .. code-block:: shell
     178.. code-block:: none
    179179
    180180  # cd /usr/ports
     
    196196are:
    197197
    198 .. code-block:: shell
     198.. code-block:: none
    199199
    200200  # pkg_add ftp://ftp.netbsd.org/pub/pkgsrc/packages/NetBSD/i386/6.1/devel/gmake-3.82nb7.tgz
  • user/hosts/windows.rst

    r921037f rd5b631f  
    158158Install the packages using ``pacman``:
    159159
    160 .. code-block:: shell
     160.. code-block:: none
    161161
    162162  $ pacman -S python mingw-w64-x86_64-python2 mingw-w64-x86_64-gcc \
     
    226226is:
    227227
    228 .. code-block:: shell
     228.. code-block:: none
    229229
    230230  chris@cygwin ~/development/rtems/src/rtems-source-builder/rtems
  • user/installation/developer.rst

    r921037f rd5b631f  
    6363Clone the RTEMS Source Builder (RSB) repository:
    6464
    65 .. code-block:: shell
     65.. code-block:: none
    6666
    6767  $ cd
     
    8181requires:
    8282
    83 .. code-block:: shell
     83.. code-block:: none
    8484
    8585  $ cd rsb
     
    9191build, just ask the tool:
    9292
    93 .. code-block:: shell
     93.. code-block:: none
    9494
    9595    $ ../source-builder/sb-set-builder --list-bsets   <1>
     
    165165is `5` and is on master:
    166166
    167 .. code-block:: shell
     167.. code-block:: none
    168168
    169169  $ cd rtems
     
    317317  tar files of the built package set.
    318318
    319 .. code-block:: shell
     319.. code-block:: none
    320320
    321321   ~
     
    329329created. Change to that directory and get a copy of the RSB:
    330330
    331 .. code-block:: shell
     331.. code-block:: none
    332332
    333333   ~
     
    348348We are building RTEMS 4.11 tools so select the *4.11* branch:
    349349
    350 .. code-block:: shell
     350.. code-block:: none
    351351
    352352   /c/opt/rtems/rsb
     
    359359Check the RSB has a valid environment:
    360360
    361 .. code-block:: shell
     361.. code-block:: none
    362362
    363363   /c/opt/rtems/rsb
     
    376376tools is:
    377377
    378 .. code-block:: shell
     378.. code-block:: none
    379379
    380380   /c/opt/rtems/rsb/rtems
     
    496496built. First we need to set the path to the tools:
    497497
    498 .. code-block:: shell
     498.. code-block:: none
    499499
    500500   /c
     
    507507We currently build RTEMS from the git release branch for 4.11:
    508508
    509 .. code-block:: shell
     509.. code-block:: none
    510510
    511511   /c/opt/rtems
     
    539539bootstrap tool. First we clean any generated files that exist:
    540540
    541 .. code-block:: shell
     541.. code-block:: none
    542542
    543543   /c/opt/rtems/kernel/rtems
     
    549549Then we generate the pre-install header file automake make files:
    550550
    551 .. code-block:: shell
     551.. code-block:: none
    552552
    553553   /c/opt/rtems/kernel/rtems
     
    580580Finally we run the RSB's parallel ``bootstrap`` command:
    581581
    582 .. code-block:: shell
     582.. code-block:: none
    583583
    584584  $ /c/opt/rtems/rsb/source-builder/sb-bootstrap
     
    616616Support Package (BSP) outside the kernel source tree:
    617617
    618 .. code-block:: shell
     618.. code-block:: none
    619619
    620620   /c/opt/rtems/kernel/rtems
     
    630630networking disabled, We will build the external libBSD stack later:
    631631
    632 .. code-block:: shell
     632.. code-block:: none
    633633
    634634   /c/opt/rtems/kernel/pc686
     
    668668Build the kernel:
    669669
    670 .. code-block:: shell
     670.. code-block:: none
    671671
    672672   /c/opt/rtems/kernel/pc686
     
    707707Install the kernel to our prefix:
    708708
    709 .. code-block:: shell
     709.. code-block:: none
    710710
    711711  $ make install
  • user/installation/kernel.rst

    r921037f rd5b631f  
    1717Create a new location to build the RTEMS kernel:
    1818
    19 .. code-block:: shell
     19.. code-block:: none
    2020
    2121  $ cd
     
    2626Clone the RTEMS respository:
    2727
    28 .. code-block:: shell
     28.. code-block:: none
    2929
    3030  $ git clone git://git.rtems.org/rtems.git rtems
     
    4545the RTEMS version and not your host's versions:
    4646
    47 .. code-block:: shell
     47.. code-block:: none
    4848
    4949  $ export PATH=$HOME/development/rtems/5/bin:$PATH
     
    6262directory then run the bootstrap commands:
    6363
    64 .. code-block:: shell
     64.. code-block:: none
    6565
    6666  $ cd rtems
     
    104104create a suitable directory using the name of the BSP we are going to build:
    105105
    106 .. code-block:: shell
     106.. code-block:: none
    107107
    108108  $ cd ..
     
    116116enabled and the networking stack disabled:
    117117
    118 .. code-block:: shell
     118.. code-block:: none
    119119
    120120  $ $HOME/development/rtems/kernel/rtems/configure --prefix=$HOME/development/rtems/5 \
     
    159159Build RTEMS using two cores:
    160160
    161 .. code-block:: shell
     161.. code-block:: none
    162162
    163163  $ make -j 2
     
    251251RTEMS with the following command:
    252252
    253 .. code-block:: shell
     253.. code-block:: none
    254254
    255255  $ make install
     
    312312has changed:
    313313
    314 .. code-block:: shell
     314.. code-block:: none
    315315
    316316  $ cd ../rtems
     
    324324command reports:
    325325
    326 .. code-block:: shell
     326.. code-block:: none
    327327
    328328  $ git status
     
    340340change with the follow git command:
    341341
    342 .. code-block:: shell
     342.. code-block:: none
    343343
    344344  $ git commit cpukit/libmisc/shell/main_halt.c
     
    347347and the following lines form a body. My message is:
    348348
    349 .. code-block:: shell
     349.. code-block:: none
    350350
    351351  shell: Add more help detail to the halt command.
     
    367367When you save and exit the editor git will report the commit's status:
    368368
    369 .. code-block:: shell
     369.. code-block:: none
    370370
    371371  $ git commit cpukit/libmisc/shell/main_halt.c
     
    376376command, and it is `minus one` on the command line:
    377377
    378 .. code-block:: shell
     378.. code-block:: none
    379379
    380380  $ git send-email --to=devel@rtems.org -1
     
    383383Or you can ask git to create a patch file using:
    384384
    385 .. code-block:: shell
     385.. code-block:: none
    386386
    387387  $ git format-patch -1
  • user/installation/releases.rst

    r921037f rd5b631f  
    6767build the release in. On Unix:
    6868
    69 .. code-block:: shell
     69.. code-block:: none
    7070
    7171 $ cd
     
    7575If building on Windows:
    7676
    77 .. code-block:: shell
     77.. code-block:: none
    7878
    7979 $ cd /c
     
    8585Download the RTEMS Source Builder (RSB) from the RTEMS FTP server:
    8686
    87 .. code-block:: shell
     87.. code-block:: none
    8888
    8989 $ wget https://ftp.rtems.org/pub/rtems/releases/4.11/4.11.0/rtems-source-builder-4.11.0.tar.xz
     
    101101On Unix unpack the RSB release tar file using:
    102102
    103 .. code-block:: shell
     103.. code-block:: none
    104104
    105105 $ tar Jxf rtems-source-builder-4.11.0.tar.xz
     
    109109you have unpacked the tar file:
    110110
    111 .. code-block:: shell
     111.. code-block:: none
    112112
    113113 $ tar Jxf rtems-source-builder-4.11.0.tar.xz
     
    122122discussed in :ref:`msys2_parallel_builds`.
    123123
    124 .. code-block:: shell
     124.. code-block:: none
    125125
    126126 $ ../source-builder/sb-set-builder \
  • user/rsb/bug-reporting.rst

    r921037f rd5b631f  
    1414
    1515Please include the generated RSB report. If you see the following a report has
    16 been generated::
     16been generated:
    1717
    18      ...
    19      ...
     18.. code-block:: none
     19
     20    ...
     21    ...
    2022    Build FAILED   <1>
    2123      See error report: rsb-report-4.11-rtems-lm32.txt   <2>
  • user/rsb/commands.rst

    r921037f rd5b631f  
    1111This commands checks your system is set up correctly. Most options are ignored:
    1212
    13 .. code-block:: shell
     13.. code-block:: none
    1414
    1515    $ ../source-builder/sb-check --help
     
    5555arguments. Most options are ignored:
    5656
    57 .. code-block:: shell
     57.. code-block:: none
    5858
    5959    $ ../source-builder/sb-defaults --help
     
    9595This command builds a set:
    9696
    97 .. code-block:: shell
     97.. code-block:: none
    9898
    9999    $ ../source-builder/sb-set-builder --help
     
    303303file. Configuration files have the extension of ``.cfg``:
    304304
    305 .. code-block:: shell
     305.. code-block:: none
    306306
    307307    $ ./source-builder/sb-builder --help
  • user/rsb/configuration.rst

    r921037f rd5b631f  
    239239the output of this command because of its size:
    240240
    241 .. code-block:: shell
     241.. code-block:: none
    242242
    243243    $ ../source-builder/sb-defaults
     
    519519To create a private configuration change to a suitable directory:
    520520
    521 .. code-block:: shell
     521.. code-block:: none
    522522
    523523    $ cd ~/work
     
    750750in the ``tar`` directory:
    751751
    752 .. code-block:: shell
     752.. code-block:: none
    753753
    754754    $  ../source-builder/sb-builder --prefix=/usr/local \
     
    783783To build this you can use something similar to:
    784784
    785 .. code-block:: shell
     785.. code-block:: none
    786786
    787787    $ ../source-builder/sb-set-builder --prefix=/usr/local --log=log_dtc \
  • user/rsb/cross-canadian-cross.rst

    r921037f rd5b631f  
    2323To build the NTP package for RTEMS you enter the RSB command:
    2424
    25 .. code-block:: shell
     25.. code-block:: none
    2626
    2727    $ ../source-builder/sb-set-builder \
     
    8686if the cross compiler is ``mingw32-gcc``:
    8787
    88 .. code-block:: shell
     88.. code-block:: none
    8989
    9090    $ ../source-builder/sb-set-builder --host=mingw32 \
     
    9696command line is:
    9797
    98 .. code-block:: shell
     98.. code-block:: none
    9999
    100100    $ ../source-builder/sb-set-builder --host=i686-w64-mingw32 \
  • user/rsb/deployment.rst

    r921037f rd5b631f  
    3333``Downloads`` directory in your home directoty you would enter:
    3434
    35 .. code-block:: shell
     35.. code-block:: none
    3636
    3737    $ cd /somewhere
     
    4242``sb-set-builder`` command:
    4343
    44 .. code-block:: shell
     44.. code-block:: none
    4545
    4646    $ ../source-builder/sb-set-builder --log=l-sparc.txt \
     
    8585building Canadian cross compiled tool sets:
    8686
    87 .. code-block:: shell
     87.. code-block:: none
    8888
    8989    $ ../source-builder/sb-set-builder --log=l-sparc.txt \
     
    125125build set:
    126126
    127 .. code-block:: shell
     127.. code-block:: none
    128128
    129129    $ ../source-builder/sb-set-builder --log=l-sparc.txt \
  • user/rsb/project-sets.rst

    r921037f rd5b631f  
    5151you would use ``sparc-elf``:
    5252
    53 .. code-block:: shell
     53.. code-block:: none
    5454
    5555    $ cd rtems-source-builder/bare
     
    110110and install them then build your tool set. The commands are:
    111111
    112 .. code-block:: shell
     112.. code-block:: none
    113113
    114114    $ ../source-builder/sb-set-builder --log=l-4.11-at.txt \
     
    132132CVS:
    133133
    134 .. code-block:: shell
     134.. code-block:: none
    135135
    136136    $ ../source-builder/sb-set-builder --log=l-4.11-sparc.txt \
     
    142142``newlib``, ``gdb`` and *RTEMS*:
    143143
    144 .. code-block:: shell
     144.. code-block:: none
    145145
    146146    $ ../source-builder/sb-set-builder --log=l-heads-sparc.txt \
  • user/rsb/third-party-packages.rst

    r921037f rd5b631f  
    4040To build Net-SNMP the command is:
    4141
    42 .. code-block:: shell
     42.. code-block:: none
    4343
    4444    $ cd rtems-source-builder/rtems
  • user/testing/tftp.rst

    r921037f rd5b631f  
    6262for a Zedboard:
    6363
    64 .. code-block:: shell
     64.. code-block:: none
    6565
    6666  loadaddr=0x02000000
     
    167167use:
    168168
    169 .. code-block:: shell
     169.. code-block:: ini
    170170
    171171  requires = bsp_tty_dev, target_on_command, target_off_command, target_reset_command
  • user/tools/bsp-builder.rst

    r921037f rd5b631f  
    345345need to be regression tested:
    346346
    347 .. code-block:: shell
     347.. code-block:: none
    348348
    349349  $ /opt/rtems/5/bin/rtems-bsp-builder --build-path=/build/rtems \
     
    394394To build a couple of BSPs you are interested in with tests:
    395395
    396 .. code-block:: shell
     396.. code-block:: none
    397397
    398398  $ /opt/rtems/5/bin/rtems-bsp-builder --build-path=/build/rtems \
  • user/tools/exeinfo.rst

    r921037f rd5b631f  
    9595Prints all reports for the ``hello.exe`` for the ``i386/pc686`` BSP:
    9696
    97 .. code-block:: shell
     97.. code-block:: none
    9898
    9999  $ rtems-exeinfo -a i386-rtems5/c/pc686/testsuites/samples/hello/hello.exe
     
    169169Print the ``Init`` section data for the ``cdtest.exe`` for the ``i386/pc686`` BSP:
    170170
    171 .. code-block:: shell
     171.. code-block:: none
    172172
    173173  $ rtems-exeinfo -I i386-rtems5/c/pc686/testsuites/samples/cdtest/cdtest.exe
  • user/tools/symbols.rst

    r921037f rd5b631f  
    136136program for the ``i386/pc686`` BSP:
    137137
    138 .. code-block:: shell
     138.. code-block:: none
    139139
    140140  $ rtems-syms -o ms.o i386-rtems5/c/pc686/testsuites/samples/minimum/minimum.exe
     
    144144Run the same command, this time create a map file:
    145145
    146 .. code-block:: shell
     146.. code-block:: none
    147147
    148148  $ rtems-syms -o ms.o -m ms.map i386-rtems5/c/pc686/testsuites/samples/minimum/minimum.exe
     
    162162command performs:
    163163
    164 .. code-block:: shell
     164.. code-block:: none
    165165
    166166  $ rtems-syms -vvv -o ms.o i386-rtems5/c/pc686/testsuites/samples/minimum/minimum.exe
  • user/tools/tester.rst

    r921037f rd5b631f  
    3737You can list the available BSP testers with:
    3838
    39 .. code-block:: shell
     39.. code-block:: none
    4040
    4141    $ rtems-test --list-bsps
     
    7979configure after running ``bootstrap``.
    8080
    81 .. code-block:: shell
     81.. code-block:: none
    8282
    8383    $ ../../rtems.git/configure --target=sparc-rtems5 \
     
    100100the tests. Using the run with the ERC32 BSP the command is:
    101101
    102 .. code-block:: shell
     102.. code-block:: none
    103103
    104104    $ sparc-rtems5-run sparc-rtems5/c/erc32/testsuites/samples/hello/hello.exe
     
    112112Running the example using GDB:
    113113
    114 .. code-block:: shell
     114.. code-block:: none
    115115
    116116    $ sparc-rtems5-gdb sparc-rtems5/c/erc32/testsuites/samples/hello/hello.exe
     
    163163BSP build tree:
    164164
    165 .. code-block:: shell
     165.. code-block:: none
    166166
    167167    $ ~/development/rtems/test/rtems-tools.git/tester/rtems-test \
     
    235235timeouts and 1 invalid test.
    236236
    237 .. code-block:: shell
     237.. code-block:: none
    238238
    239239    [ 5/13] p:2  f:0  u:0  e:0  I:0  B:0  t:0  i:0  | sparc/erc32: hello.exe
     
    346346running on a Coldfire MCF5235 using GDB and a BDM pod:
    347347
    348 .. code-block:: shell
     348.. code-block:: none
    349349
    350350    [ 11/472] p:9   f:0   t:0   i:1   | m68k/mcf5235: imfs_fslink.exe
     
    430430review the available option by the ``--help`` option:
    431431
    432 .. code-block:: shell
     432.. code-block:: none
    433433
    434434    RTEMS Tools Project (c) 2012-2014 Chris Johns
  • user/tracing/captureengine.rst

    r921037f rd5b631f  
    2020directory.
    2121
    22 .. code-block:: shell
     22.. code-block:: none
    2323
    2424  $ cd /sparc-rtems5/c/erc32/testsuites/samples
     
    9999number of context switches between tasks we are not interested in.
    100100
    101 .. code-block:: shell
     101.. code-block:: none
    102102
    103103  *** BEGIN OF TEST CAPTURE ENGINE ***
  • user/tracing/examples.rst

    r921037f rd5b631f  
    4747BSP is configured with the following command -
    4848
    49 .. code-block:: shell
     49.. code-block:: none
    5050
    5151  ../rtems/configure --target=sparc-rtems5 --prefix=/development/rtems/5 \
     
    5959to your installation.
    6060
    61 .. code-block:: shell
     61.. code-block:: none
    6262
    6363  sparc-rtems5-gcc -Bsparc-rtems5/erc32/lib/ \
     
    7373the wrapper c file.
    7474
    75 .. code-block:: shell
     75.. code-block:: none
    7676
    7777  rtems-tld -C fileio-trace.ini -W fileio-wrapper -- -Bsparc-rtems5/erc32/lib/ \
     
    8989with `rtrace`.
    9090
    91 .. code-block:: shell
     91.. code-block:: none
    9292
    9393  sparc-rtems5-run sparc-rtems5/c/erc32/testsuites/samples/fileio.exe
     
    9595The output from the above commands will be as follows:
    9696
    97 .. code-block:: shell
     97.. code-block:: none
    9898
    9999  *** BEGIN OF TEST FILE I/O ***
  • user/tracing/tracelinker.rst

    r921037f rd5b631f  
    2626consists of:
    2727
    28 .. code-block:: shell
     28.. code-block:: none
    2929
    3030  $ rtems-tld -h
     
    483483First we configure using:
    484484
    485 .. code-block:: shell
     485.. code-block:: none
    486486
    487487  $./waf configure --prefix=$HOME/development/rtems/5
     
    489489Then we build and install using:
    490490
    491 .. code-block:: shell
     491.. code-block:: none
    492492
    493493  $./waf build install
Note: See TracChangeset for help on using the changeset viewer.