Skip to content

Conversation

@zhb4
Copy link
Collaborator

@zhb4 zhb4 commented Nov 11, 2025

Checklist

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • 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 contains at most 5 new pages.
  • The PR is authored by me, or has been human-reviewed if it was created with AI or machine translation software.
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known):

Reference issue: #

@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 Nov 11, 2025
@tldr-bot
Copy link

The build for this PR failed with the following error(s) at commit
589c4e87eca95e3493c0899084e402a5c05015cd:

pages/linux/slabtop.md:4: TLDR003 Descriptions should start with a capital letter

Please fix the error(s) and push again.

zhb4 and others added 2 commits November 12, 2025 09:48
Co-authored-by: Sahil Afrid Farookhi <[email protected]>
Co-authored-by: Sahil Afrid Farookhi <[email protected]>
Copy link
Collaborator

@ivanbaluta ivanbaluta left a comment

Choose a reason for hiding this comment

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

Hi zhb4!
I've noticed one important issue that needs to be addressed. The slabtop command requires root privileges to read kernel slab information from /proc/slabinfo.
Please add sudo to the beginning of all the examples (except for the --help one). Without it, the commands will fail with a "Permission denied" error.

Copy link
Collaborator

@ivanbaluta ivanbaluta left a comment

Choose a reason for hiding this comment

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

the --sort option expects a single character (e.g., c for cache size, o for number of objects), not a full word.

zhb4 and others added 4 commits November 12, 2025 14:58
Copy link
Collaborator

@ivanbaluta ivanbaluta left a comment

Choose a reason for hiding this comment

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

We could also add mnemonics to the sort descriptions

zhb4 and others added 3 commits November 13, 2025 09:35
@Managor Managor requested a review from msaf9 November 13, 2025 12:45
Copy link
Collaborator

@msaf9 msaf9 left a comment

Choose a reason for hiding this comment

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

Hello @Managor! Everything looks good, but I have a couple of concerns about the way some of the examples are described. Using simple o or s may deviate from current tldr standards, since we usually spell out parameters explicitly (for example, using object instead of o). This could also be confusing for beginners. Other than that, I don’t have any further comments.

@ivanbaluta
Copy link
Collaborator

Hi @msaf9!
That's a valid concern, but in this specific case for slabtop, the --sort option literally expects a single character as its argument (o, s, or c).
I based this on the rule: https://github.com/tldr-pages/tldr/blob/main/contributing-guides/style-guide.md#exceptions

@msaf9
Copy link
Collaborator

msaf9 commented Nov 14, 2025

I got it after glancing through this part (SORT CRITERIA) of the documentation.

@msaf9 msaf9 merged commit 057107c into tldr-pages:main Nov 14, 2025
4 checks passed
@Managor
Copy link
Member

Managor commented Nov 14, 2025

Depending on case-by-case basis we use both explixit and spelled out examples. In this case the explicit example seems better

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.

6 participants