doc(resources): Preferences, HstsPreloadList, RippyPNG (#33775)

* Set to default if Preferences and HstsPreloadList are empty

Signed-off-by: Wu Yu Wei <yuweiwu@pm.me>

* Add documentation of Preferences, HstsPreloadList, RippyPNG

Signed-off-by: Wu Yu Wei <yuweiwu@pm.me>

* Add warn log when setting prefs to default

Signed-off-by: Wu Yu Wei <yuweiwu@pm.me>

* Add error log instead

Signed-off-by: Wu Yu Wei <yuweiwu@pm.me>

* Add error log to HSTS preload list

Signed-off-by: Wu Yu Wei <yuweiwu@pm.me>

* Apply suggestions from code review

Address a couple wording nits

Signed-off-by: Martin Robinson <mrobinson@igalia.com>

---------

Signed-off-by: Wu Yu Wei <yuweiwu@pm.me>
Signed-off-by: Martin Robinson <mrobinson@igalia.com>
Co-authored-by: Martin Robinson <mrobinson@igalia.com>
This commit is contained in:
Ngo Iok Ui (Wu Yu Wei) 2024-10-11 03:19:41 +09:00 committed by GitHub
parent fd19409f31
commit b58cee48ce
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 20 additions and 4 deletions

View file

@ -55,9 +55,13 @@ pub fn sandbox_access_files_dirs() -> Vec<PathBuf> {
}
pub enum Resource {
/// A json file of [`Preferences`](servo_config::pref_util::Preferences) configuration.
/// It can be empty but lots of features will be disabled.
Preferences,
BluetoothBlocklist,
DomainList,
/// A preloaded list of HTTP Strict Transport Security. It can be an empty list and
/// [`HstsList::default()`](net::hsts::HstsList) will be called.
HstsPreloadList,
BadCertHTML,
NetErrorHTML,
@ -65,6 +69,12 @@ pub enum Resource {
ServoCSS,
PresentationalHintsCSS,
QuirksModeCSS,
/// A placeholder image to display if we couldn't get the requested image.
///
/// ## Safety
///
/// Servo will crash if this is an invalid image. Check `resources/rippy.png` in Servo codebase to see what
/// a default rippy png should look like.
RippyPNG,
MediaControlsCSS,
MediaControlsJS,