Skip to content

symlink: touch-up documentation#138

Merged
thaJeztah merged 1 commit intomoby:mainfrom
thaJeztah:fix_symlink_docs
Jul 16, 2024
Merged

symlink: touch-up documentation#138
thaJeztah merged 1 commit intomoby:mainfrom
thaJeztah:fix_symlink_docs

Conversation

@thaJeztah
Copy link
Copy Markdown
Member

@thaJeztah thaJeztah commented Jul 3, 2024

symlink: touch-up documentation

  • Fix references to EvalSymlinksInScope, which is non-exported
  • Add relevant links to original implementation / introduction of the code to allow comparing the fork with the original upstream code.
  • Move GoDoc from the non-exported evalSymlinksInScope function to the exported FollowSymlinkInScope.
  • Remove the README.md, instead using doc.go to provide the package description.

Before:

Screenshot 2024-07-03 at 10 40 53

After:

Screenshot 2024-07-03 at 13 05 58

- Fix references to EvalSymlinksInScope, which is non-exported
- Add relevant links to original implementation / introduction of the
  code to allow comparing the fork with the original upstream code.
- Move GoDoc from the non-exported evalSymlinksInScope function to
  the exported FollowSymlinkInScope.
- Remove the README.md, instead using doc.go to provide the package
  description.

Signed-off-by: Sebastiaan van Stijn <[email protected]>
@thaJeztah thaJeztah self-assigned this Jul 3, 2024
@thaJeztah thaJeztah requested review from kolyshkin and vvoland July 3, 2024 11:12
Comment thread symlink/doc.go
Comment on lines +6 to +7
// Read the [LICENSE.BSD] file that governs fs.go and [LICENSE.APACHE] for
// fs_unix_test.go.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Can/should we add references to the files we're talking about (i.e. fs.go -> [fs.go])?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I was considering that initially, but didn't know what the most suitable link for that would be (linking to main could cause the link to break potentially, and linking to a versioned one could be confusing when linking from version X to version "old"), so I "somewhat" kept that an exercise to the user for now.

Copy link
Copy Markdown
Collaborator

@kolyshkin kolyshkin left a comment

Choose a reason for hiding this comment

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

LGTM

@thaJeztah
Copy link
Copy Markdown
Member Author

I'll bring this one in; will also have a look at possibly doing some patch releases with our latest changes (but need to check how important they are).

@thaJeztah thaJeztah merged commit cafbe42 into moby:main Jul 16, 2024
@thaJeztah thaJeztah deleted the fix_symlink_docs branch July 16, 2024 17:22
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.

symlink: docs need an update

2 participants