it's called read_object_file() these days

Commit Message

Junio C Hamano Nov. 2, 2018, 6:05 a.m. UTC

Remnant of the old name of the function still remains in comments.
Update them all.

Signed-off-by: Junio C Hamano <[e-mail]>
---
 apply.c       | 2 +-
 builtin/gc.c  | 2 +-
 fast-import.c | 4 ++--
 notes.c       | 2 +-
 object.h      | 2 +-
 sha1-file.c   | 2 +-
 6 files changed, 7 insertions(+), 7 deletions(-)

Comments

Jeff King Nov. 2, 2018, 6:24 a.m. UTC | #1

On Fri, Nov 02, 2018 at 03:05:03PM +0900, Junio C Hamano wrote:

> Remnant of the old name of the function still remains in comments.
> Update them all.

Yay. What's here looks obviously correct.

> Signed-off-by: Junio C Hamano <[e-mail]>
> ---
>  apply.c       | 2 +-
>  builtin/gc.c  | 2 +-
>  fast-import.c | 4 ++--
>  notes.c       | 2 +-
>  object.h      | 2 +-
>  sha1-file.c   | 2 +-
>  6 files changed, 7 insertions(+), 7 deletions(-)

There's another mention in Documentation/technical/api-object-access.txt.

But since the entire API is undocumented, I'm not sure it matters much.
That file has been a placeholder since 2007. Maybe we should just delete
it; its existence does not seem to be guilting anyone into documenting,
and these days we'd prefer to do it in-header anyway.

-Peff

Junio C Hamano Nov. 2, 2018, 11:48 a.m. UTC | #2

Jeff King <[e-mail]> writes:

> There's another mention in Documentation/technical/api-object-access.txt.

Yes, and we are on the same page on that one.

>
> But since the entire API is undocumented, I'm not sure it matters much.
> That file has been a placeholder since 2007. Maybe we should just delete
> it; its existence does not seem to be guilting anyone into documenting,
> and these days we'd prefer to do it in-header anyway.
>
> -Peff

Patch

diff --git a/apply.c b/apply.c
index 073d5f0451..ef1a1b2c4e 100644
--- a/apply.c
+++ b/apply.c
@@ -3254,7 +3254,7 @@  static int read_blob_object(struct strbuf *buf, const struct object_id *oid, uns
 		result = read_object_file(oid, &type, &sz);
 		if (!result)
 			return -1;
-		/* XXX read_sha1_file NUL-terminates */
+		/* XXX read_object_file NUL-terminates */
 		strbuf_attach(buf, result, sz, sz + 1);
 	}
 	return 0;
diff --git a/builtin/gc.c b/builtin/gc.c
index 871a56f1c5..a682a0f44e 100644
--- a/builtin/gc.c
+++ b/builtin/gc.c
@@ -285,7 +285,7 @@  static uint64_t estimate_repack_memory(struct packed_git *pack)
 	/* revindex is used also */
 	heap += sizeof(struct revindex_entry) * nr_objects;
 	/*
-	 * read_sha1_file() (either at delta calculation phase, or
+	 * read_object_file() (either at delta calculation phase, or
 	 * writing phase) also fills up the delta base cache
 	 */
 	heap += delta_base_cache_limit;
diff --git a/fast-import.c b/fast-import.c
index 95600c78e0..f73b2ae0a6 100644
--- a/fast-import.c
+++ b/fast-import.c
@@ -1298,13 +1298,13 @@  static void stream_blob(uintmax_t len, struct object_id *oidout, uintmax_t mark)
  * oe must not be NULL.  Such an oe usually comes from giving
  * an unknown SHA-1 to find_object() or an undefined mark to
  * find_mark().  Callers must test for this condition and use
- * the standard read_sha1_file() when it happens.
+ * the standard read_object_file() when it happens.
  *
  * oe->pack_id must not be MAX_PACK_ID.  Such an oe is usually from
  * find_mark(), where the mark was reloaded from an existing marks
  * file and is referencing an object that this fast-import process
  * instance did not write out to a packfile.  Callers must test for
- * this condition and use read_sha1_file() instead.
+ * this condition and use read_object_file() instead.
  */
 static void *gfi_unpack_entry(
 	struct object_entry *oe,
diff --git a/notes.c b/notes.c
index 25cdce28b7..6a430931a3 100644
--- a/notes.c
+++ b/notes.c
@@ -858,7 +858,7 @@  static int string_list_add_note_lines(struct string_list *list,
 	if (is_null_oid(oid))
 		return 0;
 
-	/* read_sha1_file NUL-terminates */
+	/* read_object_file NUL-terminates */
 	data = read_object_file(oid, &t, &len);
 	if (t != OBJ_BLOB || !data || !len) {
 		free(data);
diff --git a/object.h b/object.h
index 0feb90ae61..4cabc9f278 100644
--- a/object.h
+++ b/object.h
@@ -136,7 +136,7 @@  struct object *parse_object(struct repository *r, const struct object_id *oid);
  */
 struct object *parse_object_or_die(const struct object_id *oid, const char *name);
 
-/* Given the result of read_sha1_file(), returns the object after
+/* Given the result of read_object_file(), returns the object after
  * parsing it.  eaten_p indicates if the object has a borrowed copy
  * of buffer and the caller should not free() it.
  */
diff --git a/sha1-file.c b/sha1-file.c
index dd0b6aa873..31c2b926fe 100644
--- a/sha1-file.c
+++ b/sha1-file.c
@@ -124,7 +124,7 @@  const char *empty_blob_oid_hex(void)
 
 /*
  * This is meant to hold a *small* number of objects that you would
- * want read_sha1_file() to be able to return, but yet you do not want
+ * want read_object_file() to be able to return, but yet you do not want
  * to write them into the object store (e.g. a browse-only
  * application).
  */