Update git-lfs-migrate man page and add description section#4458
Merged
chrisd8088 merged 3 commits intogit-lfs:mainfrom Mar 30, 2021
Merged
Update git-lfs-migrate man page and add description section#4458chrisd8088 merged 3 commits intogit-lfs:mainfrom
chrisd8088 merged 3 commits intogit-lfs:mainfrom
Conversation
We allow man page headers to include parentheses so that the specialized headers in the git-lfs-migrate man page are supported and properly linked within the rendered page.
We adjust some formatting details in the git-lfs-migrate man
page, fix some typos, and make other minor revisions to suggest
using the --all option when force-pushing after importing with
--everything, stop implying that only large files are ever
imported or exported, and avoid stating that a single use case
is definitely more prevalent than all others.
We also add several "see also" references, expand the section
describing the "info" mode and provide some example output, and
reword some of the usage text for the --{exclude,include}[-ref]
options.
We add a lengthy description section to the git-lfs-migrate man page to order to provide some context and general guidance on how and when the command should be used, as well as trying to explain several potentially non-intuitive concepts and encourage users to check their repositories thoroughly before and after attempting an import or export operation.
686b2b3 to
85def84
Compare
bk2204
approved these changes
Mar 30, 2021
Member
bk2204
left a comment
There was a problem hiding this comment.
This is a great improvement to the documentation.
chrisd8088
added a commit
to chrisd8088/git-lfs
that referenced
this pull request
Feb 1, 2022
This reverts commit 08cb542 from PR git-lfs#4458 because that change, while it does resolve some formatting issues in the output from the "git lfs help" command, does not address the fact that ronn(1) is unable to process parentheses in header text and therefore still generates pages (particularly for the git-lfs-migrate(1) page) with broken links and HTML anchors for such headers. Since we will rewrite the relevant manual pages in a subsequent commit to remove the parentheses, we can simply revert this change first.
chrisd8088
added a commit
to chrisd8088/git-lfs
that referenced
this pull request
Feb 7, 2022
This reverts commit 08cb542 from PR git-lfs#4458 because that change, while it does resolve some formatting issues in the output from the "git lfs help" command, does not address the fact that ronn(1) is unable to process parentheses in header text and therefore still generates pages (particularly for the git-lfs-migrate(1) page) with broken links and HTML anchors for such headers. Since we will rewrite the relevant manual pages in a subsequent commit to remove the parentheses, we can simply revert this change first.
chrisd8088
added a commit
to chrisd8088/git-lfs
that referenced
this pull request
Feb 7, 2022
This reverts commit 08cb542 from PR git-lfs#4458 because that change, while it does resolve some formatting issues in the output from the "git lfs help" command, does not address the fact that ronn(1) is unable to process parentheses in header text and therefore still generates pages (particularly for the git-lfs-migrate(1) page) with broken references for such headers. Since we will rewrite the relevant manual pages in a subsequent commit to remove the parentheses, we simply revert this change first.
chrisd8088
added a commit
to chrisd8088/git-lfs
that referenced
this pull request
Feb 7, 2022
This reverts commit 08cb542 from PR git-lfs#4458 because that change, while it does resolve some formatting issues in the output from the "git lfs help" command, does not address the fact that ronn(1) is unable to process parentheses in header text and therefore still generates pages (particularly for the git-lfs-migrate(1) page) with broken references for such headers. Since we will rewrite the relevant manual pages in a subsequent commit to remove the parentheses, we simply revert this change first.
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
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.
We add a lengthy description section to the
git-lfs-migrateman page to order to provide some context and general guidance on how and when the command should be used, as well as trying to explain several potentially non-intuitive concepts and encourage users to check their repositories thoroughly before and after attempting an import or export operation.We also adjust some formatting details in the page, fix some typos, and make other minor revisions to suggest using the
--alloption when force-pushing after importing with--everything, stop implying that only large files are ever imported or exported, and avoid stating that a single use case is definitely more prevalent than all others.And we allow man page headers to include parentheses so that the specialized headers in the
git-lfs-migrateman page (e.g.,"IMPORT (NO REWRITE)") are supported and properly linked within the rendered page.Fixes #4408.
/cc @glass-ships as reporter.