Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

runtime-linux.md: terms "source" and "destination" are very unclear for symlinks #1165

Open
safinaskar opened this issue Oct 30, 2022 · 4 comments

Comments

@safinaskar
Copy link

I'm reading https://github.com/opencontainers/runtime-spec/blob/main/runtime-linux.md . When I first time saw this table with columns "source" and "destination", I thought that there is an error, i. e. columns are swapped. Then I understand that there is no error here. Still I think that terms "source" and "destination" are very confusing, so, please, use some alternate terms, for example "link" and "pointee", "pointer" and "pointee", "link" and "object", etc. I prefer "link" and "object"

@tianon
Copy link
Member

tianon commented Oct 31, 2022

Maybe we should go with target and linkpath so that we unambiguously match the Linux symlink(2) and symlinkat(2) terms?

https://man7.org/linux/man-pages/man2/symlinkat.2.html

@safinaskar
Copy link
Author

@tianon , target and linkpath are very ambiguous

@tianon
Copy link
Member

tianon commented Nov 2, 2022 via email

@safinaskar
Copy link
Author

@tianon , I still think that we should just use some unambiguous clear words instead of using "official" ones and inviting a user to follow some documentation. That manual page ( https://man7.org/linux/man-pages/man2/symlinkat.2.html ) is bad, too, and similarly should be fixed.

Also, please note that terms "target" and "linkpath" are not "official" in any way. This is just terms used by author of that manual page. My local copy of unistd.h file uses terms __from and __to. Linux kernel source uses terms oldname and newname: https://elixir.bootlin.com/linux/v6.1-rc3/source/fs/namei.c#L4449 . POSIX uses terms path1 and path2: https://pubs.opengroup.org/onlinepubs/9699919799/functions/symlink.html . So, there is no any "official" terms. I propose using terms, which people (hopefully) will understand: "object" and "link"

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants