summaryrefslogtreecommitdiff
path: root/mergesort.h
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2012-04-17 18:07:01 (GMT)
committerJunio C Hamano <gitster@pobox.com>2012-04-17 18:07:01 (GMT)
commit7365c95d2d67cbbb74c2040918d2ecde06231d93 (patch)
tree59eeaaaf0a202c7860d784643e86bd9fb32cb52c /mergesort.h
parentfbc08ea177f8284d10c62ad39de51edb21af88b0 (diff)
downloadgit-7365c95d2d67cbbb74c2040918d2ecde06231d93.zip
git-7365c95d2d67cbbb74c2040918d2ecde06231d93.tar.gz
git-7365c95d2d67cbbb74c2040918d2ecde06231d93.tar.bz2
mergesort: rename it to llist_mergesort()
Even though the function is generic enough, <anything>sort() inherits connotations from the standard function qsort() that sorts an array. Rename it to llist_mergesort() and describe the external interface in its header file. This incidentally avoids name clashes with mergesort() some platforms declare in, and contaminate user namespace with, their <stdlib.h>. Reported-by: Brian Gernhardt Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'mergesort.h')
-rw-r--r--mergesort.h16
1 files changed, 12 insertions, 4 deletions
diff --git a/mergesort.h b/mergesort.h
index d6e5f4a..644cff1 100644
--- a/mergesort.h
+++ b/mergesort.h
@@ -1,9 +1,17 @@
#ifndef MERGESORT_H
#define MERGESORT_H
-void *mergesort(void *list,
- void *(*get_next_fn)(const void *),
- void (*set_next_fn)(void *, void *),
- int (*compare_fn)(const void *, const void *));
+/*
+ * Sort linked list in place.
+ * - get_next_fn() returns the next element given an element of a linked list.
+ * - set_next_fn() takes two elements A and B, and makes B the "next" element
+ * of A on the list.
+ * - compare_fn() takes two elements A and B, and returns negative, 0, positive
+ * as the same sign as "subtracting" B from A.
+ */
+void *llist_mergesort(void *list,
+ void *(*get_next_fn)(const void *),
+ void (*set_next_fn)(void *, void *),
+ int (*compare_fn)(const void *, const void *));
#endif