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