Skip to content

Add docs and checks#16

Open
xalbertoisorna wants to merge 6 commits into
developfrom
feature/docs-and-checks
Open

Add docs and checks#16
xalbertoisorna wants to merge 6 commits into
developfrom
feature/docs-and-checks

Conversation

@xalbertoisorna
Copy link
Copy Markdown
Contributor

  • Update .gitignore to include _build and dist directories.
  • Enhance Jenkinsfile with VX4 build stage.
  • Create exclude_patterns.inc for documentation generation.
  • Add lib_unity.rst for project documentation.
  • Introduce CMakeLists.txt and main.c for basic example tests.
  • Implement test_basic.c with unit tests for addition, division, and sine functions.
  • Modify CMakeLists.txt for uut_and_tests to target XK-EVK-XU316.
  • Add settings.yml for project configuration and documentation settings.

@xalbertoisorna xalbertoisorna force-pushed the feature/docs-and-checks branch from 5681c14 to 5051b09 Compare May 21, 2026 15:55
@xalbertoisorna xalbertoisorna changed the title Feature/docs and checks Add docs and checks May 21, 2026
@xalbertoisorna xalbertoisorna marked this pull request as ready for review May 21, 2026 16:05
@xalbertoisorna xalbertoisorna requested a review from Allan-xmos May 22, 2026 07:54
@xalbertoisorna xalbertoisorna requested a review from Allan-xmos May 22, 2026 08:41
@xalbertoisorna xalbertoisorna requested a review from mbanth May 22, 2026 08:44
Copy link
Copy Markdown

@Allan-xmos Allan-xmos left a comment

Choose a reason for hiding this comment

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

One small version to fix, but otherwise good

Comment thread doc/rst/lib_unity.rst Outdated
Copy link
Copy Markdown

@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.

Three minor observations and one question. I see nothing serious enough to hold up completion of this PR.

Comment thread Jenkinsfile
string(
name: 'XMOSDOC_VERSION',
defaultValue: 'v8.2.0',
defaultValue: 'v8.1.0',
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Why has the XMOSDOC version regressed?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This was a mistake from my previous PR (that one did not have docs), latest version is 8.1.0

Comment thread README.rst
:description: A test framework for C, adapted from the Unity test framework
:category: General Purpose
:keywords:
:devices: xcore-200, xcore.ai
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I assume that the omission of xcore-400 comes from a recognition that the processor is not yet generally available. On the other hand, if it's an oversight, I wanted to flag it.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I note that this example is not currently built for XU416. As long as that's the intention, and a later PR will add xcore-400 support, that's not a problem, just an observation.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Adding vx4 build now, that would make sense in this PR.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I note that this example is not currently built for XU416. As long as that's the intention, and a later PR will add xcore-400 support, that's not a problem, just an observation.

Copy link
Copy Markdown
Contributor Author

@xalbertoisorna xalbertoisorna May 22, 2026

Choose a reason for hiding this comment

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

Adding vx4 build now, that would make sense in this PR.

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.

3 participants