Closed Bug 1670191 Opened 5 years ago Closed 5 years ago

Remove confusing mentions about remote debugging in target-mixin's jsdoc

Categories

(DevTools :: Framework, task, P3)

task

Tracking

(firefox83 fixed)

RESOLVED FIXED
83 Branch
Tracking Status
firefox83 --- fixed

People

(Reporter: jdescottes, Assigned: jdescottes)

Details

Attachments

(1 file)

Spotted while reviewing https://phabricator.services.mozilla.com/D91559

In some spots in target-mixin.js we refer to "remote debugging":


    /**
     * Setup listeners for remote debugging, updating existing ones as necessary.
     */
    _setupRemoteListeners() {
      // ...
    }

    /**
     * Teardown listeners for remote debugging.
     */
    _teardownRemoteListeners() {
      // ...
    }

This can be quite confusing and lead to think this is only used for "remote debugging" (as in Remote Debugging via about:debugging). Whereas I think it simply refers to remote tabs, ie e10s tabs, which is basically always true now anyway.

We should remove those mentions from the comments and rename the methods.

Remote debugging in those method names and comments refered to e10s.
Nowadays remote debugging is rather used to talk about remote "browser" debugging, via about:debugging.
The comments give the false impression that those events are only used for about:debugging, which is not true.

Pushed by jdescottes@mozilla.com: https://hg.mozilla.org/integration/autoland/rev/1e2735ca642f [devtools] Remove mentions about remote debugging in target-mixin r=nchevobbe
Status: ASSIGNED → RESOLVED
Closed: 5 years ago
Resolution: --- → FIXED
Target Milestone: --- → 83 Branch
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: