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

doc: ext: link-roles: allow non-default baseurl #28245

Merged
merged 1 commit into from
Sep 18, 2020

Conversation

utzig
Copy link
Member

@utzig utzig commented Sep 9, 2020

Link roles, aka :zephyr_file: and :zephyr_raw: use a repo's git describe information to create links but the baseurl is fixed to the upstream repo. This breaks links created in repos that are forks located somewhere else.

This commits tries to get the baseurl from west if available so it will work correctly for forks. If fallbacks to the upstream repo if no information can be gathered by West, or West is not available.

Copy link
Contributor

@mbolivar-nordic mbolivar-nordic left a comment

Choose a reason for hiding this comment

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

ERROR   - /workdir/zephyr/tests/benchmarks/footprints/testcase.yaml: can't load (skipping): <SchemaError: error code 2: Schema validation failed:
 - Key 'arch_whitelist' was not defined. Path: '/tests/benchmark.kernel.footprints.userspace'.: Path: '/'>

CI errors look unrelated. Not sure if someone else sent the hotfix already.

doc/extensions/zephyr/link-roles.py Show resolved Hide resolved
@utzig utzig force-pushed the link-roles-baseurl branch from bc2d652 to c8229b2 Compare September 9, 2020 21:01
Link roles, aka :zephyr_file: and :zephyr_raw: use a repo's git describe
information to create links but the baseurl is fixed to the upstream
repo. This breaks links created in repos that are forks located
somewhere else.

This commits tries to get the baseurl from west if available so it will
work correctly for forks. If fallbacks to the upstream repo if no
information can be gathered by West, or West is not available.

Signed-off-by: Fabio Utzig <[email protected]>
@carlescufi carlescufi merged commit ae8dd14 into zephyrproject-rtos:master Sep 18, 2020
@utzig utzig deleted the link-roles-baseurl branch October 26, 2020 10:03
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