Bug 1352825 - Fix comment typos of 'docshell'. r=MattN
authorPaul Bignier <paul.bignier@gmail.com>
Mon, 03 Apr 2017 09:09:00 -0400
changeset 555411 a7e88ab4d4bd7b48e80383a1386a838b7915fee9
parent 555410 6553dcb0df0cdae8cc9d68ae47fa04ca28aaf8c2
child 555412 d9b2934ac8606387e71e1f248613d4e32000cea7
push id52236
push usercykesiopka.bmo@gmail.com
push dateTue, 04 Apr 2017 09:12:57 +0000
reviewersMattN
bugs1352825
milestone55.0a1
Bug 1352825 - Fix comment typos of 'docshell'. r=MattN
docshell/base/nsIDocShell.idl
docshell/base/timeline/readme.md
toolkit/components/addoncompat/RemoteAddonsParent.jsm
--- a/docshell/base/nsIDocShell.idl
+++ b/docshell/base/nsIDocShell.idl
@@ -368,25 +368,25 @@ interface nsIDocShell : nsIDocShellTreeI
    * 1.0 all the time for the Get operation.  1.0 by the way is the default
    * of zoom.  This means 100% of normal scaling or in other words normal size
    * no zoom.
    */
   attribute float zoom;
 
   /*
    * The size, in CSS pixels, of the horizontal margins for the <body> of an
-   * HTML document in this docshel; used to implement the marginwidth attribute
+   * HTML document in this docshell; used to implement the marginwidth attribute
    * on HTML <frame>/<iframe> elements.  A value smaller than zero indicates
    * that the attribute was not set.
    */
   attribute long marginWidth;
 
   /*
    * The size, in CSS pixels, of the vertical margins for the <body> of an HTML
-   * document in this docshel; used to implement the marginheight attribute on
+   * document in this docshell; used to implement the marginheight attribute on
    * HTML <frame>/<iframe> elements.  A value smaller than zero indicates that
    * the attribute was not set.
    */
   attribute long marginHeight;
 
   /*
    * Tells the docshell to offer focus to its tree owner.
    * This is currently only necessary for embedding chrome.
--- a/docshell/base/timeline/readme.md
+++ b/docshell/base/timeline/readme.md
@@ -28,21 +28,21 @@ Note on why we handle on/off the main th
 
 ##ObservedDocShell
 The only implementation of a MarkersStorage we have right now is an `ObservedDocShell`.
 
 Instances of `ObservedDocShell` accumulate markers that are *mostly* about a particular docshell. At a high level, for example, an `ObservedDocshell` would be created when a timeline tool is opened on a page. It is reasonable to assume that most operations which are interesting for that particular page happen on the main thread. However certain operations may happen outside of it, yet are interesting for its developers, for which markers can be created as well (e.g. web audio stuff, service workers etc.). It is also reasonable to assume that a docshell may sometimes not be easily accessible from certain parts of the platform code, but for which markers still need to be created.
 
 Therefore, the following scenarios arise:
 
-- a). creating a marker on the main thread about a particular dochsell
+- a). creating a marker on the main thread about a particular docshell
 
 - b). creating a marker on the main thread without pinpointing to an affected docshell (unlikely, but allowed; in this case such a marker would have to be stored in all currently existing `ObservedDocShell` instances)
 
-- c). creating a marker off the main thread about a particular dochsell (impossible; docshells can't be referenced outside the main thread, in which case some other type of identification mechanism needs to be put in place).
+- c). creating a marker off the main thread about a particular docshell (impossible; docshells can't be referenced outside the main thread, in which case some other type of identification mechanism needs to be put in place).
 
 - d). creating a marker off the main thread without pinpointing to a particular docshell (same path as c. here, such a marker would have to be stored in all currently existing `ObservedDocShell` instances).
 
 An observed docshell (in other words, "a docshell for which a timeline tool was opened") can thus receive both main thread and off the main thread markers.
 
 Cross-process markers are unnecessary at the moment, but tracked in bug 1200120.
 
 ##TimelineConsumers
@@ -87,11 +87,11 @@ These markers will be created when using
 The easiest way to trace Gecko events/tasks with start and end timeline markers is to use the `mozilla::AutoTimelineMarker` RAII class. It automatically adds the start marker on construction, and adds the end marker on destruction. Don't worry too much about potential performance impact! It only actually adds the markers when the given docshell is being observed by a timeline consumer, so essentially nothing will happen if a tool to inspect those markers isn't specifically open.
 
 This class may only be used on the main thread, and pointer to a docshell is necessary. If the docshell is a nullptr, nothing happens and this operation fails silently.
 
 Example: `AutoTimelineMarker marker(aTargetNode->OwnerDoc()->GetDocShell(), "Parse HTML");`
 
 ### mozilla::AutoGlobalTimelineMarker`
 
-Similar to the previous RAII class, but doesn't expect a specific docshell, and the marker will be visible in all timeline consumers. This is useful for generic operations that don't involve a particular dochsell, or where a docshell isn't accessible. May also only be used on the main thread.
+Similar to the previous RAII class, but doesn't expect a specific docshell, and the marker will be visible in all timeline consumers. This is useful for generic operations that don't involve a particular docshell, or where a docshell isn't accessible. May also only be used on the main thread.
 
 Example: `AutoGlobalTimelineMarker marker("Some global operation");`
--- a/toolkit/components/addoncompat/RemoteAddonsParent.jsm
+++ b/toolkit/components/addoncompat/RemoteAddonsParent.jsm
@@ -829,17 +829,17 @@ ContentDocumentInterposition.methods.imp
       Cu.reportError("Calling contentDocument.importNode on a XUL node is not allowed.");
       return node;
     }
 
     return target.importNode(node, deep);
   };
 
 // This interposition ensures that calling browser.docShell from an
-// add-on returns a CPOW around the dochell.
+// add-on returns a CPOW around the docshell.
 var RemoteBrowserElementInterposition = new Interposition("RemoteBrowserElementInterposition",
                                                           EventTargetInterposition);
 
 RemoteBrowserElementInterposition.getters.docShell = function(addon, target) {
   CompatWarning.warn("Direct access to content docshell will no longer work in the chrome process.",
                      addon, CompatWarning.warnings.content);
   let remoteChromeGlobal = RemoteAddonsParent.browserToGlobal.get(target);
   if (!remoteChromeGlobal) {