Fix non-reproducible search index

ivan770 · ivan770 · commit 6540585b19c1 · 2023-11-26T09:39:03.000-05:00
diff --git a/src/searchindex_js.cpp b/src/searchindex_js.cpp
@@ -487,7 +487,11 @@ void createJavaScriptSearchIndex()
     for (auto &[name,symList] : sii.symbolMap) // for each symbol in the index
     {
       // sort the symbols (first on search term, and then on full name)
-      std::sort(symList.begin(),
+      //
+      // `std::stable_sort` is used here due to reproducibility issues
+      // on key collisions
+      // https://github.com/doxygen/doxygen/issues/10445 
+      std::stable_sort(symList.begin(),
                 symList.end(),
                 [](const auto &t1,const auto &t2)
                 {

Original file line number	Diff line number	Diff line change
`@@ -487,7 +487,11 @@ void createJavaScriptSearchIndex()`
`487`	`487`	`for (auto &[name,symList] : sii.symbolMap) // for each symbol in the index`
`488`	`488`	`{`
`489`	`489`	`// sort the symbols (first on search term, and then on full name)`
`490`		`- std::sort(symList.begin(),`
	`490`	`+ //`
	`491`	+ // `std::stable_sort` is used here due to reproducibility issues
	`492`	`+ // on key collisions`
	`493`	`+ // https://github.com/doxygen/doxygen/issues/10445`
	`494`	`+ std::stable_sort(symList.begin(),`
`491`	`495`	`symList.end(),`
`492`	`496`	`[](const auto &t1,const auto &t2)`
`493`	`497`	`{`