blob: 6c0a69e303fb6823708c8005ebbf833c972ddd8b (
plain) (
tree)
|
|
# RTEMS Specification Items and Qualification Tools
This repository contains a prototype of the RTEMS specification and tools to
generate content from the specification. It demonstrates the use of Python
development tools such as yapf, flake8, mypy, pylint, pytest, and coverage.
## Repository Overview
* env - contains the Python environment (created by `make env`)
* spec - contains the specification items
* rtemsspec - contains the `rtemsspec` Python package
* tests - contains Python unit tests
* modules - contains Git submodules
* rsb - contains the RTEMS Source Builder as a Git submodule
* rtems - contains the RTEMS sources as a Git submodule
* rtems-docs - contains the RTEMS documentation sources as a Git submodule
* `rtems_spec_to_x.py` - a command line tool to generate content from the
specification
## Getting Started
Copy the sanity check script at least to the pre-push hook (optional also to
the pre-commit hook):
```
cp git-hooks/sanity-check.sh .git/hooks/pre-push
```
Run
```
git submodule init
git submodule update
```
to initialize the Git submodules. Run
```
make env
```
to set up the Python environment. Activate the Python environment afterwards
with
```
. env/bin/activate
```
If submodule URLs changed after a pull use
```
git submodule sync
```
to activate the new URLs.
## Specification Items
The
[specification items](https://docs.rtems.org/branches/master/eng/req-eng.html#specification-items)
are located in the `spec` directory. You can use a text editor to work with
them.
## Specification-To-X Tool
The command line tool `rtems_spec_to_x.py` generates content from the
specification. The tool is configured by the `config.ini` configuration file.
This is a prototype implementation. It demonstrates the generation of a
project-wide glossary (`external/rtems-docs/c-user/glossary.rst`) and
document-specific glossaries (`external/rtems-docs/eng/glossary.rst`) from
glossary specification items (glossary groups and terms in `spec/glos`).
Example:
```
$ ./rtems_spec_to_x.py
$ git status
On branch master
Your branch is up to date with 'origin/master'.
nothing to commit, working tree clean
$ sed -i 's/Binary/Boom/' spec/glos/term/abi.yml
$ ./rtems_spec_to_x.py
$ git status
On branch master
Your branch is up to date with 'origin/master'.
Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git checkout -- <file>..." to discard changes in working directory)
(commit or discard the untracked or modified content in submodules)
modified: external/rtems-docs (modified content)
modified: spec/glos/term/RTEMS-GLOS-TERM-ABI.yml
no changes added to commit (use "git add" and/or "git commit -a")
$ cd external/rtems-docs
$ git diff
diff --git a/c-user/glossary.rst b/c-user/glossary.rst
index d0996e8..dfac60c 100644
--- a/c-user/glossary.rst
+++ b/c-user/glossary.rst
@@ -10,7 +10,7 @@ Glossary
:sorted:
ABI
- An acronym for Application Binary Interface.
+ An acronym for Application Boom Interface.
active
A term used to describe an object which has been created by an
diff --git a/eng/glossary.rst b/eng/glossary.rst
index c58e67f..ac2c8f8 100644
--- a/eng/glossary.rst
+++ b/eng/glossary.rst
@@ -9,7 +9,7 @@ Glossary
:sorted:
ABI
- An acronym for Application Binary Interface.
+ An acronym for Application Boom Interface.
API
An acronym for Application Programming Interface.
```
## Unit Tests and Static Analysers
Run the unit tests and static analysers with:
```
make
```
You can get a branch coverage report with:
```
$ make coverage-report
coverage report -m --include=...
Name Stmts Miss Branch BrPart Cover Missing
---------------------------------------------------------------------
rtemsspec/__init__.py 8 0 0 0 100%
rtemsspec/applconfig.py 130 0 53 0 100%
rtemsspec/build.py 36 0 14 0 100%
rtemsspec/content.py 133 0 44 0 100%
rtemsspec/glossary.py 70 0 31 0 100%
rtemsspec/items.py 139 0 46 0 100%
rtemsspec/util.py 26 0 2 0 100%
---------------------------------------------------------------------
TOTAL 542 0 190 0 100%
```
## Contributing
Please read
[Support and Contributing](https://docs.rtems.org/branches/master/user/support/index.html).
For the ESA activity do not push to the `esa` branch directly. Instead always
work on topic branches and use merge requests, for example:
```
git push -o merge_request.create topic-branch
```
## License
This project is licensed under the
[BSD-2-Clause](https://spdx.org/licenses/BSD-2-Clause.html) or
[CC-BY-SA-4.0](https://spdx.org/licenses/CC-BY-SA-4.0.html).
|
