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.

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

Pre-release v3.0.5 #207

Merged
merged 63 commits into from
Nov 3, 2023
Merged

Pre-release v3.0.5 #207

merged 63 commits into from
Nov 3, 2023

Conversation

xluciano
Copy link
Contributor

@xluciano xluciano commented Oct 25, 2023

  • FIXED: Added dummy definitions of vTaskCoreAffinitySet() and vTaskCoreAffinitySet() functions to
    avoid warnings when configNUM_CORES is set to 1.

This PR includes the documentation updates needed to use xmosdoc v4.

Part of https://xmosjira.atlassian.net/browse/AP-236

@xluciano xluciano requested a review from mbanth October 25, 2023 09:56
@mbanth mbanth assigned xluciano and unassigned mbanth Oct 25, 2023
Copy link
Collaborator

@mbanth mbanth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have only very minor comments and some questions.

doc/README.rst Show resolved Hide resolved
@@ -1,6 +1,5 @@
.. _fwk_rtos_copyright:

.. include:: ../_templates/disclaimer.rst
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why has the disclaimer been removed?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@BrennanGit, can you answer the question above?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These days we don't autogenerate a disclaimer, in general moving away from autogenerated pages.
The alternative is to use a set of substitutions like we see in fwk_core: https://raw.githubusercontent.com/xmos/fwk_core/develop/doc/shared/legal.rst

Not sure why it wasn't added here, happy to do so if required.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As with fwk_core, we should include in fwk_rtos (and fwk_io if it's not already there):

Copyright & Disclaimer
======================

|XMOS copyright|

|XMOS disclaimer|

|XMOS trademarks|

This text appears above the Licence section.

test/rtos_drivers/usb/serial_send_receive.py Outdated Show resolved Hide resolved
test/rtos_drivers/wifi/check_wifi.sh Show resolved Hide resolved
@xluciano xluciano requested a review from ed-xmos November 2, 2023 09:52
doc/README.rst Show resolved Hide resolved
tools
projects
test
xmos_cmake_toolchain
modules/drivers
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How come this has been excluded?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reckon it was to avoid building the documents inside that repo. Do you think we should include that folder?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is an important part of the package. So yes.

Copy link
Contributor

@ed-xmos ed-xmos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor changes only which I have suggested. Approving and will trust you to address them.

@xluciano xluciano merged commit 4f614a7 into release/v3.0.5 Nov 3, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants