125 Commits

Author SHA1 Message Date
Sebastian Huber
e21c413ec9 user: Improve bug report section
The new content is based on the wiki page:

https://devel.rtems.org/wiki/Developer/Bug_Reporting

The goal is to remove the wiki page and direct the "New ticket" page to
this user manual section.  Some content of the wiki page should move to
the "Contributing" sections since it is not directly related to bug
reporting, e.g. managing existing bugs.
2019-08-08 08:04:57 +02:00
Vijay Kumar Banerjee
7c89bd6d5f user/exe: Add Device Tree section 2019-08-07 20:42:37 +02:00
Sebastian Huber
f170947c00 user: Move support sections to top level
This is a preparation step to move the bug reporting procedure from the
wiki to the user manual and to add a contributing section.
2019-08-06 07:04:27 +02:00
Vijay Kumar Banerjee
8b203e284a user/bsps : Fix formatting and typo in arm/beagle 2019-07-27 13:26:16 +02:00
Vijay Kumar Banerjee
d8d58768c3 user/bsps : Add documentation for Beagle 2019-07-20 11:13:15 +10:00
Chris Johns
248c7089b9 user: Split the ARM BSPs source into separate files. 2019-07-12 08:09:14 +10:00
Chris Johns
8c3fac9067 user: Add the boot image tool command. 2019-06-12 14:19:32 +10:00
Sebastian Huber
a00052a341 user: Document boot image generation
Update #3727.
2019-05-27 10:37:20 +02:00
Sebastian Huber
808ef17984 user: Add basic lpc24xx description
Update #3724.
Update #3725.
2019-03-18 10:27:54 +01:00
Chris Johns
1e342dad3f user/test: Update with the latest test configuration format. 2019-03-06 22:22:57 +11:00
Chris Johns
d5b631fa3b User: Change output block to type none. 2019-03-01 09:52:59 +11:00
Chris Johns
2674d6a949 user: Remove nit-picky warnings. 2019-02-28 10:22:54 +11:00
Chris Johns
fb72a002a3 Add unicode support for commonly used characters like copyright.
- This change makes the copyright character easier to see on editors
  lacking good unicode rendering support, ie terminals.
2019-02-28 10:22:54 +11:00
Vaibhav Gupta
9c3a383193 Update User Documentation for Host setup for Linux
Mention the requirement of 'pax' package for building BSP if RTEMS is
configured with '--enable-tests' option, else build fails.
2019-02-28 09:11:36 +11:00
Chris Johns
8a73acb713 user: Add a Dynamic Loader section. 2019-02-20 09:05:35 +11:00
Sebastian Huber
f6be8a1ee1 user: Fix tense in quick start 2019-02-19 08:29:15 +01:00
Sebastian Huber
7ad2d12a57 user: Clarify U-Boot commands 2019-02-19 07:11:54 +01:00
Sebastian Huber
cb4e4e2b37 user: Remove obsolete content in quick start 2019-02-18 14:41:09 +01:00
Sebastian Huber
d7caf8acb6 user: Add "Build Your Application" 2019-02-18 14:41:09 +01:00
Sebastian Huber
d2827cbcb4 user: Add "Test a Board Support Package (BSP)" 2019-02-18 14:41:09 +01:00
Sebastian Huber
fa12cab2b9 user: Add "Build a Board Support Package (BSP)" 2019-02-18 14:41:09 +01:00
Sebastian Huber
158d905d77 user: Add "Bootstrap the RTEMS Sources" 2019-02-18 14:41:09 +01:00
Sebastian Huber
06a1fa27b7 user: Add "Install the Tool Suite" section 2019-02-18 14:41:06 +01:00
Sebastian Huber
947e8eb219 user: Add "Obtain the Sources" section 2019-02-18 14:03:11 +01:00
Sebastian Huber
eae5454288 user: Rework Prefixes section
Rename it to "Choose an Installation Prefix".

Update #3675.
2019-02-18 13:50:31 +01:00
Sebastian Huber
24456556d6 user: Fix references to prefixes section 2019-02-18 13:50:31 +01:00
Sebastian Huber
54ead99fc4 user: Rework "Host Computer Setup" section
Rename it to "Prepare Your Host Computer".
2019-02-18 13:50:25 +01:00
Sebastian Huber
924b9ef2e1 user: Add product name 2019-02-18 09:16:28 +01:00
Sebastian Huber
9f24b6e134 user: Add basic Intel Cyclone V documentation 2019-02-18 08:45:54 +01:00
Chris Johns
f7384cc2e2 Use pathto() on the genindex URL to make it relative. 2019-02-15 09:40:50 +11:00
Chris Johns
5d8b0ddd0a waf: Remove as many sys path hacks as we can.
There are still sys.path hacks in the conf.py files. They cannot
be removed because the instance of python running the sphinx-build
command does not see our top level path hacks. I looked at using
PYTHONPATH but I could not figure out how to set a process environ
var for a waf build instance.
2019-02-13 10:18:43 +11:00
Sebastian Huber
6f110ccf6b build: Prepend project common path
This avoids conflicts with standard packages such as PIL (Python Imaging
Library).
2019-02-08 09:43:16 +01:00
Sebastian Huber
21c4a44451 user: Add basic event recording documentation
Update #3665.
2019-02-01 09:52:03 +01:00
Sebastian Huber
3db6371539 user: Use capital letters for acronyms
Fix GCC definition.
2019-01-24 07:31:27 +01:00
Sebastian Huber
63735bc9d2 user: Spell out third-party 2019-01-24 07:31:25 +01:00
Sebastian Huber
5973f92f79 user: Stub documentation for griscv BSP
Update #3678.
2019-01-22 12:58:38 +01:00
Sebastian Huber
3ed59cebd8 user: Add "Host Computer Setup" to "Quick Start" 2019-01-14 07:15:27 +01:00
Sebastian Huber
0facb9de94 user: Move "Prefixes" to "Quick Start"
Move "Project Sandboxing" to a separate section of the "Installation"
chapter since this is an advance topic which may confuse new users.
2019-01-14 07:15:27 +01:00
Sebastian Huber
3de74baacb user: Rework "Hardware" chapter
Rename it to "Target Hardware".  Remove BSPs section and reference the
BSPs chapter instead.  Remove explicit list of architectures and
reference the BSPs chapter instead.  Fix typos.  Elaborate multilib
description in the architecture section.
2019-01-14 07:15:27 +01:00
Sebastian Huber
89a33b3db8 user: Move deployment details to RSB chapter 2019-01-14 07:15:27 +01:00
Sebastian Huber
c0982900e9 user: Move "Ecosystem" into "Introduction" 2019-01-14 07:15:27 +01:00
Sebastian Huber
c4da70595f user: Move "Support" to "Introduction"
New users may find it useful to get this information in the
introduction.
2019-01-14 07:15:27 +01:00
Sebastian Huber
b5014fe0c8 Reformat and update copyright and license notices
For everything before 2015 an OAR copyright is assumed.  Later copyright
notices are based on Git commits on a best effort basis.

The copyright notices of the "RTEMS Software Engineering Handbook" and
the "RTEMS CPU Architecture Supplement" are incomplete.
2019-01-14 07:15:27 +01:00
Sebastian Huber
60ed99d2b0 user: Add RSB content as a chapter
Remove the separate RSB manual.
2019-01-14 07:15:27 +01:00
Sebastian Huber
1cb70df939 user: Remove unused file 2019-01-11 14:46:19 +01:00
Sebastian Huber
e52906b556 Simplify SPDX-License-Identifier comment 2019-01-11 07:22:01 +01:00
Sebastian Huber
12dccfe716 Remove superfluous "All rights reserved." 2019-01-11 07:18:56 +01:00
Sebastian Huber
4886d60aa8 Use standard format for copyright lines 2019-01-11 07:18:16 +01:00
Sebastian Huber
05d066a08f user: Add TODO entries for all BSP families
Update #3464.
2019-01-09 13:59:29 +01:00
Sebastian Huber
52f4890281 user: Rework overview
Move "Overview", "Real-time Applicaiton Systems" and "Real-time
Executive" chapters as sections into new "Introduction" chapter.  Add
"Feature" section.
2019-01-09 09:24:02 +01:00