From 26a029d407be480d791972afb5975cf62c9360a6 Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Fri, 19 Apr 2024 02:47:55 +0200
Subject: Adding upstream version 124.0.1.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 .../search/docs/application-search-engines.rst     | 41 ++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 browser/components/search/docs/application-search-engines.rst

(limited to 'browser/components/search/docs/application-search-engines.rst')

diff --git a/browser/components/search/docs/application-search-engines.rst b/browser/components/search/docs/application-search-engines.rst
new file mode 100644
index 0000000000..30bc0b7575
--- /dev/null
+++ b/browser/components/search/docs/application-search-engines.rst
@@ -0,0 +1,41 @@
+Application Search Engines
+==========================
+
+Firefox defines various application search engines that are shipped to users.
+
+The extensions for the definitions of these engines live in
+:searchfox:`browser/components/search/extensions <browser/components/search/extensions>`
+
+Icons
+-----
+
+Icon Requirements
+~~~~~~~~~~~~~~~~~
+
+It is preferred that each engine is shipped with a ``.ico`` file with two sizes
+of image contained within the file:
+
+  * 16 x 16 pixels
+  * 32 x 32 pixels
+
+Some engines also have icons in
+:searchfox:`browser/components/newtab/data/content/tippytop <browser/components/newtab/data/content/tippytop>`.
+For these engines, there are two sizes depending on the subdirectory:
+
+  * ``favicons/``: 32 x 32 pixels
+  * ``images/``: preferred minimum of 192 x 192 pixels
+
+Updating Icons
+~~~~~~~~~~~~~~
+
+To update icons for application search engines:
+
+  * Place the new icon file in the :searchfox:`folder associated with the search engine <browser/components/search/extensions>`.
+  * Increase the version number in the associated manifest file. This ensures
+    that the add-on manager properly updates the engine.
+  * Be aware that the :searchfox:`allowed-dupes.mn file <browser/installer/allowed-dupes.mn>`
+    lists some icons that are intended as duplicates.
+
+To update icons for tippytop:
+
+  * Place the new icon file in :searchfox:`both the sub-folders within the tippytop directory <browser/components/newtab/data/content/tippytop>`.
-- 
cgit v1.2.3