Skip to content

pages/common/*: correct urls, see also improvements, unbashify pages, examples addition #16841

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 31 commits into from
Jun 14, 2025

Conversation

pranaovs
Copy link
Contributor

  • alias: fix link and add see also to unalias
  • command: add -p flag which forces a search using default PATH
  • dirs: add see also pushd and popd
  • dirs: add explanation for -l and -v flag
  • dirs: add dirs -n explanation to view nth entry from the last
  • disown: fix see also section formatting according to style guide
  • disown: add description for see also section of jobs page
  • disown: mention bash-only commands appropriately
  • disown: indicate how to find specific job number for disowning specific job
  • echo: add see also to printf
  • fg: add see also section to jobs, bg and disown
  • fg: specify using jobs command to find job number
  • bg: add jobs, fg and disown to see also
  • bg: use term job number instead of job id
  • local: add export command to see also
  • printf: add echo to see also
  • popd: see also section follow style guide
  • pushd: see also section follow style guide
  • test: add example of using test in a conditional if
  • unalias: add see also alias
  • wait: add ps to see also section
  • wait: document how to find job number for calling jobs with %

Related to #10584

I just skimmed through the commands in the issue and modified some of them.

Please review and let me know if any changes are needed.

  • 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):

@github-actions github-actions bot added mass changes Changes that affect multiple pages. page edit Changes to an existing page(s). review needed Prioritized PRs marked for reviews from maintainers. labels Jun 12, 2025
@tldr-bot
Copy link

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

pages/common/alias.md:5: TLDR004 Command descriptions should end in a period
pages/common/bg.md:4: TLDR004 Command descriptions should end in a period
pages/common/dirs.md:20: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/common/echo.md:4: TLDR004 Command descriptions should end in a period
pages/common/fg.md:4: TLDR004 Command descriptions should end in a period
pages/common/printf.md:4: TLDR004 Command descriptions should end in a period
pages/common/unalias.md:4: TLDR004 Command descriptions should end in a period

Please fix the error(s) and push again.

@pranaovs
Copy link
Contributor Author

good bot

@pranaovs
Copy link
Contributor Author

There are few pages which are for shell builtins. The flags in bash does not match with the ones in zsh (missing, different, etc). Please let me know how I can proceed with them. I haven't touched any of them yet.

Copy link
Collaborator

@Managor Managor left a comment

Choose a reason for hiding this comment

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

Look good to me after these changes

Co-authored-by: Managor <42655600+Managor@users.noreply.github.com>
@Managor
Copy link
Collaborator

Managor commented Jun 12, 2025

There are few pages which are for shell builtins. The flags in bash does not match with the ones in zsh (missing, different, etc). Please let me know how I can proceed with them. I haven't touched any of them yet.

Do whatever you'd like and we'll hash them out. File a new PR for that. It's easier to process when they are separated into small bits.

@pranaovs
Copy link
Contributor Author

Alright, ill look into them soon

Present in bash source code

```c
/* The value for PATH when invoking `command -p'.  This is only used
when
   the Posix.2 confstr () function, or CS_PATH define are not present.
*/
#ifndef STANDARD_UTILS_PATH
#define STANDARD_UTILS_PATH \
  "/bin:/usr/bin:/sbin:/usr/sbin:/etc:/usr/etc"
#endif
```

Co-authored-by: Managor <42655600+Managor@users.noreply.github.com>
@sebastiaanspeck sebastiaanspeck changed the title *: correct urls, see also improvements, unbashify pages, examples addition pages/common/*: correct urls, see also improvements, unbashify pages, examples addition Jun 13, 2025
pranaovs and others added 3 commits June 13, 2025 05:15
Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>
Co-authored-by: Sebastiaan Speck
<12570668+sebastiaanspeck@users.noreply.github.com>
pranaovs and others added 3 commits June 14, 2025 00:54
Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com>
Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com>
@Managor
Copy link
Collaborator

Managor commented Jun 14, 2025

Thanks

@Managor Managor merged commit 8bc9dce into tldr-pages:main Jun 14, 2025
4 checks passed
@pranaovs pranaovs deleted the unbashify branch June 14, 2025 16:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
mass changes Changes that affect multiple pages. 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.

5 participants