New issue
Advanced search Search tips
Note: Color blocks (like or ) mean that a user may not be available. Tooltip shows the reason.

Issue 692323 link

Starred by 2 users

Issue metadata

Status: Untriaged
Owner: ----
Cc:
EstimatedDays: ----
NextAction: 2019-07-09
OS: All
Pri: 3
Type: Bug



Sign in to add a comment

Search engines documentation does not match code

Project Member Reported by pkasting@chromium.org, Feb 15 2017

Issue description

The documentation on https://developer.chrome.com/extensions/settings_override#search_provider is not correct.

For example, the "short_name" field for search engines is not documented here, but is required by the code to accept an entry (see https://cs.chromium.org/chromium/src/components/search_engines/template_url_data_util.cc?l=27 ).  Other documentation, such as whether certain fields are optional if "prepopulate_id" is specified, also does not match the code.

I don't know whether this is a documentation bug or a code bug, but the two need to be brought into sync.

Not sure if this is the right venue for this.
 
Cc: rdevlin....@chromium.org
We set short name internally here: https://chromium.googlesource.com/chromium/src/+/4a1e5ced806c4452252e6531e50b3549b31f5f96/chrome/browser/extensions/api/settings_overrides/settings_overrides_api.cc#78

Which fields are incorrectly annotated as optional with prepopulate_id present?
Well, that's an interesting function.  I wasn't aware that this "preprocessing" step occurred.  Good to know.  That resolves both issues I cited, as if there's a prepopulate ID, we use the prepopulate data for all the initial values and just overwrite them.

Is this codepath also traversed for cases where people set search engines by policy?  If not, that should also be checked to see if the documentation and code match.

I don't know if you know where that is.  Feel free to morph or close this as appropriate.
Cc: bartfab@chromium.org atwilson@chromium.org
Components: -Platform>Extensions>Documentation
I don't know much about setting search engines by policy - I think they're fairly different paths.  bartfab@ or atwilson@ might know more (or know who would).  I think that documentation is somewhere around here:
http://dev.chromium.org/administrators/policy-list-3#DefaultSearchProvider

All search engines set through extensions (or transitively through policy-installed extensions) would go through this path.

Remove extensions component, since it seems like the extensions side is okay.  (I can't find a policy component to replace it with, strangely...)
Labels: Pri-3
NextAction: 2019-07-09
Downgrading P2s that haven't been modified in more than 6 months, which have no component or owner.

Sign in to add a comment