Skip to content

Commit e6b9803

Browse files
seyidanielspre-commit-ci[bot]gaborbernat
authored
Table with list of default env vars per OS (#3291)
* Table with list of default env vars per OS * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update env variables list * ADD windir env variable --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Bernát Gábor <[email protected]>
1 parent 33f6c23 commit e6b9803

File tree

2 files changed

+150
-0
lines changed

2 files changed

+150
-0
lines changed

docs/changelog/2753.bugfix.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add table with default environment variables per OS

docs/config.rst

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -289,6 +289,155 @@ Base options
289289
tox invocation environment it is ignored. The list of environment variable names is not case sensitive, for example:
290290
passing ``A`` or ``a`` will pass through both ``A`` and ``a``.
291291

292+
Some variables are always passed through to ensure the basic functionality of standard library functions or tooling like
293+
pip. This is also not case sensitive on all platforms except Windows.
294+
295+
.. list-table:: Environment Variables per Operating System
296+
:widths: 25 25 25 25
297+
:header-rows: 1
298+
299+
* - Environment Variable
300+
- Linux
301+
- MacOS
302+
- Windows
303+
* - https_proxy
304+
- ✅
305+
- ✅
306+
- ✅
307+
* - http_proxy
308+
- ✅
309+
- ✅
310+
- ✅
311+
* - no_proxy
312+
- ✅
313+
- ✅
314+
- ✅
315+
* - LANG
316+
- ✅
317+
- ✅
318+
- ✅
319+
* - LANGUAGE
320+
- ✅
321+
- ✅
322+
- ✅
323+
* - CURL_CA_BUNDLE
324+
- ✅
325+
- ✅
326+
- ✅
327+
* - SSL_CERT_FILE
328+
- ✅
329+
- ✅
330+
- ✅
331+
* - CC
332+
- ✅
333+
- ✅
334+
- ✅
335+
* - CFLAGS
336+
- ✅
337+
- ✅
338+
- ✅
339+
* - CCSHARED
340+
- ✅
341+
- ✅
342+
- ✅
343+
* - CXX
344+
- ✅
345+
- ✅
346+
- ✅
347+
* - CPPFLAGS
348+
- ✅
349+
- ✅
350+
- ✅
351+
* - LD_LIBRARY_PATH
352+
- ✅
353+
- ✅
354+
- ✅
355+
* - LDFLAGS
356+
- ✅
357+
- ✅
358+
- ✅
359+
* - HOME
360+
- ✅
361+
- ✅
362+
- ✅
363+
* - FORCE_COLOR
364+
- ✅
365+
- ✅
366+
- ✅
367+
* - NO_COLOR
368+
- ✅
369+
- ✅
370+
- ✅
371+
* - TMPDIR
372+
- ✅
373+
- ✅
374+
- ❌
375+
* - TEMP
376+
- ❌
377+
- ❌
378+
- ✅
379+
* - TMP
380+
- ❌
381+
- ❌
382+
- ✅
383+
* - USERPROFILE
384+
- ❌
385+
- ❌
386+
- ✅
387+
* - PATHEXT
388+
- ❌
389+
- ❌
390+
- ✅
391+
* - MSYSTEM
392+
- ❌
393+
- ❌
394+
- ✅
395+
* - WINDIR
396+
- ❌
397+
- ❌
398+
- ✅
399+
* - APPDATA
400+
- ❌
401+
- ❌
402+
- ✅
403+
* - PROGRAMDATA
404+
- ❌
405+
- ❌
406+
- ✅
407+
* - PROGRAMFILES(x86)
408+
- ❌
409+
- ❌
410+
- ✅
411+
* - SYSTEMDRIVE
412+
- ❌
413+
- ❌
414+
- ✅
415+
* - SYSTEMROOT
416+
- ❌
417+
- ❌
418+
- ✅
419+
* - COMSPEC
420+
- ❌
421+
- ❌
422+
- ✅
423+
* - PROCESSOR_ARCHITECTURE
424+
- ❌
425+
- ❌
426+
- ✅
427+
* - NUMBER_OF_PROCESSORS
428+
- ❌
429+
- ❌
430+
- ✅
431+
* - PIP_*
432+
- ✅
433+
- ✅
434+
- ✅
435+
* - VIRTUALENV_*
436+
- ✅
437+
- ✅
438+
- ✅
439+
440+
292441
More environment variable-related information
293442
can be found in :ref:`environment variable substitutions`.
294443

0 commit comments

Comments
 (0)