Skip to content

coreutils: add page #16170

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

Merged
merged 11 commits into from
Apr 21, 2025
Merged

coreutils: add page #16170

merged 11 commits into from
Apr 21, 2025

Conversation

ssmangat
Copy link
Contributor

@ssmangat ssmangat commented Apr 14, 2025

  • [*] The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page(s) have at most 8 examples.
  • The page description(s) have links to documentation or a homepage.
  • [*] The page(s) follow the content guidelines.
  • [*] The page(s) follow the style guide.
  • [*] The PR title conforms to the recommended templates.
  • Version of the command being documented (if known):

Closes #16067

Sorry, something went wrong.

@CLAassistant
Copy link

CLAassistant commented Apr 14, 2025

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers. labels Apr 14, 2025
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.

Please address @Managor's suggestions

@ssmangat
Copy link
Contributor Author

Added requested changes for description,
I installed uutils-coreutils package and tested them on my fedora installation, the commands run as uutils-coreutils {{util}} {{util_options}} not as coreutils {{util}} {{util_options}} because of the name of the binary.
not sure why the official page calls for just coreutils - https://uutils.github.io/coreutils/docs/multicall.html
is this something that needs to be addressed ?

@Managor
Copy link
Collaborator

Managor commented Apr 20, 2025

I feel like it's a file rename added by fedora so that installing the package doesn't break the system. See the package contents on Arch for example https://archlinux.org/packages/extra/x86_64/uutils-coreutils/. They do something similar

@ssmangat ssmangat requested a review from Managor April 20, 2025 21:43
@Managor
Copy link
Collaborator

Managor commented Apr 20, 2025

There's still one open conversation.

@Managor
Copy link
Collaborator

Managor commented Apr 20, 2025

Here's a link to the style guide if you want to read about imperative mood https://github.com/tldr-pages/tldr/blob/main/contributing-guides/style-guide.md#imperative-mood

@tldr-bot
Copy link

The build for this PR failed with the following error(s):

pages/common/coreutils.md:7: TLDR005 Example descriptions should end in a colon with no trailing characters

Please fix the error(s) and push again.

@@ -4,7 +4,7 @@
> Uutils includes a multi-call binary from which the utils can be invoked. This reduces the binary size of the binary and can be useful for portability.
> More information: <https://uutils.github.io/coreutils/docs/multicall.html>.

- The first argument of the multi-call binary is the util to run, after which the regular arguments to the util can be passed:
- Pass the util to run as the first argument to the multi-call binary, then pass the regular arguments to the util.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Still too verbose.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

will this work - Pass the util as the first argument, then its regular arguments.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I would word it as - Run an utility with arguments:

@Managor Managor merged commit ff38dda into tldr-pages:main Apr 21, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Page request: coreutils

None yet

6 participants