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

835 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Utkarsh Rai
b22c1e12ae Chapter-on-need-for-RTEMS-specific-cross-compiler 
Removed '-' character and provided definition list format
 2020-04-04 22:19:46 -06:00
Gedare Bloom
fb3644c14b common: fix title page 
Sphinx changed the default behavior of maketitle. Provide our
own rtemsmaketitle command and use it instead.
 2020-04-04 10:14:47 +11:00
Chris Johns
ec9457f604 Add a release procedure section. 2020-04-04 10:14:11 +11:00
Gedare Bloom
44fde6c3be Update top-level copyrights 2020-04-03 12:44:31 -06:00
Vaibhav Gupta
53217a9940 RTEMS Docs: Add steps for sphinxcontrib-bibtex 
Add step to install sphinxcontrib-bibtex
together with the steps mentioned for ArcLinux,
to install sphinx and dependencies.

Signed-off-by: Vaibhav Gupta <vaibhavgupta40@gmail.com>
 2020-04-03 12:13:42 -06:00
Chris Johns
d514e3308e waf: User friendly message when no sphinx is installed 2020-04-03 11:11:11 +11:00
Chris Johns
3f1622e40e Add virtualenv to the README.txt as the preferred host support. 2020-04-03 11:11:11 +11:00
Mritunjay
edfc90253b doc: Moving M68K BSP Content to User Manual (#3905) 
Fixed trailing spaces.
 2020-04-03 08:47:01 +11:00
Gedare Bloom
d4d30673d0 user/start/gsoc: fix unicode error and grammar typo 2020-04-02 12:14:51 -06:00
Gedare Bloom
3a19619f44 start/index: relocate gsoc section 2020-04-02 09:35: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
G S Niteesh Babu
7fd137e95f user/bsp-build: Fix broken cross references. 
The QuickStartBSPBuild_Manual and QuickStartBSPBuild_RSB are
missing the underscore in front. This breaks any reference to
them from other sections.
 2020-04-02 09:27:54 -06:00
Gedare Bloom
7a0834dc38 start/user: describe version numbers and releases 
Closes #2562.
 2020-04-02 09:27:54 -06:00
Mritunjay
f682984429 user/rsb: Fix typos (#3922) 
Closes #3922
 2020-04-02 20:15:46 +11:00
Sebastian Huber
2c7cd341a0 eng: Add documentation guidelines 
Start with templates for the application configuration options.

Remove "Format to be followed for making changes in this file" from
c-user.

Update #3910.
 2020-04-02 10:23:36 +02:00
Sebastian Huber
c95e3e3114 c-user: Move CONFIGURE_MAXIMUM_PRIORITY 
Move this option to the scheduler configuration options.

Update #3836.
 2020-04-02 09:46:27 +02:00
Sebastian Huber
39ca06c492 c-user: Clarify config options use 
Update #3836.
 2020-04-02 09:46:01 +02:00
Sebastian Huber
6f0bc56893 eng: Add glossary terms 
Define the following terms:

* assembler language
* C language
* ELF
* interrupt service
* software component
* software unit

Clarify:

* task

Update #3715.
 2020-04-01 07:49:15 +02:00
Sebastian Huber
4032c96da9 c-user: Document all configuration options 
Close #2806.
 2020-04-01 07:49:15 +02:00
Sebastian Huber
7bad8940ad c-user: Use new template for integer config opts 
Try to bring all descriptions up to date.  Add cross-references to
several options.  Clarify configuration value constraints.

Use this template also for initializer type options.

Close #3901.
 2020-04-01 07:49:12 +02:00
Sebastian Huber
e26f87497e c-user: Avoid self references 
Update #3900.
 2020-03-30 11:49:58 +02:00
Sebastian Huber
2f18a530bc c-user: Use new template for feature config opts 
Update #3900.
 2020-03-30 11:14:41 +02:00
Sebastian Huber
0103b685c6 c-user: Fix typo in file name 
Update #3836.
 2020-03-30 08:49:05 +02:00
Sebastian Huber
ae84edd723 user: Use consistent Hello World spelling 2020-03-30 07:55:40 +02:00
Sebastian Huber
03e61e9494 user: Provide a user friendly configuration 2020-03-30 07:55:27 +02:00
Sebastian Huber
62d58f229f c-user: Document new event record config options 
Update #3904.
 2020-03-24 07:48:40 +01:00
Sebastian Huber
dfe0ec05b9 c-user: Use new template for feature config opts 
Try to bring all descriptions up to date.  Add cross-references to
several options.

Close #3900.
 2020-03-24 07:48:21 +01:00
Joel Sherrill
927b004646 posix-compliance: Add some missing methods 2020-03-21 13:04:34 -05:00
Joel Sherrill
87e49d4cf9 gdbarmsim: Remove all references to this deleted BSP family 
Updates #3611.
 2020-03-20 09:22:29 -05:00
Joel Sherrill
4dc93a1ee7 user/hosts/posix.rst: Add CentOS 8 information 2020-03-20 08:39:27 -05:00
Sebastian Huber
aceadb15d6 eng: Add Python development guidelines 2020-03-19 07:41:30 +01:00
G S Niteesh Babu
979c5b22e8 user/raspberrypi: Fix typo 
enable-uart should be enable_uart in config.txt
 2020-03-19 07:11:07 +01:00
Sebastian Huber
79fb6fddf8 c-user: Canonicalize configuration option groups 
Update #3836.
 2020-03-18 07:32:26 +01:00
Sebastian Huber
7a8d697d73 c-user: Add reference to proxies 
Update #3836.
 2020-03-17 15:26:46 +01:00
Sebastian Huber
f75e0bee48 c-user: Fix format 
Update #3836.
 2020-03-17 15:05:57 +01:00
Sebastian Huber
5e54ffe819 c-user: Add configuration option index entry 
Update #3836.
 2020-03-17 15:05:32 +01:00
Sebastian Huber
c3ebd832d2 c-user: Fix sorting in filesystem configuration 
Update #3836.
 2020-03-17 14:41:37 +01:00
Sebastian Huber
5fb9a1c75d c-user: Add missing configuration option notes 
Update #3836.
 2020-03-17 14:23:41 +01:00
Sebastian Huber
f3076bcd52 c-user: Sort configuration options alphabetically 
Update #3836.
 2020-03-17 14:11:26 +01:00
Sebastian Huber
1ce24d319a c-user: Obsolete CONFIGURE_MAXIMUM_DEVICES 
Close #3898.
 2020-03-13 13:27:30 +01:00
Sebastian Huber
ccc58a5c66 c-user: Fix typos 2020-03-13 13:27:16 +01:00
Sebastian Huber
b34f2deba8 c-user: Reorder configuration option groups 
Sort the configuration option groups according to the likelihood a user
will define options of a group.

Update #3836.
 2020-03-13 13:20:20 +01:00
Sebastian Huber
03a735f896 c-user: Clarify message buffer configuration 
The help macro CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE() is not a
configuration option.  Move it into the documentatation of the
CONFIGURE_MESSAGE_BUFFER_MEMORY configuration option.  Move this option
to the general system configuration group.

Update #3836.
 2020-03-13 13:20:20 +01:00
Sebastian Huber
a7991aebae c-user: Add copyright information 
Add copyright information according to commit in RTEMS main repository:

    commit e53aae2676c42cda521328504f82d26c33827021
    Author: Gedare Bloom <gedare@rtems.org>
    Date:   Mon Mar 26 16:42:38 2012 -0400

    confdefs: Add declaration for unlimited objects.

    Adds to confdefs a way to specify rtems_resource_unlimited for classic and
    posix objects using a new macro CONFIGURE_OBJECTS_UNLIMITED.
    Use CONFIGURE_OBJECTS_ALLOCATION_SIZE to declare the allocation size for
    extending the set of objects at runtime. Updates the unlimited sample
    to demonstrate how to use the new macros. Also adds new documentation in
    the C User's Manual regarding configuring with unlimited objects.
 2020-03-13 13:20:20 +01: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
1b2a7c8baf user: Update Quick Start Guide reference. 2020-03-13 08:19:20 +11:00
Chris Johns
19af6b47d5 waf: Get the version numbers from the version file. 2020-03-13 08:18:36 +11:00
Chris Johns
7b53b604c5 user: Add anchors to some BSPs. 2020-03-13 08:18:36 +11:00
Chris Johns
5bd9f4dff4 sphinx: Add a custom highlight colour 
Update #2998
 2020-03-13 08:18:36 +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