Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Bianca Henderson <[email protected]>
  • Loading branch information
jaimergp and beeankha authored Feb 6, 2024
1 parent 62ec2d4 commit 1521e2e
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/source/cli-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Windows installers have the following CLI options available:
to `0`.
- `/NoShortcuts=[0|1]`: If set to `1`, the installer will not create any shortcuts. Defaults to
`0`.
- `/RegisterPython=[0|1]`: Whether toregister Python as default in the Windows registry. Defaults
- `/RegisterPython=[0|1]`: Whether to register Python as default in the Windows registry. Defaults
to `1`. This is preferred to `AddToPath`.

You can also supply [standard NSIS flags](https://nsis.sourceforge.io/Docs/Chapter3.html#installerusage), but only _after_ the ones mentioned above:
Expand Down
8 changes: 4 additions & 4 deletions docs/source/debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Whether it's while running `constructor` to build an installer, or while the ins

## Verbose shell installers

The shell installers are "just" a shell script that invokes `conda` in certain events. This means you can enable `bash` verbosity via the `-x` flag:
The shell installers are simply shell scripts that invoke `conda` in certain events. This means you can enable `bash` verbosity via the `-x` flag:

```bash
$ bash -x ./Miniconda.sh
Expand All @@ -29,7 +29,7 @@ $ CONDA_VERBOSITY=3 bash -x ./Miniconda.sh

PKG installers are usually invoked graphically. You can check the native logs via <kbd>⌘</kbd>+<kbd>L</kbd>. Note that you will need to choose the detailed view in the dropdown menu you'll find in the top right corner.

In order to get more verbosity out of conda, you now know you need the `CONDA_VERBOSITY` variable. However, it needs to be set up _before_ running the installer. One way from the command line would be:
In order to get more verbosity out of `conda`, you now know you need the `CONDA_VERBOSITY` variable. However, it needs to be set up _before_ running the installer. One way from the command line would be:

```bash
$ CONDA_VERBOSITY=3 installer -pkg ./path/to/installer.pkg -target LocalSystem
Expand All @@ -50,13 +50,13 @@ If you want `conda` to print more details, then, run it from the CMD prompt like

### Building logging-enabled EXE installers

There's a way of building EXE installers that do write logs to a file. For this, you need a special `nsis` package configured to do so:
There's a way of building EXE installers that can write logs to a file; for this, you need a special `nsis` package configured to do so:

```batch
> conda install "nsis=*=*log*"
```

Then, you can invoke `constructor` normally, but setting a special environment variable:
Then, you can invoke `constructor` normally after setting a special environment variable:

```batch
> set "NSIS_USING_LOG_BUILD=1"
Expand Down

0 comments on commit 1521e2e

Please sign in to comment.