rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-05-16 18:57:22 +08:00
Code Issues Packages Projects Releases Wiki Activity
886 Commits 3 Branches 7 Tags
Commit Graph

191 Commits

Author SHA1 Message Date
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
Sebastian Huber
50fbe0d9b4 Add common header.rst to reduce copy and paste 2019-01-09 09:24:02 +01:00
Joel Sherrill
6682434bf2 Eliminate UTF-8 characters except superscripted 2 in i2c 2018-12-20 09:17:09 -06:00
Joel Sherrill
df3f2a49fb users/host/posix.rst: Update Ubuntu instructions based on 18.04.1 LTS 
Closes #3416.
 2018-11-16 16:32:59 -06:00
Aneendya
3f4f904296 glossary.rst: Fix grammar errors (GCI 2018) 2018-11-16 11:14:25 -06:00
Marçal Comajoan Cara
b2a7a5ddbe user: add a warning not to use special characters in pathnames 
Spaces and other specical characters in pathnames break builds of any
software packages using GNU make.

All of the GNU tools and RTEMS use make and this breaks builds. This
is a long standing known issue with GNU make, which can't handle spaces
in pathnames:

https://savannah.gnu.org/bugs/?712

This work was part of GCI 2018.

Probably closes #3450.
 2018-11-16 10:42:41 -06:00
Sebastian Huber
1a704cdc7f Remove m32c architecture port 
Update #3599.
 2018-11-09 14:59:59 +01:00
Marçal Comajoan Cara
495a84c804 user: spelling and grammar fixes 
This work was part of GCI 2018.
 2018-11-09 14:59:59 +01:00
Sebastian Huber
3c6df36088 user: Update architecture list 2018-11-08 16:33:22 +01:00
Sebastian Huber
edc4ff6a92 user: Remove obsolete boostrap -p step 
Update #3254.
 2018-11-08 16:26:17 +01:00
Chris Johns
8b67c9135c user: Add RTEMS executable and test documentation. 2018-11-03 16:36:32 +11:00
Chris Johns
bb13624065 User: Simplify the top level headings. 2018-11-03 16:36:32 +11:00
Chris Johns
969e60e596 Update the copyright year. 2018-10-19 14:42:12 +11:00
Joel Sherrill
5577cc082a Move duplicate host configuration information from RSB to Users Guide 2018-10-13 20:06:50 -05:00
Joel Sherrill
c1809d631d Merge duplicative RSB Quick Start into Users Guide 2018-10-13 20:06:50 -05:00
Sebastian Huber
3e8af71bb4 user: Document QorIQ BSP variants 2018-10-01 07:58:05 +02:00
Sebastian Huber
bd25da8805 user: Add i.MX 7D MMC/SDCard driver 
Close #3525.
 2018-09-25 10:13:19 +02:00
Sebastian Huber
c476ccef39 user: Add qoriq BSP section 
Update #2854.
 2018-08-29 07:47:14 +02:00
Chris Johns
5ce8e43506 build: Fix indexing so it works on HTML and PDF. 
- Remove all genindex.rst files, these are generated and should not
  exist in our source.
- Fix the HTML templates so the local specialisation works.
- Add a index link to the sidebar for HTML.

Note, there is no TOC entry for the index in the PDF output and I
cannot figure out how to add one.

Closes #3503
 2018-08-21 13:47:40 +10:00
Amaan Cheval
587d14f2b2 user: Update x86-64 chapter with end-of-GSoC status 2018-08-20 11:07:53 -05:00
Sebastian Huber
24326a8d07 user: Add RISC-V BSP section 
Update #3433.
 2018-08-02 13:21:25 +02:00
Amaan Cheval
4c2ca04c47 user: Add x86_64 BSP chapter 2018-07-18 12:43:10 -05:00
Sebastian Huber
2c2c6cc18e user: Add BSP chapter for each architecture 
Update #3464.
 2018-06-26 11:18:43 +02:00
Sebastian Huber
8e3de165c0 user: Add ARM BSPs chapter 
Add NXP i.MX section as a BSP example.

Update #2854.
 2018-06-26 11:11:39 +02:00
Vidushi Vashishth
8f4f80d437 Adding Trace Documentation 
- Updates #3454
- This commit adds Tracing Framework Chapter in the RTEMS User Manual
- It comprises of subchapters on RTEMS Trace Linker, Capture Engine, Trace
  generation techniques explaining trace generation using Trace Buffering and
  Printk generators and sample demonstrations.
 2018-06-18 15:26:52 +10:00
Sebastian Huber
fc9db4c26e user: Do not mention "bootstrap -p" 
It is now obsolete and was never necessary for an RTEMS users.

Update #3254.
 2018-03-28 07:21:14 +02:00
Chris Johns
33849946ff Clean up sphinx warnings. 
- Fix minor formatting issues.
- Fix reference the gloassary TLS using ':term:'.
- Make sure nothing is between an anchor and the heading where ':ref:' references
  the anchor. This meant moving all the recently added '.. index::' entries.

Update #3232.
Update #3229.
 2017-11-13 13:25:18 +11:00
Chris Johns
ac0eaff941 Use '.. toctree::' and not '.. include::' in the User Manual. 
- Change all suitable '.. include::' to TOC tree.
- Remove unused and not needed sections.
- Fix the conf.py to not exclude some files.

Close #3232.
 2017-11-13 11:51:23 +11:00
Chris Johns
42d50d760e Add indexes to all documents. 
Update #3229.
 2017-11-12 10:32:39 +11:00
Sebastian Huber
60a6d6eae9 Change RTEMS version to 5 
Update #3220.
 2017-11-09 10:24:09 +01:00
Chris Johns
efc29ff31b Update copyright notices. 2017-08-11 13:45:52 +10:00
Tanu Hari Dixit
c475eeffdb User Manual: Added rtems-tester in the docs 
Added as part of Tools.
Made changes according to Chris' review
Also removed the ini format part inline with
the new release that is expected.
 2017-06-14 11:38:47 +10:00
Chris Johns
eb934d0d6c User: Remove conflict marker. 2017-06-01 11:44:34 +10:00
Chris Johns
32400785ce User: Remove the stash conflict markers. 2017-05-31 21:11:01 +10:00
Chris Johns
d224b11688 User: Improvements to some of the tools commands. 2017-05-31 20:59:36 +10:00