git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: 牛旭 <niuxu16@nudt.edu.cn>
To: git <git@vger.kernel.org>
Subject: Recommendation for consistent update on invoke of "sha1_to_hex()"
Date: Fri, 5 Jan 2018 11:26:01 +0800 (GMT+08:00)	[thread overview]
Message-ID: <fb56cfe.6744.160c45a9e5a.Coremail.niuxu16@nudt.edu.cn> (raw)

[-- Attachment #1: Type: text/plain, Size: 1429 bytes --]

Our team researches on consistent update of Git during evolution. And we have figured out several spots that may be missed. 


By mining historical patches, we suggest that invokes of sha1_to_hex() should be replaced with that of oid_to_hex(). One example for recommendation and corresponding patch are listed as follows. 

One example of missed spot:
1  void assert_sha1_type(const unsigned char *sha1, enum 
  object_type expect)
2 {
3  enum object_type type = sha1_object_info(sha1, NULL);
4  if (type < 0)
5   die("%s is not a valid object",sha1_to_hex(sha1));
6  if (type != expect)
7   die("%s is not a valid '%s' object", sha1_to_hex(sha1),
8  typename(expect));
9 }

One example of historical patch:
1  * We do not want to call parse_object here, because
2  * inflating blobs and trees could be very expensive.
3  * However, we do need to know the correct type for
4  * later processing, and the revision machinery expects
5  * commits and tags to have been parsed.
6  */
7  - type = sha1_object_info(sha1, NULL);
8  + type = sha1_object_info(oid->hash, NULL);
9  if (type < 0)
10 - die("unable to get object info for %s", sha1_to_hex(sha1));
11 + die("unable to get object info for %s", oid_to_hex(oid));
12
More recommendations and supporting patches are saved in attachments. It is so kind of you to reply me about the correctness of our suggestions. And thank you for your reading. 

[-- Attachment #2: Git-recommendation-example-1.doc --]
[-- Type: application/msword, Size: 11264 bytes --]

[-- Attachment #3: Git-patch-example-1.doc --]
[-- Type: application/msword, Size: 28672 bytes --]

             reply	other threads:[~2018-01-05  3:25 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-01-05  3:26 牛旭 [this message]
2018-01-05  7:08 ` Recommendation for consistent update on invoke of "sha1_to_hex()" Jeff King

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=fb56cfe.6744.160c45a9e5a.Coremail.niuxu16@nudt.edu.cn \
    --to=niuxu16@nudt.edu.cn \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).