rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-06-09 18:36:27 +08:00
Code Issues Packages Projects Releases Wiki Activity
1,312 Commits 3 Branches 7 Tags
Commit Graph

37 Commits

Author SHA1 Message Date
Sebastian Huber
bbb8b7aa81 Update company name 
The embedded brains GmbH & Co. KG is the legal successor of embedded
brains GmbH.
 2023-05-20 11:12:29 +02:00
Chris Johns
2a2d33ccfc user: Add deployment section 2022-09-13 07:45:28 +10:00
Sebastian Huber
4ea43e39c7 user: Document BSP new build system 
Update #3818.
 2020-09-13 13:55:44 +02:00
Gedare Bloom
cae8b6dfc9 user: update copyright and minor typo 2020-04-04 22:22:40 -06:00
Gedare Bloom
44fde6c3be Update top-level copyrights 2020-04-03 12:44:31 -06:00
G S Niteesh Babu
94697e1c55 start/gsoc: GSoC Getting started instructions. 
Added instructions to setup development environment for students
interested in GSoC.
 2020-04-02 09:27:54 -06:00
Chris Johns
4726207d91 user: Add a migration chapter 
This is a start with the hope we collect useful pieces to aid porting.
Please add to this.

Closes #3895
 2020-03-13 08:20:39 +11:00
Chris Johns
f6720264ea user: Update Quick Start Guide 
- Add support for release source archives
- Add building the BSP using the RSB
- Add building packages using the RSB
- Add an application

Closes #2998
 2020-03-13 08:18:36 +11:00
Vijay Kumar Banerjee
8fd1d4549e user/index: Add myself to the list of copyrights 2019-08-15 09:01:02 +02:00
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
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
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
Chris Johns
f7384cc2e2 Use pathto() on the genindex URL to make it relative. 2019-02-15 09:40:50 +11: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
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
e52906b556 Simplify SPDX-License-Identifier comment 2019-01-11 07:22:01 +01:00
Sebastian Huber
50fbe0d9b4 Add common header.rst to reduce copy and paste 2019-01-09 09:24:02 +01:00
Chris Johns
8b67c9135c user: Add RTEMS executable and test documentation. 2018-11-03 16:36:32 +11:00
Chris Johns
969e60e596 Update the copyright year. 2018-10-19 14:42:12 +11: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
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
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
Chris Johns
efc29ff31b Update copyright notices. 2017-08-11 13:45:52 +10:00
Chris Johns
1accbe31a5 user: Add tool commands to the user manual. 2017-03-15 15:03:41 +11:00
Joel Sherrill
7193f09294 Update document titles for consistency 2017-01-11 19:01:20 -06:00
Chris Johns
aa1c010e31 user: Fix header levels. 2016-11-09 12:20:46 +11:00
Chris Johns
005f0e81ab Fix spelling. 2016-11-02 15:19:42 +11:00
Chris Johns
8da3a62701 Add a Hardware section. 2016-07-06 14:59:00 +10:00
Chris Johns
86518bd3dd Reorganisse the User Manual to make it easier to navigate. 2016-07-04 12:30:09 +10:00
Chris Johns
489740f6a9 Set SPDX License Identifier in each source file. 2016-05-20 12:47:09 +10:00
Chris Johns
c05e43b4a3 User manual, devel install and windows install. 2016-05-02 20:51:26 -04:00
Amar Takhar
5daabd23cf Initial reST documentation using Sphinx. 2016-05-02 20:51:07 -04:00