Skip to content

Conversation

@yukuku
Copy link
Contributor

@yukuku yukuku commented Mar 12, 2020

  • The page (if new), does not already exist in the repo.
  • The page is in the correct platform directory (common/, linux/, etc.)
  • The page has 8 or fewer examples.
  • The PR title conforms to the recommended templates.
  • The page follows the content guidelines.
  • The page description includes a link to documentation or a homepage (if applicable).

@CLAassistant
Copy link

CLAassistant commented Mar 12, 2020

CLA assistant check
All committers have signed the CLA.

@tldr-bot
Copy link

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

pages/common/git-update-index.md:6: TLDR005 Example descriptions should end in a colon

Please fix the error(s) and push again.

Copy link
Member

@sbrl sbrl left a comment

Choose a reason for hiding this comment

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

Thanks, @yukuku!

I'm curious about the use-case for this though. Very weird example!

@yukuku
Copy link
Contributor Author

yukuku commented Mar 13, 2020

I've used this several times when dealing with repositories that I don't regularly maintain but has .gitignore that does not exclude temporary/build files that are produced on my machine.

e.g.

  1. A repository does not exclude the out/ directory but when I build the project, the intermediate files are stored by default in out/ directory. I'm not familiar enough with this project so I don't want to add out/ to .gitignore an push that.

  2. A repository has an instruction to patch certain lines in order for a hack to work, or in order to enable debug mode, or to increase network connection time out. The change modifies the source code but only for local developer's machine, it is not supposed to be commited.

Copy link
Member

@einverne einverne left a comment

Choose a reason for hiding this comment

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

hi @yukuku thank you for your contribution. I left a comment for you to take a look. It is ok with me after the change.

@einverne einverne added the new command Issues requesting creation of a new page or PRs adding a new page for a command. label Mar 16, 2020
@einverne einverne merged commit 60a7b9b into tldr-pages:master Mar 18, 2020
@sbrl
Copy link
Member

sbrl commented Mar 18, 2020

Wow, that's such a very cool use-case @yukuku - thanks so much! I'll remember that one - it would have made a number of situations much easier :D

@yukuku yukuku deleted the patch-1 branch March 19, 2020 08:15
@waldyrious
Copy link
Member

Hey @yukuku and @sbrl — just thought I'd mention that for the use case of a missing .gitignore in a project, you can easily set a repo-specific gitignore file by editing the .git/info/exclude file within the repo. That's more flexible than manually updating the index. Check the official docs and this StackOverflow Q&A for more info.

mt-empty pushed a commit to mt-empty/tldr that referenced this pull request Feb 22, 2025
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.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants