PowerToys icon indicating copy to clipboard operation
PowerToys copied to clipboard

[EnvVar] Treat well-known debugging environment variables as lists

Open chwarr opened this issue 1 year ago • 1 comments

Summary of the Pull Request

Treat the following additional environment variables as lists, like the "PATH" variable:

  • _NT_SYMBOL_PATH
  • _NT_ALT_SYMBOL_PATH
  • _NT_SYMCACHE_PATH

PR Checklist

  • [x] Closes: #34661
  • [x] Communication: I've discussed this with core contributors already. If work hasn't been agreed, this work might be rejected
  • [x] Tests: N/A, as there are no existing automated tests for this feature
  • [x] Localization: N/A, as there are no user-visible strings
  • [x] Dev docs: N/A
  • [x] New binaries: N/A
  • [x] Documentation updated: N/A, as this behavior is not documented today.

Detailed Description of the Pull Request / Additional comments

Windows Debugger paths are documented as being semi-colon delimited. The _NT_SYMCACHE_PATH is used by WPA, and it also documented as being semi-colon delimited.

Validation Steps Performed

  1. Manually validated that _NT_SYMBOL_PATH, _NT_ALT_SYMBOL_PATH, and _NT_SYMCACHE_PATH use the list editing UX.
  2. Manually validated that PATH and PATHEXT continue to use the list editing UX.

chwarr avatar Sep 07 '24 00:09 chwarr

@check-spelling-bot Report

:red_circle: Please review

See the :open_file_folder: files view, the :scroll:action log, or :memo: job summary for details.

Unrecognized words (1)

SYMCACHE

Previously acknowledged words that are now absent applayout appsfolder systemsettings SYSTEMWOW USEPOSITION USESIZE 🫥
To accept these unrecognized words as correct and remove the previously acknowledged and now absent words, you could run the following commands

... in a clone of the [email protected]:chwarr/PowerToys.git repository on the debug-env-vars-lists branch (:information_source: how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.22/apply.pl' |
perl - 'https://github.com/microsoft/PowerToys/actions/runs/10746943566/attempts/1'
Available :books: dictionaries could cover words (expected and unrecognized) not in the :blue_book: dictionary

This includes both expected items (1896) from .github/actions/spell-check/expect.txt and unrecognized words (1)

Dictionary Entries Covers Uniquely
cspell:r/src/r.txt 543 1 1
cspell:cpp/src/people.txt 23 1
cspell:cpp/src/ecosystem.txt 51 1

Consider adding them (in .github/workflows/spelling2.yml) for uses: check-spelling/[email protected] in its with:

      with:
        extra_dictionaries:
          cspell:r/src/r.txt
          cspell:cpp/src/people.txt
          cspell:cpp/src/ecosystem.txt

To stop checking additional dictionaries, add (in .github/workflows/spelling2.yml) for uses: check-spelling/[email protected] in its with:

check_extra_dictionaries: ''
Warnings (1)

See the :open_file_folder: files view, the :scroll:action log, or :memo: job summary for details.

:information_source: Warnings Count
:information_source: non-alpha-in-dictionary 1

See :information_source: Event descriptions for more information.

If the flagged items are :exploding_head: false positives

If items relate to a ...

  • binary file (or some other file you wouldn't want to check at all).

    Please add a file path to the excludes.txt file matching the containing file.

    File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

    ^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).

  • well-formed pattern.

    If you can write a pattern that would match it, try adding it to the patterns.txt file.

    Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

    Note that patterns can't match multiline strings.

github-actions[bot] avatar Sep 07 '24 00:09 github-actions[bot]