Browse Source

Rebuild texinfo documentation

pull/9/head
Nicolas Petton 1 year ago
parent
commit
d02c702c69
No known key found for this signature in database GPG Key ID: E8BCD7866AFCF978
1 changed files with 36 additions and 30 deletions
  1. +36
    -30
      doc/Indium.texi

+ 36
- 30
doc/Indium.texi View File

@ -21,7 +21,7 @@
@copying
@quotation
Indium 2.1.1, Sep 25, 2019
Indium 2.1.4, Oct 22, 2019
Nicolas Petton
@ -144,7 +144,7 @@ The stepping debugger
Using sourcemaps
* Overriding sourcemap paths::
* Overriding script paths::
* Setting a different remote root (NodeJS): Setting a different remote root NodeJS.
The inspector
@ -325,14 +325,11 @@ this @code{.indium.json} file is placed, but it can be overridden with the @code
@}
@end example
Custom script path overrides can be set with @code{scriptPathRegexpOverrides}. See
@ref{14,,Overriding script paths} for more information on script paths and debugging.
Custom sourcemap path overrides can be set with @code{sourceMapPathOverrides}. See
@ref{15,,Using sourcemaps} for more information on sourcemaps and debugging.
@ref{14,,Using sourcemaps} for more information on sourcemaps and debugging.
@node Chrome/Chromium configuration options,NodeJS configuration options,General configuration,Getting up and running
@anchor{setup chrome-chromium-configuration-options}@anchor{16}@anchor{setup chrome-configuration}@anchor{11}
@anchor{setup chrome-chromium-configuration-options}@anchor{15}@anchor{setup chrome-configuration}@anchor{11}
@subsection Chrome/Chromium configuration options
@ -365,7 +362,7 @@ Example configuration:
@end example
@node NodeJS configuration options,Starting Indium,Chrome/Chromium configuration options,Getting up and running
@anchor{setup nodejs-configuration}@anchor{10}@anchor{setup nodejs-configuration-options}@anchor{17}
@anchor{setup nodejs-configuration}@anchor{10}@anchor{setup nodejs-configuration-options}@anchor{16}
@subsection NodeJS configuration options
@ -402,6 +399,10 @@ Here is an example configuration for debugging Gulp tasks:
@}
@end example
When the NodeJS application runs on another computer (or inside a container like
Docker), a custom remote project root path can be set with @code{remoteRoot}. See
@ref{17,,Setting a different remote root (NodeJS)} for more information on script paths and debugging.
@node Starting Indium,NodeJS requirements,NodeJS configuration options,Getting up and running
@anchor{setup id2}@anchor{18}@anchor{setup starting-indium}@anchor{19}
@subsection Starting Indium
@ -727,7 +728,7 @@ The left fringe or margin can also be clicked to add or remove breakpoints.
Once a breakpoint is set, execution will stop when a breakpoint is hit, and the
Indium debugger pops up (see @ref{2b,,The stepping debugger}).
Since Indium 0.7, breakpoints are supported in source files with an associated sourcemap, see @ref{15,,Using sourcemaps}.
Since Indium 0.7, breakpoints are supported in source files with an associated sourcemap, see @ref{14,,Using sourcemaps}.
@cartouche
@quotation Note
@ -748,7 +749,7 @@ connection is made Indium will attempt to add back all breakpoints.
@end menu
@node Using sourcemaps,Blackboxing scripts,,The stepping debugger
@anchor{debugger sourcemaps}@anchor{15}@anchor{debugger using-sourcemaps}@anchor{2e}
@anchor{debugger sourcemaps}@anchor{14}@anchor{debugger using-sourcemaps}@anchor{2e}
@subsection Using sourcemaps
@ -769,11 +770,11 @@ source-mapped. This can happen for instance when using Webpack.
@menu
* Overriding sourcemap paths::
* Overriding script paths::
* Setting a different remote root (NodeJS): Setting a different remote root NodeJS.
@end menu
@node Overriding sourcemap paths,Overriding script paths,,Using sourcemaps
@node Overriding sourcemap paths,Setting a different remote root NodeJS,,Using sourcemaps
@anchor{debugger overriding-sourcemap-paths}@anchor{2f}@anchor{debugger webpack}@anchor{30}
@subsubsection Overriding sourcemap paths
@ -803,29 +804,34 @@ sourcemap paths using @code{M-x indium-list-sourcemap-sources}.
@end quotation
@end cartouche
@node Overriding script paths,,Overriding sourcemap paths,Using sourcemaps
@anchor{debugger overriding-script-paths}@anchor{31}@anchor{debugger scriptpaths}@anchor{14}
@subsubsection Overriding script paths
@node Setting a different remote root NodeJS,,Overriding sourcemap paths,Using sourcemaps
@anchor{debugger remoteroot}@anchor{17}@anchor{debugger setting-a-different-remote-root-nodejs}@anchor{31}
@subsubsection Setting a different remote root (NodeJS)
If your application’s script URLs don’t correspond directly to where
their source code is located, you can use @code{scriptPathRegexpOverrides} to
tell Indium where to find the sources. It maps regular expressions to
Javascript substitution strings.
When running a NodeJS application on a remote machine or inside a Docker
container, your application’s root folder path might not correspond to where
their source code is located on your local disk.
For example, if your project root is @code{/home/user/projects/foo/}, and
the source code for @indicateurl{http://localhost:3000/js/app.js/1234567890} is at
@code{/home/user/projects/foo/private/js/app.js}, you might set
@code{scriptPathRegexpOverrides} to:
In this case, you can tell Indium to replace the @code{root} path with a different
location using the @code{remoteRoot} configuration option.
@quotation
@table @asis
@item @{
“remoteRoot”: “/var/task”
@end table
@example
@{
"(/js/.*\\.js)/[0-9]+": "private$1"
@}
@end example
@end quotation
This removes the trailing slash and digits, and it adds “private” to
the beginning of the path below the project root.
Note that @code{remoteRoot} can be used together with the @code{root} configuration
option.
@node Blackboxing scripts,,Using sourcemaps,The stepping debugger
@anchor{debugger blackboxing-scripts}@anchor{32}
@ -998,7 +1004,7 @@ that the file where you’re trying to add a breakpoint is listed.
Correctly mapping sourcemaps to file locations can be tedious (see
@ref{15,,Using sourcemaps}).
@ref{14,,Using sourcemaps}).
Indium provides the command @code{indium-list-sourcemap-sources} to help
configuring sourcemaps correctly. This command displays a list of all


Loading…
Cancel
Save