Update --detached-sign to --detach-sign, remove "auto generated" line from docs #242
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: Aditya Sirish <aditya@saky.in>
Gitsign currently does not match other signing tools such as GPG in its flag to create detached signatures. This commit deprecates the old flag and introduces a correctly named alternative. This has likely not been discovered because Git passes in `-b` rather than the full flag. This shorthand has been moved to the new flag definition. Signed-off-by: Aditya Sirish <aditya@saky.in>
adityasaky
force-pushed
the
minor-fixes
branch
from
6d88cac
to
a9e2d7d
Compare
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.
Summary
This PR introduces two changes:
auto generated by cobratag as this line is updated across all docs for every change. I can take this out if the preference is to retain it.--detached-signflag to--detach-signto match the interface of GPG and other tools. The-bshorthand is moved to the new flag and the old one is marked as deprecated rather than outright removal.Release Note
New features and improvements, including behavioural changes, UI changes and CLI changes:
Deprecates
--detached-signin favour of--detach-signto match the interface of other signing tools.Documentation
The CLI docs in-repo have been updated by this PR. I'm unaware of gitsign's CLI is separately documented elsewhere.