From 17fe003bd9dce679f55c6e80c5cd2766ac37322c Mon Sep 17 00:00:00 2001 From: Marco Bonardo Date: Sat, 24 Aug 2024 08:50:25 +0000 Subject: [PATCH] Bug 1617964 - Update references from Toolkit:Storage to the new Core module, correct governance info, introduce placeholder docs. r=lina,zeid Differential Revision: https://phabricator.services.mozilla.com/D219968 --- docs/config.yml | 1 + mots.yaml | 18 ++++++++++-------- storage/docs/index.rst | 7 +++++++ storage/moz.build | 4 +++- third_party/moz.build | 2 +- toolkit/components/kvstore/moz.build | 2 +- toolkit/modules/moz.build | 2 +- 7 files changed, 24 insertions(+), 12 deletions(-) create mode 100644 storage/docs/index.rst diff --git a/docs/config.yml b/docs/config.yml index 645e2dacac06..32b5f49508b0 100644 --- a/docs/config.yml +++ b/docs/config.yml @@ -41,6 +41,7 @@ categories: - writing-rust-code - tools/profiler - performance + - storage - xpcom - nspr - security/nss diff --git a/mots.yaml b/mots.yaml index 7aabad29786a..cf7486c9b2eb 100644 --- a/mots.yaml +++ b/mots.yaml @@ -8,7 +8,7 @@ # documentation and how to modify this file. repo: mozilla-central created_at: '2021-10-14T12:50:40.073465' -updated_at: '2024-08-12T21:53:27.210457+00:00' +updated_at: '2024-08-24T08:35:37.109364+00:00' export: path: ./docs/mots/index.rst format: rst @@ -2665,16 +2665,18 @@ modules: - *jrmuizel machine_name: core_static_analysis_rewriting_for_c - - name: 'Core: storage' - description: Storage APIs, SQLite backend + - name: 'Core: SQLite and Embedded Database Bindings' + description: Embedded database engines and their code bindings. includes: - - third_party/sqlite3/**/* - storage/**/* + - third_party/sqlite3/**/* + - toolkit/components/kvstore/**/* + - toolkit/modules/Sqlite.sys.mjs meta: group: dev-platform - url: http://developer.mozilla.org/en/docs/Storage + url: https://firefox-source-docs.mozilla.org/storage/index.html components: - - Toolkit::Storage, Core::SQL + - Core::SQLite and Embedded Database Bindings owners_emeritus: - Shawn Wilsher owners: @@ -4369,5 +4371,5 @@ modules: - Ryan Tilder group: dev-platform hashes: - config: 43d0d8bd41eefae9df701d29898d2c267c690744 - export: 6233f0c96ac834ced16da56c30a6d5530dc294b3 + config: 2b820918028a169e0dd7eb608374b600b82c59e7 + export: 13932a489e0e5bef0e8ff7e3513c17450c44152a diff --git a/storage/docs/index.rst b/storage/docs/index.rst new file mode 100644 index 000000000000..a8a9eab0fbb6 --- /dev/null +++ b/storage/docs/index.rst @@ -0,0 +1,7 @@ +Database bindings (SQLite, KV, …) +================================= + +This section contains design documents and best practices for the embedded +database bindings available in-tree. + +This placeholder document will be updated soon™. diff --git a/storage/moz.build b/storage/moz.build index 3dc1cd4bf7d7..7f4c75730ef5 100644 --- a/storage/moz.build +++ b/storage/moz.build @@ -5,7 +5,7 @@ # file, You can obtain one at http://mozilla.org/MPL/2.0/. with Files("**"): - BUG_COMPONENT = ("Toolkit", "Storage") + BUG_COMPONENT = ("Core", "SQLite and Embedded Database Bindings") DIRS += ["build"] @@ -110,3 +110,5 @@ if CONFIG["MOZ_FOLD_LIBS"]: DEFINES["MOZ_FOLD_LIBS"] = True CXXFLAGS += CONFIG["SQLITE_CFLAGS"] + +SPHINX_TREES["/storage"] = "docs" diff --git a/third_party/moz.build b/third_party/moz.build index 62bb10a1e72e..8f186bbe240f 100644 --- a/third_party/moz.build +++ b/third_party/moz.build @@ -59,7 +59,7 @@ with Files('sipcc/**'): BUG_COMPONENT = ('Core', 'WebRTC: Signaling') with Files('sqlite3/**'): - BUG_COMPONENT = ('Toolkit', 'Storage') + BUG_COMPONENT = ("Core", "SQLite and Embedded Database Bindings") with Files('rlbox/**'): BUG_COMPONENT = ('Core', 'Security: RLBox') diff --git a/toolkit/components/kvstore/moz.build b/toolkit/components/kvstore/moz.build index 02a8d2eee8a3..cb875eae7cfc 100644 --- a/toolkit/components/kvstore/moz.build +++ b/toolkit/components/kvstore/moz.build @@ -5,7 +5,7 @@ # file, You can obtain one at http://mozilla.org/MPL/2.0/. with Files("**"): - BUG_COMPONENT = ("Toolkit", "Storage") + BUG_COMPONENT = ("Core", "SQLite and Embedded Database Bindings") EXTRA_JS_MODULES += [ "kvstore.sys.mjs", diff --git a/toolkit/modules/moz.build b/toolkit/modules/moz.build index 6ba1e92026f6..865c60d9cf2a 100644 --- a/toolkit/modules/moz.build +++ b/toolkit/modules/moz.build @@ -115,7 +115,7 @@ with Files("ShortcutUtils.sys.mjs"): BUG_COMPONENT = ("Firefox", "Toolbars and Customization") with Files("Sqlite.sys.mjs"): - BUG_COMPONENT = ("Toolkit", "Storage") + BUG_COMPONENT = ("Core", "SQLite and Embedded Database Bindings") with Files("SubDialog.sys.mjs"): BUG_COMPONENT = ("Toolkit", "Content Prompts")