aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/generate-libbe-txt.py3
-rw-r--r--doc/hacking.txt14
-rw-r--r--doc/index.txt1
-rw-r--r--doc/install.txt2
-rw-r--r--doc/power.txt27
-rw-r--r--doc/tutorial.txt6
6 files changed, 46 insertions, 7 deletions
diff --git a/doc/generate-libbe-txt.py b/doc/generate-libbe-txt.py
index e352310..47484df 100644
--- a/doc/generate-libbe-txt.py
+++ b/doc/generate-libbe-txt.py
@@ -1,6 +1,7 @@
#!/usr/bin/python
#
-# Copyright (C) 2010-2011 W. Trevor King <wking@drexel.edu>
+# Copyright (C) 2010-2011 Chris Ball <cjb@laptop.org>
+# W. Trevor King <wking@drexel.edu>
#
# This file is part of Bugs Everywhere.
#
diff --git a/doc/hacking.txt b/doc/hacking.txt
index 54be7bc..941dfde 100644
--- a/doc/hacking.txt
+++ b/doc/hacking.txt
@@ -71,10 +71,18 @@ execution + childrens' times)::
$ python -m cProfile -o profile be [command] [args]
$ python -c "import pstats; p=pstats.Stats('profile'); p.sort_stats('cumulative').print_stats(20)"
-It's often useful to toss::
+If you want to find out who's calling your expensive function
+(e.g. :func:`libbe.util.subproc.invoke`), try::
+
+ $ python -c "import pstats; p=pstats.Stats('profile'); p.sort_stats('cumulative').print_callers(20)"
+
+You can also toss::
import sys, traceback
print >> sys.stderr, '-'*60, '\n', '\n'.join(traceback.format_stack()[-10:])
-into expensive functions (e.g. :func:`libbe.util.subproc.invoke`) if
-you're not sure why they're being called.
+into the function itself for a depth-first caller list.
+
+For a more top-down approach, try::
+
+ $ python -c "import pstats; p=pstats.Stats('profile'); p.sort_stats('cumulative').print_callees(20)"
diff --git a/doc/index.txt b/doc/index.txt
index e8d8f07..7745d0c 100644
--- a/doc/index.txt
+++ b/doc/index.txt
@@ -27,6 +27,7 @@ Contents:
email
http
distributed_bugtracking
+ power
hacking
spam
libbe/libbe
diff --git a/doc/install.txt b/doc/install.txt
index c428087..fd2bcaf 100644
--- a/doc/install.txt
+++ b/doc/install.txt
@@ -9,6 +9,7 @@ Dependencies
Package Role Debian Gentoo
============== ======================= =============== ===========================
PyYAML_ serialized data storage python-yaml dev-python/pyyaml
+Jinja_ HTML templating python-jinja2 deb-python/jinja
Sphinx_ see :doc:`doc` python-sphinx dev-python/sphinx
numpydoc_ see :doc:`doc` dev-python/numpydoc [#npd]_
Docutils_ manpage generation python-docutils dev-python/docutils
@@ -17,6 +18,7 @@ Docutils_ manpage generation python-docutils dev-python/docutils
.. [#npd] In the science_ overlay.
.. _PyYAML: http://pyyaml.org/
+.. _Jinja: http://jinja.pocoo.org/
.. _Sphinx: http://sphinx.pocoo.org/
.. _numpydoc: http://pypi.python.org/pypi/numpydoc
.. _Docutils: http://docutils.sourceforge.net/
diff --git a/doc/power.txt b/doc/power.txt
new file mode 100644
index 0000000..b0e93ea
--- /dev/null
+++ b/doc/power.txt
@@ -0,0 +1,27 @@
+**************
+Power features
+**************
+
+BE comes with a number of additional utilities and features that may
+be useful to power users. We'll try to keep an up to date list here,
+but your best bet may be poking around in the source on your own.
+
+Autocompletion
+==============
+
+:file:`misc/completion` contains completion scripts for common shells
+(if we don't have a completion script for your favorite shell, submit
+one!). Basic instructions for installing the completion file for a
+given shell should be given in the completion script comments.
+
+Packagers should install these completion scripts in their system's
+usual spot (on Gentoo it's :file:`/etc/bash_completion.d/`).
+
+XML-handling utilities
+======================
+
+Email threads are quite similar to the bugs/issues that BE tracks.
+There are a number of useful scripts in :file:`misc/xml` to go back
+and forth between the two formats using BE's XML format. The commands
+should be well documented. Use the usual ``<command> --help`` for
+more details on a given command.
diff --git a/doc/tutorial.txt b/doc/tutorial.txt
index e6790cd..c82f7c5 100644
--- a/doc/tutorial.txt
+++ b/doc/tutorial.txt
@@ -16,7 +16,7 @@ and helps keep the bug repository in sync with the code.
However, there are some differences compared to centralized
bugtrackers. Because bugs and comments can be created by several
users in parallel, they have globally unique :mod:`IDs
-</libbe.util.id>` rather than numbers. There is also a
+<libbe.util.id>` rather than numbers. There is also a
developer-friendly command-line_ interface to compliment the
user-friendly :doc:`web </http>` and :doc:`email </email>` interfaces.
This tutorial will focus on the command-line interface as the most
@@ -102,8 +102,8 @@ if you call it from a directory besides your project's root.
Inside the ``.be`` directory (among other things) there will be a long
UUID_ directory. This is your bug directory. The idea is that you
could keep several bug directories in the same repository, using one
-to track bugs, another to track roadmap issues, etc. See :mod:`IDs`
-for details. For BE itself, the bug directory is
+to track bugs, another to track roadmap issues, etc. See :mod:`IDs
+<libbe.util.id>` for details. For BE itself, the bug directory is
``bea86499-824e-4e77-b085-2d581fa9ccab``, which is why all the bug and
comment IDs in this tutorial will start with ``bea/``.