git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 1/7] Documentation/git-push.txt: Document when --signed may fail

From
Dave Borowitz <dborowitz@google.com>
Date
Aug 17, 2015, 18:11 UTC
Message-ID
<CAD0k6qS4A0zWWr1oNLaaps0qD08pkGTcj7yGo_tkPGKMxKWGhQ@mail.gmail.com>
In-Reply-To
<xmqqr3n5fovm.fsf@gitster.dls.corp.google.com>
On Fri, Aug 14, 2015 at 7:10 PM, Junio C Hamano <gitster@pobox.com> wrote:
Show 31 quoted lines
> Dave Borowitz <dborowitz@google.com> writes:
>
>> Like --atomic, --signed will fail if the server does not advertise the
>> necessary capability. In addition, it requires gpg on the client side.
>>
>> Signed-off-by: Dave Borowitz <dborowitz@google.com>
>> ---
>>  Documentation/git-push.txt | 4 +++-
>>  1 file changed, 3 insertions(+), 1 deletion(-)
>>
>> diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt
>> index 135d810..f8b8b8b 100644
>> --- a/Documentation/git-push.txt
>> +++ b/Documentation/git-push.txt
>> @@ -137,7 +137,9 @@ already exists on the remote side.
>>       GPG-sign the push request to update refs on the receiving
>>       side, to allow it to be checked by the hooks and/or be
>>       logged.  See linkgit:git-receive-pack[1] for the details
>> -     on the receiving end.
>> +     on the receiving end.  If the `gpg` executable is not available,
>> +     or if the server does not support signed pushes, the push will
>> +     fail.
>
> Looks good.
>
> I am wondering if another mode of failure is worth mentioning: `gpg`
> available, you have _some_ keys, but signingkey configured does not
> match any of the keys.
>
> Note that I said "am wondering", which is very different from "I
> think we should also describe".

I think we don't need to go down the path of enumerating all possible ways the operation can fail. There is probably a reasonably concise way to include more possibilities. How about:

"If the attempt to sign with `gpg` fails, or if the server does not support signed pushes, the push will fail."

This should cover gpg not being found, gpg being fatally misconfigured, crazy unexpected pipe closures, etc.

> Thanks.
Previous: Junio C HamanoNext: Dave Borowitz
Message 4 of 32 in “Flags and config to sign pushes by default”
  1. 0/7 Flags and config to sign pushes by defaultDave Borowitz, Aug 13, 2015
  2. 1/7 Documentation/git-push.txt: Document when --signed may failDave Borowitz, Aug 13, 2015
  3. Junio C HamanoAug 14, 2015
  4. Dave BorowitzAug 17, 2015
  5. 2/7 Documentation/git-send-pack.txt: Flow long synopsis lineDave Borowitz, Aug 13, 2015
  6. 3/7 Documentation/git-send-pack.txt: Document --signedDave Borowitz, Aug 13, 2015
  7. 4/7 gitremote-helpers.txt: Document pushcert optionDave Borowitz, Aug 13, 2015
  8. 5/7 transport: Remove git_transport_options.push_certDave Borowitz, Aug 13, 2015
  9. Junio C HamanoAug 14, 2015
  10. 6/7 Support signing pushes iff the server supports itDave Borowitz, Aug 13, 2015
  11. Junio C HamanoAug 14, 2015
  12. Dave BorowitzAug 19, 2015
  13. 7/7 Add a config option push.gpgSign for default signed pushesDave Borowitz, Aug 13, 2015
  14. Junio C HamanoAug 17, 2015
  15. Dave BorowitzAug 17, 2015
  16. Junio C HamanoAug 17, 2015
  17. Junio C HamanoAug 17, 2015
  18. Dave BorowitzAug 17, 2015
  19. Chris PackhamAug 14, 2015
  20. Junio C HamanoAug 14, 2015
  21. Dave BorowitzAug 14, 2015
  22. Dave BorowitzAug 14, 2015
  23. Junio C HamanoAug 14, 2015
  24. Dave BorowitzAug 14, 2015
  25. Junio C HamanoAug 14, 2015
  26. Junio C HamanoAug 17, 2015
  27. Dave BorowitzAug 17, 2015
  28. Junio C HamanoAug 17, 2015
  29. Dave BorowitzAug 17, 2015
  30. Junio C HamanoAug 17, 2015
  31. Dave BorowitzAug 17, 2015
  32. Junio C HamanoAug 17, 2015

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.