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: fix the reference to libcoap removal commit in LOSTANDFOUND.md #17371

Merged
merged 1 commit into from Dec 9, 2021

Conversation

gschorcht
Copy link
Contributor

Contribution description

This PR fixes the the reference to the commit for removing the libcoap package in LOSTANDFOUND.md.

With PR #17163 for removing the libcoap package, the file LOSTANDFOUND.md was updated to reference the corresponding commit. However, when the PR was merged, the commit got a different ID. Thus, the reference in LOSTANDFOUND.md was wrong.

Testing procedure

make doc with doxygen 1.9.2 or 1.8.17 and check doc/doxygen/html/md_LOSTANDFOUND.html

Without the PR, the term in brackets is just a text, with this PR it is a link.

pkg/libcoap [d83d08f0995a88f399e70a7d07b44dd780082436]

Issues/PRs references

Found when investigating issue #17063

With PR RIOT-OS#17163 for removing `libcoap`, the file `LOSTANDFOUND.md` was updated to reference the commit for removing `libcoap`. However, when the PR was merged, the commit was given a different ID.
@github-actions github-actions bot added the Area: doc Area: Documentation label Dec 9, 2021
@gschorcht gschorcht added CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors) labels Dec 9, 2021
@gschorcht gschorcht requested a review from maribu December 9, 2021 15:41
@benpicco benpicco merged commit eba1f09 into RIOT-OS:master Dec 9, 2021
@maribu
Copy link
Member

maribu commented Dec 9, 2021

@maribu
Copy link
Member

maribu commented Dec 9, 2021

The old commit ID was the commit was the one that removed the package: d83d08f

The new commit ID is the merge commit: e89eebc

Both should be fine

@gschorcht
Copy link
Contributor Author

Still no link: https://14304-7370241-gh.circle-artifacts.com/0/doc/md_LOSTANDFOUND.html

Strange.

The old commit ID was the commit was the one that removed the package: d83d08f
The new commit ID is the merge commit: e89eebc
Both should be fine

Indeed, my fault, I really thought that the problem was the commit ID. At least my change doesn't make it worse.

So the question is why this entry doesn't work at all, aside from the fact that we have a problem with Doxygen version 1.9.1 used for https://doc.riot-os.org.

@miri64
Copy link
Member

miri64 commented Dec 10, 2021

The reference needs to be added to the list of references at the end of the file...

@gschorcht
Copy link
Contributor Author

The reference needs to be added to the list of references at the end of the file...

OK, I see. I didn't move to bottom of the file because the first entry was the problem 😎 I will provide a change with a new PR.

@gschorcht gschorcht deleted the doc/fix_libcoap_removal_commit branch December 10, 2021 18:05
@fjmolinas fjmolinas added this to the Release 2022.01 milestone Jan 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants