Skip to content

Conversation

galak
Copy link
Contributor

@galak galak commented Mar 18, 2021

Github has deprecated add-path, so update the workflows that use it to
the new method of setting the PATH.

Signed-off-by: Kumar Gala [email protected]

@galak galak requested a review from nashif as a code owner March 18, 2021 11:38
@galak galak requested a review from joerchan March 18, 2021 11:39
@joerchan
Copy link
Contributor

Not sure I'm the best to approve this, I don't know this part.

Is this a backport of an existing commit in master? Maybe add a reference to it?

@galak galak changed the title ci: github: Update for deprecation of add-path ci: github: Update for deprecation of add-path (backport some fixes to doc/zephyr.doxyfile.in) Mar 18, 2021
galak and others added 3 commits March 18, 2021 07:33
Github has deprecated add-path, so update the workflows that use it to
the new method of setting the PATH.

[Backport of fabf403]

Signed-off-by: Kumar Gala <[email protected]>
Noticed those with most recent doxygen, we do not use those options, so
it is safe to remove now.

[Backport of f2b04d9]

Signed-off-by: Anas Nashif <[email protected]>
Signed-off-by: Kumar Gala <[email protected]>
I've been seeing these cause errors on the more recent versions of
Doxygen which come with Arch Linux for a while now. Fix these:

error: Illegal format for option TCL_SUBST, no equal sign ('=') specified for item 'YES'
$ZEPHYR_BASE/tests/kernel/mem_protect/futex/src/main.c:461: warning: end of file with unbalanced grouping commands

Just trying to get them out of my local output and as preparation for
whenever they start showing up for Ubuntu.

[Backport of ededeb2]

Signed-off-by: Martí Bolívar <[email protected]>
@galak galak force-pushed the backport-doc-fix branch from 6323322 to ad79afe Compare March 18, 2021 12:33
@galak
Copy link
Contributor Author

galak commented Mar 18, 2021

Not sure I'm the best to approve this, I don't know this part.

Is this a backport of an existing commit in master? Maybe add a reference to it?

Add references in the commit messages.

Builds of docs with doxygen 1.8.16 has a number of warnings of the form:
'warning: unbalanced grouping commands'.  Fix those warnings be either
balancing the group command or removing it.

[Backport of a8171db]

Signed-off-by: Kumar Gala <[email protected]>
@galak galak requested a review from gmarull March 19, 2021 13:04
@galak
Copy link
Contributor Author

galak commented Mar 19, 2021

@gmarull any thoughts on what's going on with the docs build issue with tests/kernel/common/src/intmath.c

@gmarull
Copy link
Member

gmarull commented Mar 23, 2021

@galak I can't see anything suspicious on that file. Does it only happen on new Doxygen versions?

@galak
Copy link
Contributor Author

galak commented Mar 26, 2021

@galak I can't see anything suspicious on that file. Does it only happen on new Doxygen versions?

No idea, whatever version of doxygen is getting used by the ci check. Looks like 1.8.17

@nashif
Copy link
Member

nashif commented Apr 8, 2021

maybe we should just exclude doxygen building tests in the branch now and get this going:

diff --git a/doc/zephyr.doxyfile.in b/doc/zephyr.doxyfile.in
index 49d78b92cf..e63a8ae069 100644
--- a/doc/zephyr.doxyfile.in
+++ b/doc/zephyr.doxyfile.in
@@ -762,8 +762,7 @@ INPUT                  = @ZEPHYR_BASE@/include/ \
                          @ZEPHYR_BASE@/include/arch/nios2/ \
                          @ZEPHYR_BASE@/lib/libc/minimal/include/ \
                          @ZEPHYR_BASE@/include/net/dns_resolve.h \
-                        @ZEPHYR_BASE@/subsys/testsuite/ztest/include/ \
-                        @ZEPHYR_BASE@/tests/kernel/
+                        @ZEPHYR_BASE@/subsys/testsuite/ztest/include/

@galak
Copy link
Contributor Author

galak commented Apr 8, 2021

maybe we should just exclude doxygen building tests in the branch now and get this going:

No issue w/me, what implication does this have when we release the next v1.14.x version for docs on release?

@nashif
Copy link
Member

nashif commented Apr 9, 2021

No issue w/me, what implication does this have when we release the next v1.14.x version for docs on release?

none, we do not link the tests in documentation, it is only available in doxygen output and was added just to make sure structure is correct. We can also fix that later, right now however this will unblock all those 1.14 PRs

We are running into a doxygen error with intmath.c from
tests/kernel/common/src/.

intmath.c:29: warning: member with no name found.

Drop tests/kernel from the doxygen input path for now.

Signed-off-by: Kumar Gala <[email protected]>
@galak
Copy link
Contributor Author

galak commented Apr 9, 2021

none, we do not link the tests in documentation, it is only available in doxygen output and was added just to make sure structure is correct. We can also fix that later, right now however this will unblock all those 1.14 PRs

Pushed that change into the PR.

@galak galak merged commit af56a6b into zephyrproject-rtos:v1.14-branch Apr 9, 2021
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.

5 participants