cmd/gitannex: Add config parameter synonyms for compat, update command documentation #7854
+228
−54
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
dmcardle
force-pushed
the
gitannex-config-aliases
branch
from
7c232f3
to
c71b01e
Compare
|
@ncw, PTAL! FYI, looks like there's an unrelated lint error in backend/googlephotos/. |
Mentioned the possibility of skipping the symlink for new versions of git-annex. (Probably deserves a test once the new git-annex trickles down to CI platforms.) I stopped trying to explain each config parameter here. Rather, the doc now shows the user how to ask git-annex to describe config parameters with `--whatelse`.
dmcardle
force-pushed
the
gitannex-config-aliases
branch
from
c71b01e
to
15b1be2
Compare
|
Friendly ping, @ncw :) |
|
@yarikoptic FYI, this should make porting over a little simpler — no need to manually translate each config name any more. I'd appreciate feedback on the markdown changes, too, if you have any thoughts! I'd like to spell out in detail how to recover the configuration parameters originally used to make one's git-annex-remote-rclone remote, but I still haven't figured out exactly what command(s) would do that. |
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.
What is the purpose of this change?
The main purpose is to simplify setup for users.
First, this PR adds aliases to the existing config parameters so users can use the same config names as https://github.com/git-annex-remote-rclone/git-annex-remote-rclone.
Secondly, this updates the command documentation.
type=rclone, so it's possible to skip the whole symlink business.--whatelseoption ofgit annex initremote.Was the change discussed in an issue or in the forum before?
Issue #7625
Checklist