Added some documentation about NC cloning methods #345
Conversation
This file contains 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
Signed-off-by: Christian Wolf <[email protected]>
Signed-off-by: Christian Wolf <[email protected]>
juliusknorr
reviewed
Sep 16, 2024
juliusknorr
approved these changes
Sep 16, 2024
juliusknorr
reviewed
Sep 16, 2024
juliusknorr
reviewed
Sep 16, 2024
docs/basics/nc-history.md
Outdated
| The benefit of this approach is obviously that you can have a complete history that you can work with (as long as you do not need the file contents). | ||
| The initial clone takes a bit longer than the shallow one as additionally the history commits (without the contents) need to be transmitted. | ||
|
|
||
| The obvious drawback is that once you need to checkout a file that was never checked out in the clone, it has to be downloaded and a love internet connection is needed. |
There was a problem hiding this comment.
Suggested change
| The obvious drawback is that once you need to checkout a file that was never checked out in the clone, it has to be downloaded and a love internet connection is needed. | |
| The obvious drawback is that once you need to checkout a file that was never checked out in the clone, it has to be downloaded and an internet connection is needed. |
There was a problem hiding this comment.
❤️ but not sure what word you intended there 😁
There was a problem hiding this comment.
I was thinking of a live internet connection 🤣
There was a problem hiding this comment.
I updated this.
christianlupus
commented
Sep 18, 2024
Co-authored-by: Julius Knorr <[email protected]>
christianlupus
commented
Sep 18, 2024
|
I let a typo checker run on the main file of the PR and fixed some in 73747b3. If you are okay with that, I'd suggest merging. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In #228 you asked me to put some documentation on the different methods. Honestly, I was unsure on what level that was useful.
I just created some MVP of such documentation for discussion.