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.

Sign up for GitHub

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

Jump to bottom

Fix documentation symlinks #2142

Merged
merged 1 commit into from
Aug 23, 2023
Merged

Fix documentation symlinks #2142

merged 1 commit into from
Aug 23, 2023

Conversation

sjanc
Copy link
Contributor

@sjanc sjanc commented Jul 10, 2023 •
edited
Loading

There were typos in symlinks target names resulting in following warrning on checkout (at least in Mynewt newt tool):

  • Warning: stat mynewt/repos/tinyusb/docs/contributing/code_of_conduct.rst: no such file or directory
  • Warning: stat mynewt/repos/tinyusb/docs/info/contributors.rst: no such file or directory

@sjanc
Fix documentation symlinks
4b59cb9 
There were typos in symlinks target names resulting in following
warrning on checkout (at least in Mynewt newt tool):
* Warning: stat mynewt/repos/tinyusb/docs/contributing/code_of_conduct.rst: no such file or directory
* Warning: stat mynewt/repos/tinyusb/docs/info/contributors.rst: no such file or directory
@sjanc
Copy link
Contributor Author

sjanc commented Jul 10, 2023

It seems to be stripped by github preview but those symlinks have garbage suffixes:

[janc@ix tinyusb]$ ls -l docs/contributing/code_of_conduct.rst docs/info/contributors.rst
lrwxrwxrwx. 1 janc janc 26 07-10 16:21 docs/contributing/code_of_conduct.rst -> '../../CODE_OF_CONDUCT.rst'$'\n'
lrwxrwxrwx. 1 janc janc 23 07-10 16:21 docs/info/contributors.rst -> '../../CONTRIBUTORS.rst'$'\n'

@InternetofAwesome
Copy link

InternetofAwesome commented Aug 22, 2023 •
edited
Loading

+1
This would be great to get merged, as we are seeing the same issue, and this change appears to resolve it.
@hathach

hathach
hathach approved these changes Aug 23, 2023
View reviewed changes
Copy link
Owner

@hathach hathach left a comment

Choose a reason for hiding this comment

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

thank you very much for the fix.

@hathach hathach merged commit 7bf5923 into hathach:master Aug 23, 2023
@sjanc sjanc deleted the symlinks branch September 6, 2023 09:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hathach hathach hathach approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sjanc @InternetofAwesome @hathach