1728604 - `mach doc` does not properly regenerate docs after detecting change

Status: RESOLVED FIXED

(Developer Infrastructure :: Source Documentation, defect)

Description

[Kagami Rosylight [:saschanaz] (they/them)]

Changing one of the rst files correctly triggers rebuild but somehow the result is always same as before.

[I 210901 17:50:08 watcher:110] Running task: anonymous (delay: None)
Run sphinx with:
['-T', '-b', 'html', '-c', 'C:\\Users\\Kagami\\Documents\\GitHub\\gecko-dev\\docs', 'dom\\docs', 'C:/Users/Kagami/Documents/GitHub/gecko-dev/obj-x86_64-pc-mingw32\\docs\\html', '-j', '8']
Running Sphinx v4.1.2
Reading Sphinx metadata from build configuration
Staging static documentation
Generating Python API documentation
WARNING: The config value `js_source_path' has type `list', defaults to `str'.
loading pickled environment... done
ERROR: Unable to parse a tag's type expression for source file C:\Users\Kagami\Documents\GitHub\gecko-dev\remote\marionette\prefs.js in line 32 with tag title "param" and text "{?=} fallback
    Fallback value to return if `pref` does not exist.": Invalid type expression "?=": Expected "!", "?", or "|" but end of input found.
ERROR: Unable to parse a tag's type expression for source file C:\Users\Kagami\Documents\GitHub\gecko-dev\remote\marionette\prefs.js in line 48 with tag title "param" and text "{?=} fallback
    Fallback value to return if `pref` does not exist.": Invalid type expression "?=": Expected "!", "?", or "|" but end of input found.
ERROR: Unable to parse a tag's type expression for source file C:\Users\Kagami\Documents\GitHub\gecko-dev\toolkit\components\extensions\ConduitsParent.jsm in line 70 with tag title "type" and text "{Map<ConduitID, ConduitAddress> Info about all child conduits.}": Invalid type expression "Map<ConduitID, ConduitAddress> Info about all child conduits.": Expected "|" but "I" found.
ERROR: Unable to parse a tag's type expression for source file C:\Users\Kagami\Documents\GitHub\gecko-dev\toolkit\components\extensions\ConduitsParent.jsm in line 71 with tag title "type" and text "{Map<ConduitID, ConduitAddress> Info about all child conduits.}": Invalid type expression "Map<ConduitID, ConduitAddress> Info about all child conduits.": Expected "|" but "I" found.
ERROR: Unable to parse a tag's type expression for source file C:\Users\Kagami\Documents\GitHub\gecko-dev\toolkit\components\extensions\ConduitsParent.jsm in line 73 with tag title "type" and text "{Map<ConduitID, BroadcastConduit> All open parent conduits.}": Invalid type expression "Map<ConduitID, BroadcastConduit> All open parent conduits.": Expected "|" but "A" found.
ERROR: Unable to parse a tag's type expression for source file C:\Users\Kagami\Documents\GitHub\gecko-dev\toolkit\components\extensions\ConduitsParent.jsm in line 74 with tag title "type" and text "{Map<ConduitID, BroadcastConduit> All open parent conduits.}": Invalid type expression "Map<ConduitID, BroadcastConduit> All open parent conduits.": Expected "|" but "A" found.
ERROR: Unable to parse a tag's type expression for source file C:\Users\Kagami\Documents\GitHub\gecko-dev\toolkit\components\extensions\ConduitsParent.jsm in line 76 with tag title "type" and text "{Map<string, BroadcastConduit> Parent conduits by recvMethod.}": Invalid type expression "Map<string, BroadcastConduit> Parent conduits by recvMethod.": Expected "|" but "P" found.
ERROR: Unable to parse a tag's type expression for source file C:\Users\Kagami\Documents\GitHub\gecko-dev\toolkit\components\extensions\ConduitsParent.jsm in line 77 with tag title "type" and text "{Map<string, BroadcastConduit> Parent conduits by recvMethod.}": Invalid type expression "Map<string, BroadcastConduit> Parent conduits by recvMethod.": Expected "|" but "P" found.
ERROR: Unable to parse a tag's type expression for source file C:\Users\Kagami\Documents\GitHub\gecko-dev\toolkit\components\extensions\ConduitsParent.jsm in line 79 with tag title "type" and text "{WeakMap<ConduitsParent, Set<ConduitAddress>> Conduits by actor.}": Invalid type expression "WeakMap<ConduitsParent, Set<ConduitAddress>> Conduits by actor.": Expected "|" but "C" found.
ERROR: Unable to parse a tag's type expression for source file C:\Users\Kagami\Documents\GitHub\gecko-dev\toolkit\components\extensions\ConduitsParent.jsm in line 80 with tag title "type" and text "{WeakMap<ConduitsParent, Set<ConduitAddress>> Conduits by actor.}": Invalid type expression "WeakMap<ConduitsParent, Set<ConduitAddress>> Conduits by actor.": Expected "|" but "C" found.
ERROR: Unable to parse a tag's type expression for source file C:\Users\Kagami\Documents\GitHub\gecko-dev\toolkit\components\extensions\ConduitsParent.jsm in line 285 with tag title "param" and text "{Promise<response>[]} promises": Invalid type expression "Promise<response>[]": Expected "!", "=", "?", "|", or end of input but "[" found.
ERROR: Unable to parse a tag's type expression for source file C:\Users\Kagami\Documents\GitHub\gecko-dev\toolkit\components\extensions\ConduitsParent.jsm in line 290 with tag title "param" and text "{Promise<response>[]} promises": Invalid type expression "Promise<response>[]": Expected "!", "=", "?", "|", or end of input but "[" found.
WARNING: The @private tag does not permit a value; the value will be ignored. File: MessageManagerProxy.jsm, line: 151
WARNING: The @private tag does not permit a value; the value will be ignored. File: MessageManagerProxy.jsm, line: 155
WARNING: The @private tag does not permit a value; the value will be ignored. File: MessageManagerProxy.jsm, line: 163
WARNING: The @private tag does not permit a value; the value will be ignored. File: MessageManagerProxy.jsm, line: 170
WARNING: The @private tag does not permit a value; the value will be ignored. File: MessageManagerProxy.jsm, line: 185
WARNING: The @private tag does not permit a value; the value will be ignored. File: MessageManagerProxy.jsm, line: 192
ERROR: Unable to parse a tag's type expression for source file C:\Users\Kagami\Documents\GitHub\gecko-dev\toolkit\components\featuregates\FeatureGateImplementation.jsm in line 218 with tag title "param" and text "{Function(newValue: boolean)} [observer.onChange] Called when the
       feature's state changes to any value. The new value will be passed to the
       function.": Invalid type expression "Function(newValue: boolean)": Expected "$", "'", ".", "0", "@", "\"", "\\", "_", "break", "case", "catch", "class", "const", "continue", "debugger", "default", "delete", "do", "else", "enum", "export", "extends", "finally", "for", "function", "if", "implements", "import", "in", "instanceof", "interface", "let", "new", "package", "private", "protected", "public", "return", "static", "super", "switch", "this", "throw", "try", "typeof", "var", "void", "while", "with", "yield", Unicode letter number, Unicode lowercase letter, Unicode modifier letter, Unicode other letter, Unicode titlecase letter, Unicode uppercase letter, or [1-9] but " " found.
ERROR: Unable to parse a tag's type expression for source file C:\Users\Kagami\Documents\GitHub\gecko-dev\toolkit\components\featuregates\FeatureGateImplementation.jsm in line 233 with tag title "param" and text "{Function(newValue: boolean)} [observer.onChange] Called when the
       feature's state changes to any value. The new value will be passed to the
       function.": Invalid type expression "Function(newValue: boolean)": Expected "$", "'", ".", "0", "@", "\"", "\\", "_", "break", "case", "catch", "class", "const", "continue", "debugger", "default", "delete", "do", "else", "enum", "export", "extends", "finally", "for", "function", "if", "implements", "import", "in", "instanceof", "interface", "let", "new", "package", "private", "protected", "public", "return", "static", "super", "switch", "this", "throw", "try", "typeof", "var", "void", "while", "with", "yield", Unicode letter number, Unicode lowercase letter, Unicode modifier letter, Unicode other letter, Unicode titlecase letter, Unicode uppercase letter, or [1-9] but " " found.
ERROR: Unable to parse a tag's type expression for source file C:\Users\Kagami\Documents\GitHub\gecko-dev\toolkit\mozapps\extensions\AbuseReporter.jsm in line 373 with tag title "prop" and text "{Promise<AbuseReport|undefined} promiseReport
         A promise resolved to an AbuseReport instance if the report should
         be submitted, or undefined if the user has cancelled the report.
         Rejects if it fails to create an AbuseReport instance or to open
         the abuse report window.": Invalid type expression "Promise<AbuseReport|undefined": Expected ",", "=", ">", or "|" but end of input found.
ERROR: Unable to parse a tag's type expression for source file C:\Users\Kagami\Documents\GitHub\gecko-dev\toolkit\mozapps\extensions\AbuseReporter.jsm in line 400 with tag title "prop" and text "{Promise<AbuseReport|undefined} promiseReport
         A promise resolved to an AbuseReport instance if the report should
         be submitted, or undefined if the user has cancelled the report.
         Rejects if it fails to create an AbuseReport instance or to open
         the abuse report window.": Invalid type expression "Promise<AbuseReport|undefined": Expected ",", "=", ">", or "|" but end of input found.
ERROR: Unable to parse a tag's type expression for source file C:\Users\Kagami\Documents\GitHub\gecko-dev\toolkit\components\pictureinpicture\PictureInPicture.jsm in line 150 with tag title "return" and text "{DOM Window} the player window if it exists and is not in the
process of being closed. Returns null otherwise.": Invalid type expression "DOM Window": Expected "|" but "W" found.
ERROR: Unable to parse a tag's type expression for source file C:\Users\Kagami\Documents\GitHub\gecko-dev\toolkit\components\pictureinpicture\PictureInPicture.jsm in line 159 with tag title "return" and text "{DOM Window} the player window if it exists and is not in the
process of being closed. Returns null otherwise.": Invalid type expression "DOM Window": Expected "|" but "W" found.
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 1 source files that are out of date
updating environment: 0 added, 1 changed, 0 removed
reading sources... [100%] index
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:5: WARNING: toctree contains reference to nonexisting document 'setup/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:11: WARNING: toctree contains reference to nonexisting document 'contributing/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:11: WARNING: toctree contains reference to nonexisting document 'bug-mgmt/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:18: WARNING: toctree contains reference to nonexisting document 'browser/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:18: WARNING: toctree contains reference to nonexisting document 'dom/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:18: WARNING: toctree contains reference to nonexisting document 'editor/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:18: WARNING: toctree contains reference to nonexisting document 'layout/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:18: WARNING: toctree contains reference to nonexisting document 'gfx/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:18: WARNING: toctree contains reference to nonexisting document 'devtools/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:18: WARNING: toctree contains reference to nonexisting document 'toolkit/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:18: WARNING: toctree contains reference to nonexisting document 'js/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:18: WARNING: toctree contains reference to nonexisting document 'mobile/android/geckoview/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:18: WARNING: toctree contains reference to nonexisting document 'dom/bindings/webidl/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:18: WARNING: toctree contains reference to nonexisting document 'modules/libpref/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:18: WARNING: toctree contains reference to nonexisting document 'networking/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:18: WARNING: toctree contains reference to nonexisting document 'remote/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:18: WARNING: toctree contains reference to nonexisting document 'services/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:18: WARNING: toctree contains reference to nonexisting document 'uriloader/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:18: WARNING: toctree contains reference to nonexisting document 'widget/cocoa/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:18: WARNING: toctree contains reference to nonexisting document 'code-quality/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:18: WARNING: toctree contains reference to nonexisting document 'writing-rust-code/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:18: WARNING: toctree contains reference to nonexisting document 'tools/profiler/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:18: WARNING: toctree contains reference to nonexisting document 'performance/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:18: WARNING: toctree contains reference to nonexisting document 'xpcom/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:18: WARNING: toctree contains reference to nonexisting document 'security/nss/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:45: WARNING: toctree contains reference to nonexisting document 'mach/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:45: WARNING: toctree contains reference to nonexisting document 'tools/try/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:45: WARNING: toctree contains reference to nonexisting document 'build/buildsystem/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:45: WARNING: toctree contains reference to nonexisting document 'taskcluster/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:45: WARNING: toctree contains reference to nonexisting document 'tools/moztreedocs/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:55: WARNING: toctree contains reference to nonexisting document 'testing/testing-policy/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:55: WARNING: toctree contains reference to nonexisting document 'testing/ci-configs/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:55: WARNING: toctree contains reference to nonexisting document 'testing/marionette/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:55: WARNING: toctree contains reference to nonexisting document 'testing/geckodriver/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:55: WARNING: toctree contains reference to nonexisting document 'web-platform/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:55: WARNING: toctree contains reference to nonexisting document 'tools/fuzzing/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:55: WARNING: toctree contains reference to nonexisting document 'tools/sanitizer/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:55: WARNING: toctree contains reference to nonexisting document 'testing/perfdocs/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:55: WARNING: toctree contains reference to nonexisting document 'tools/code-coverage/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:55: WARNING: toctree contains reference to nonexisting document 'testing-rust-code/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:70: WARNING: toctree contains reference to nonexisting document 'intl/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:70: WARNING: toctree contains reference to nonexisting document 'l10n/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:77: WARNING: toctree contains reference to nonexisting document 'mozbase/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:77: WARNING: toctree contains reference to nonexisting document 'python/index'
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:84: WARNING: toctree contains reference to nonexisting document 'metrics/index'
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index
C:\Users\Kagami\Documents\GitHub\gecko-dev\obj-x86_64-pc-mingw32\docs\html\_staging\index.rst:96: WARNING: undefined label: search
generating indices... genindex done
writing additional pages... search done
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 47 warnings.

The HTML pages are in obj-x86_64-pc-mingw32\docs\html.

Comment 1

[Kagami Rosylight [:saschanaz] (they/them)]

Attachment: Bug 1728604 - Normalize path before doc path comparison

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/766dcd9811aa
Normalize path before doc path comparison r=mhentges

Comment 3

[Noemi Erli[:noemi_erli]]

https://hg.mozilla.org/mozilla-central/rev/766dcd9811aa