1.. _module-pw_doctor: 2 3--------- 4pw_doctor 5--------- 6``pw doctor`` confirms the environment is set up correctly. With ``--strict`` 7it checks that things exactly match what is expected and it checks that things 8look compatible without. 9 10Projects that adjust the behavior of pw_env_setup may need to customize 11these checks, but unfortunately this is not generally supported yet. 12 13Checks carried out by pw_doctor include: 14 15* The bootstrapped OS matches the current OS. 16* ``PW_ROOT`` is defined and points to the root of the Pigweed repo. 17 18 - If your copy of pigweed is intentionally vendored and not a git repo (or 19 submodule), set ``PW_DISABLE_ROOT_GIT_REPO_CHECK=1`` during bootstrap to 20 suppress the anti-vendoring portion of this check. 21 22* The presubmit git hook is installed. 23* Python is one of the :ref:`supported versions <docs-concepts-python-version>`. 24* The Pigweed virtual env is active. 25* CIPD is set up correctly and in use. 26* The CIPD packages required by Pigweed are up to date. 27* The platform support symlinks. 28 29.. note:: 30 The documentation for this module is currently incomplete. 31 32Configuration 33============= 34Options for ``pw doctor`` can be specified in the ``pigweed.json`` file 35(see also :ref:`SEED-0101 <seed-0101>`). This is currently limited to one 36option. 37 38* ``new_bug_url``: What link is given to users be given for filing bugs. By 39 default this is to the `Pigweed Bug Tracker_`. 40 41.. _Pigweed Bug Tracker: https://issues.pigweed.dev/new 42 43.. code-block:: 44 45 { 46 "pw": { 47 "pw_doctor": { 48 "new_bug_url": "https://example.com/bugs/new" 49 } 50 } 51 } 52