Add the FAQ in the repository #5167
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chrisd8088
previously approved these changes
Nov 2, 2022
Member
chrisd8088
left a comment
chrisd8088
left a comment
There was a problem hiding this comment.
Looks great! I noted some minor typos only.
| To fix this, you can use `git lfs migrate import --everything` with an | ||
| appropriate `--include` argument. For example, if you wanted to move your | ||
| `.jpg` and `.png` files into Git LFS, you can do that with | ||
| `git lfs migrate import --everything --include="\*.jpg,*.png"`. More complicated |
Member
There was a problem hiding this comment.
Just out of interest, is there a difference here between \* and plain *?
Member
Author
There was a problem hiding this comment.
This is required to make AsciiDoc not consider this bold. Very fortunately, it's also syntactically correct according to the shell.
chrisd8088
dismissed
their stale review
I realized we should put this in section 7 of the manual.
We generally get a lot of requests for problems that are already answered in the FAQ. Right now, this lives in the wiki, but this is hard to find, so let's include it in the documentation with Git LFS itself. Add the relevant portions to the binary and Makefile so that it can be accessed using `git lfs help faq`, and add it as well to the Linux packages.
Explain what a pointer file is and how to check out files with `git lfs pull`.
It's been requested that we add documentation to explain how to track files that already exist. Do so in a FAQ entry.
Now that the FAQ is stored in the repository, let's point people there instead of at the wiki.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Right now, people have to read the FAQ on the wiki, which makes it hard to discover or to use offline. We want people to have a copy of it installed as part of the documentation for ease of discovery. Add it to the repository, and add a couple of missing entries to help explain some situations we haven't mentioned yet.
Fixes #5034