rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-05-15 04:46:59 +08:00
Code Issues Packages Projects Releases Wiki Activity
652 Commits 3 Branches 7 Tags
Commit Graph

49 Commits

Author SHA1 Message Date
Sebastian Huber
1d48fb5a00 bsp-howto: Move BSP Doxygen recommendations 
Update #3704.
 2019-04-04 07:40:18 +02:00
Sebastian Huber
15f4670277 bsp-howto: Update I2C chapter 
Update ##3725.
 2019-03-18 09:54:04 +01:00
Sebastian Huber
4480a83312 bsp-howto: Update SPI chapter 
Update #3724.
 2019-03-18 09:54:04 +01: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
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
362ae6861e bsp-howto: Fix URLs 2019-01-31 07:38:51 +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
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
50fbe0d9b4 Add common header.rst to reduce copy and paste 2019-01-09 09:24:02 +01: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
c765aa0357 bsp-howto: Mention clock driver hook removal 
Update #3436.
 2018-06-26 11:18:52 +02:00
Sebastian Huber
cb0f55a4b8 Update due to BSP source reorganization 
This patch is a part of the BSP source reorganization.

Close #3285.
 2018-04-27 12:49:57 +02:00
Sebastian Huber
676d3d5d28 bsp-howto: Avoid :file: role with ${...} 
The curly braces have a special meaning in the :file: role.

This patch is a part of the BSP source reorganization.

Update #3285.
 2018-04-23 07:54:20 +02:00
Sebastian Huber
300cc6806c bsp-howto: Update BSP source code structure 
This patch is a part of the BSP source reorganization.

Update #3285.
 2018-04-20 15:04:08 +02:00
Sebastian Huber
70f23e475b Clarify INTERNAL_ERROR_ARC4RANDOM_GETENTROPY_FAIL 
Update #3239.
 2017-11-20 08:08:30 +01:00
Christian Mauderer
d0b961ac34 bsp-howto: Add getentropy. 
Update #3239.
 2017-11-17 07:47:38 +01:00
Martin Erik Werner
c6066d4532 bsp-howto/console: Move misplaced var. in example 
Signed-off-by: Martin Erik Werner <martinerikwerner@gmail.com>
 2017-11-16 09:54:25 +01:00
Chris Johns
42d50d760e Add indexes to all documents. 
Update #3229.
 2017-11-12 10:32:39 +11:00
Joel Sherrill
13a15f908d Shorten BSP and Driver Guide name (missed commit) 
Updates #3141.
 2017-10-12 19:02:11 -05:00
Joel Sherrill
c6f8e512b9 Shorten the name of the BSP and Device Driver Development Guide 
Old name:

    RTEMS BSP and Device Driver Development Guide

This is long and causes problems in the PDF output. This patch
changes the name to:

    RTEMS BSP and Driver Guide

Closes #3141.
 2017-10-12 18:53:35 -05:00
Sebastian Huber
27515eceb2 bsp-howto: Clock_driver_support_install_isr() 
Close #3139.
 2017-09-18 08:31:09 +02:00
Chris Johns
efc29ff31b Update copyright notices. 2017-08-11 13:45:52 +10:00
Sebastian Huber
bbdf66cd58 bsp: Optional clock driver shutdown 2017-08-04 14:26:36 +02:00
Sebastian Huber
f7a2dcf1cc bsp-howto: Warn about TERMIOS_TASK_DRIVEN 
Update #2935.
 2017-06-08 09:41:33 +02:00
Chris Johns
ad5d63277c waf: Cleaner formatting to see the importing. 2017-03-27 10:25:25 +11:00
Chris Johns
f97be09daf Use a single top level version number. 2017-03-20 12:18:53 +11:00
Joel Sherrill
7193f09294 Update document titles for consistency 2017-01-11 19:01:20 -06:00
Sebastian Huber
5bb51a43d1 Update Console Driver chapter 
Close #2785.
Close #2838.
 2016-12-23 14:38:35 +01:00
Sebastian Huber
3b42c96764 Strip down BSP Introduction 
Update #2852.
 2016-12-21 11:34:14 +01:00
Sebastian Huber
c8aecf996c Add warnings to basic BSP chapters 
Update #2852.
 2016-12-21 11:34:14 +01:00
Sebastian Huber
02d17023c1 Move Shared Memory Support Driver chapter 
This chapter is very specific.  Move it to a less prominent chapter
position.
 2016-12-21 11:34:14 +01:00
Sebastian Huber
b0513c8382 Move Ada95 Interrupt Support chapter 
This chapter is very specific.  Move it to a less prominent chapter
position.
 2016-12-21 11:34:14 +01:00
Sebastian Huber
9038b999f7 Add warning to Timer Driver chapter 
Move Timer Driver chapter.

Update #2847.
 2016-12-21 11:34:14 +01:00
Sebastian Huber
4af69ea42a Add warning to ATA/IDE driver chapter 
Close #2849.
 2016-12-21 11:34:14 +01:00
Sebastian Huber
003ee4d27d Remove Non-Volatile Memory Driver chapter 
There exists no standard Non-Volatile Memory Driver in the RTEMS code
base.

Close #2851.
 2016-12-21 11:34:14 +01:00
Sebastian Huber
5b8d5d06c1 Remove Discrete Driver chapter 
There exists no standard Discrete Driver in the RTEMS code base.

Close #2851.
 2016-12-21 11:34:14 +01:00
Sebastian Huber
4b5b49988d Remove Analog Driver chapter 
There exists no standard Analog Driver in the RTEMS code base.

Close #2850.
 2016-12-21 11:34:14 +01:00
Sebastian Huber
7351405fe6 Document I2C framework 
Update #2845.
 2016-12-21 11:34:13 +01:00
Sebastian Huber
0cb2748a11 Document SPI framework 
Update #2776.
 2016-12-21 11:34:13 +01:00
Sebastian Huber
45dc7c7ba5 Update version/revision to 4.11.99 2016-12-21 11:32:51 +01:00
Sebastian Huber
e7f40f04d3 Rework Clock Driver chapter 
Update #2737.
 2016-12-21 11:08:32 +01:00
Chris Johns
23995ef43f bsp-howto: Increase the number depth of sections. 2016-11-09 13:55:30 +11:00
Chris Johns
cc1d3facbe bsp-howto: Fix header levels. 2016-11-09 12:33:08 +11:00
Chris Johns
72a62ad88f Rename all manuals with an _ to have a -. It helps released naming of files. 2016-11-03 16:58:08 +11:00