Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Address review comments #214

Merged
merged 10 commits into from
Nov 3, 2023
Merged

Address review comments #214

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
90750be
Address review comments
xluciano Nov 2, 2023
0095f79
Exclude more files
xluciano Nov 2, 2023
4e07363
Update doc info
xluciano Nov 2, 2023
093fa23
Remove double underscores
xluciano Nov 3, 2023
9561ee7
Fix text
xluciano Nov 3, 2023
c801ce5
Merge branch 'develop' of github.com:xmos/fwk_rtos into feature/docs
xluciano Nov 3, 2023
bc1f350
Re-instate double underscore
xluciano Nov 3, 2023
96f1f6e
Last changes
xluciano Nov 3, 2023
0373456
Undo change
xluciano Nov 3, 2023
25c1ad2
Undo change
xluciano Nov 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion doc/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
Documentation Source
####################

This folder contains source files for the documentation. The sources do not render well in GitHub or an RST viewer.
This folder contains source files for the documentation and is intended for XMOS users. Pre-built documentation is published on https://www.xmos.com.

The sources do not render well in GitHub or an RST viewer.
In addition, some information is not visible at all and some links will not be functional.

**********************
Expand Down
8 changes: 4 additions & 4 deletions doc/exclude_patterns.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ tools
projects
test
xmos_cmake_toolchain
modules/drivers
modules/**/thirdparty
modules/FreeRTOS
modules/sw_services
build
build_*
CHANGELOG.rst
LICENSE.rst
**README*
**CHANGELOG*
**LICENSE*
**README*
2 changes: 1 addition & 1 deletion doc/programming_guide/platform.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ The `Programming Guide <https://www.xmos.ai/documentation/XM-014363-PC-LATEST/ht
XTC Tools
*********

The xcore processors are accompanied by the `XTC Tools <https://www.xmos.ai/documentation/XM-014363-PC-LATEST/html/tools-guide/index.html#tools-guide>`__. As well as providing a powerful toolchain for application development, the toolkit assists with application deployment and upgrade.
The xcore processors are accompanied by the `XTC Tools <https://www.xmos.ai/documentation/XM-014363-PC-LATEST/html/tools-guide/index.html#tools-guide>`_. As well as providing a powerful toolchain for application development, the toolkit assists with application deployment and upgrade.
2 changes: 1 addition & 1 deletion index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ Framework of FreeRTOS kernel, RTOS drivers, and software service libraries for X
Licensing
*********

This Software is subject to the terms of the `XMOS Public Licence: Version 1 <https://github.com/xmos/sln_voice/blob/develop/LICENSE.rst>`_. Copyrights and licenses for third party components can be found in :ref:`fwk_rtos_copyright`.
This Software is subject to the terms of the `XMOS Public Licence: Version 1 <https://github.com/xmos/sln_voice/blob/develop/LICENSE.rst>`_. Copyrights and licenses for third party components can be found at the end of each guide.
2 changes: 1 addition & 1 deletion test/rtos_drivers/hil/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ To build the test application firmware, run the following command from the top o

bash tools/ci/build_rtos_tests.sh

The ``build_rtos_tests.sh``` script will copy the test applications to the ``dist`` folder.
The ``build_rtos_tests.sh`` script will copy the test applications to the ``dist`` folder.

Run the test with the following command from the top of the repository:

Expand Down
2 changes: 1 addition & 1 deletion test/rtos_drivers/usb/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ run the following command from the root of this repository:

bash tools/ci/build_rtos_tests.sh

The ``build_rtos_tests.sh``` script will copy the test applications to the ``dist`` folder.
The ``build_rtos_tests.sh`` script will copy the test applications to the ``dist`` folder.

*************
Running Tests
Expand Down
3 changes: 1 addition & 2 deletions test/rtos_drivers/usb/serial_send_receive.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
import serial
import serial.tools.list_ports
import argparse
import time

# USB VID:PID for test application
vid=0x20B1
Expand Down Expand Up @@ -86,4 +85,4 @@ def main(if0, if1, of0, of1):
if __name__ == "__main__":
args = parse_arguments()

main(args.if0, args.if1, args.of0, args.of1)
main(args.if0, args.if1, args.of0, args.of1)