Skip to content

Commit

Permalink
doc: bring back troubleshooting section, don't hide it on Install page
Browse files Browse the repository at this point in the history
(sapling split of 6e0b6260de10df4886f2243da55d6c8dacaae1d7)
  • Loading branch information
lahosken committed Mar 13, 2014
1 parent 00e1f10 commit 5e25143
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/python/twitter/pants/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,12 @@ How to configure build-able things in BUILD files.
python-readme
build_files
invoking
tshoot

Troubleshooting
---------------

* Something that usually works just failed? See :ref:`tshoot`.
* Something that usually works just failed? See :doc:`tshoot`.

* Publishing can fail in more ways. See :doc:`publish`.

Expand Down
38 changes: 38 additions & 0 deletions src/python/twitter/pants/docs/tshoot.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
###############
Troubleshooting
###############

Sometimes Pants doesn't do what you hoped. Sometimes it's a problem in your
code, but Pants' error handling is not so useful. (Please report these when
you see them. We want Pants' error messages to be useful.) Sometimes Pants
just plain doesn't work. (Please report these, too.) The following workarounds
can get you up and running again.

.. _verbosity:

*****************
Maximum Verbosity
*****************

To run a Pants command so that it outputs much much more information to stdout,
you can set some environment variables and pass the ``-ldebug`` flag (along
with the parameters you meant to pass)::

PEX_VERBOSE=1 PANTS_VERBOSE=1 PYTHON_VERBOSE=1 ./pants -ldebug ...

This can be especially useful if you're trying to figure out what Pants
was "looking at" when it crashed.

.. _washpants:

*********************
Scrub the Environment
*********************

If you suspect that Pants has cached some corrupt data somewhere, but don't
want to track down exactly what, you can reset your state::

$ build-support/python/clean.sh # clean cached files
$ ./pants goal ng-killall --ng-killall-everywhere # stop background procs


0 comments on commit 5e25143

Please sign in to comment.