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

pages/osx/*: update broken links #12873

Closed
wants to merge 11 commits into from
Closed

Conversation

spageektti
Copy link
Member

@spageektti spageektti commented Jun 1, 2024

#12808

  • For airport I don't know if this is OK because the man page seems empty.
  • For bnepd I removed the link.
  • Starting on macOS Ventura (13) emond has been removed according to this page so I suggest removing the page or removing the link but need your opinion.
  • For safeejectgpu I updated the link.
  • I suggest deleting the page for shuf as it seems no longer being available for macos but need your opinion.
  • For tail I fixed the link.
  • whence and yaa don't have a macos man page either.
  • this is a windows one but reg-flags seems to no longer exist (edit: it exists but don't have a manual) so I suggest deletion or removing the link.

I don't know if this is OK because the man page seems empty.
@github-actions github-actions bot added the page edit Changes to an existing page(s). label Jun 1, 2024
@spageektti spageektti mentioned this pull request Jun 1, 2024
60 tasks
@tricantivu
Copy link
Member

tricantivu commented Jun 5, 2024

AFAIK, More information links are mandatory. If one cannot be found, I suggest removing the page.

The page of the command whence might be documenting the ZSH implementation since its the default shell in Mac OS X. Therefore, I suggest using the link https://zsh.sourceforge.io/Doc/Release/Shell-Builtin-Commands.html#Shell-Builtin-Commands#whence.

Regarding shuf, I think we should use a BSD manual because of the operating system's relationship with Mac OS X or a GNU manual given there are long options in some command examples.

@spageektti
Copy link
Member Author

spageektti commented Jun 5, 2024

I think that more information links are not so mandatory. In the case of the daemon commands It's OK to delete the pages. I will look for documentation for other commands tomorrow.

@sebastiaanspeck
Copy link
Member

I think that more information links are not so mandatory. In the case of the daemon commands It's OK to delete the pages. I will look for documentation for other commands tomorrow.

I disagree. Every page should have a more information link, it doesn't have to be a documentation page, but at least it should be findable on the internet

@sebastiaanspeck sebastiaanspeck added waiting Issues/PRs with Pending response by the author. review needed Prioritized PRs marked for reviews from maintainers. labels Jul 14, 2024
@github-actions github-actions bot removed the waiting Issues/PRs with Pending response by the author. label Aug 13, 2024
@sebastiaanspeck
Copy link
Member

Hi @spageektti, did you find time to work on this PR?

@sebastiaanspeck sebastiaanspeck added the waiting Issues/PRs with Pending response by the author. label Sep 4, 2024
@github-actions github-actions bot removed the waiting Issues/PRs with Pending response by the author. label Sep 10, 2024
@spageektti
Copy link
Member Author

I totally forgot about this PR
I will finish it in the next 7 days, probably faster

@sebastiaanspeck
Copy link
Member

@spageektti are you managing? It is okay if it takes a little longer.

Copy link
Member

Choose a reason for hiding this comment

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

Also fixed in #13813

Copy link
Member

@sebastiaanspeck sebastiaanspeck left a comment

Choose a reason for hiding this comment

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

Maybe we can revert the deletions of the two links and merge this PR. In a new PR we can address the remaining OS X link issues.

Copy link
Member

@sebastiaanspeck sebastiaanspeck left a comment

Choose a reason for hiding this comment

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

The https://keith.github.io/xcode-man-pages only shows the available commands and the latest version, so if a command gets removed, the link will die. IMO we should put a note in which OS X version it got deleted and switch to a different URL to at least show some more information about the command.

Copy link
Member

Choose a reason for hiding this comment

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

@sebastiaanspeck
Copy link
Member

@spageektti any update on this?

@spageektti spageektti closed this Oct 5, 2024
@sebastiaanspeck sebastiaanspeck deleted the fix-osx-win-broken-links branch October 5, 2024 18:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
page edit Changes to an existing page(s). review needed Prioritized PRs marked for reviews from maintainers.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants