aboutsummaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* remove serve-storage and HTTP storage driverMatthew Fernandez2017-11-071-23/+3
| | | | | | This functionality is now better fulfilled by using an off-the-shelf network file system technology to share the BE object directory. This has the advantage of a more comprehensive and integrated security model as well.
* remove support for ArchMatthew Fernandez2017-10-253-8/+2
| | | | | | The last release of GNU Arch was in 2006, over ten years ago at time of writing. GNU suggests users should migrate repositories to Bazaar. This commit removes all support for Arch to reduce ongoing maintenance overheads.
* Update gitorious references in install docSandro Santilli2015-11-121-1/+1
|
* Typo fix.Eric S. Raymond2013-02-201-1/+1
|
* doc:Makefile: use Python 2.7 for generate-libbe-txt.pyW. Trevor King2012-11-121-1/+1
|
* doc:install: CherryPy is *not* used for HTTP, only for HTTPS.W. Trevor King2012-10-271-3/+4
| | | | | | For plain HTTP, we use wsgiref.simple_server from the stdlib. Also include the `html` command as a WSGI-based command.
* doc:power: add Zsh completion location and update Bash install locationW. Trevor King2012-10-271-1/+3
| | | | | This puts both scripts in the right spot on Gentoo, and shows the suggested installed filename (not just the suggested directory).
* doc:tutorial: use a Git tag for the `be diff` exampleW. Trevor King2012-10-261-2/+8
| | | | | | I haven't tagged 1.1.0 yet, but earlier tags do not use Bugs Everywhere Directory v1.5, and we don't have on-the-fly storage updates yet.
* doc:tutorial: fix ReST formatting for `be show --xml` exampleW. Trevor King2012-10-261-1/+1
|
* doc:tutorial: move "you think" before quote in initialization sectionW. Trevor King2012-10-261-1/+1
|
* doc:tutorial: fix ReST formatting for first `be comment` exampleW. Trevor King2012-10-261-1/+1
|
* doc:install: mention that we *do* post releases nowW. Trevor King2012-10-261-3/+2
|
* doc:install: mention that PyYAML is now optionalW. Trevor King2012-10-261-3/+6
|
* doc/install: fix paragraph indentation in man page installation discussionW. Trevor King2012-10-261-1/+1
|
* doc/install: point out relevant Debian bugs in a commentW. Trevor King2012-10-261-0/+3
|
* doc:install: fix dependency table ReST formattingW. Trevor King2012-10-261-2/+2
| | | | | | | | | | The header had been broken by commit f174d8943c2edea25306ab522c27f69bbebd0be3 Author: W. Trevor King <wking@tremily.us> Date: Thu May 10 08:56:02 2012 -0400 Update CherryPy dependency package to python-cherrypy3 on Debian.
* doc:index: mention that in-branch-bugs are not the only wayW. Trevor King2012-10-261-1/+3
|
* doc:config: use :file: to markup filenames.W. Trevor King2012-10-261-1/+1
|
* doc: update :class: to :py:class: for modern Sphinx.W. Trevor King2012-10-261-10/+10
|
* doc:conf: use `version (date)` in Sphinx docsW. Trevor King2012-10-261-2/+3
| | | | | | | | | | | | | | | Since commit bed7587fe4910f8e4b892a09675279c5a4ab5484 Author: W. Trevor King <wking@tremily.us> Date: Thu Oct 25 19:07:09 2012 -0400 version: use abbreviated SHA instead of explicit _VERSION in master branch the version SHA will either be explicit in version(), or version() will return a release tag. This makes the long SHA in the Sphinx docs unnecessary, so we can replace it with the more interesting commit date.
* doc: update :mod: to :py:mod: for modern Sphinx.W. Trevor King2012-10-265-10/+10
|
* doc: update :func: to :py:func: for modern Sphinx.W. Trevor King2012-10-262-2/+2
|
* storage:util:config: path() now defaults to ~/.config/bugs-everywhereW. Trevor King2012-10-262-0/+35
| | | | | Add a documentation section discussing the config file, respect XDG_CONFIG_HOME, and add BE_CONFIG_PATH.
* Ran update-copyright.py.W. Trevor King2012-10-161-1/+1
|
* doc:tutorial: fix typos in the attachment examples.Nicolas Bigaouette2012-09-191-3/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | I wrote the actual patch, but Nicolas gave pretty unambiguous directions, so I'm making him the author. On Wed, Sep 19, 2012 at 11:03:39AM -0400, Nicolas Bigaouette wrote: > Hi all, > > I'm trying out Bugs Everywhere, pretty neat! > > Reading the documentation, I see it's possible to add attachment to the bug > report. The "commenting on bugs" section of the tutorial[1] gives the > command for the attachment: > > > $ cat screenshot.png | be comment --content-type image/png bea/28f > > > or the following to reply to a specific comment: > > > $ be comment bea/28f “Whosit dissapears when you mouse-over whatsit.” > > $ cat screenshot.png | be comment --content-type image/png bea/28f/41d > > > > Both these commands fail as they will try to open the editor for entering > the comment. > > The fix is simply to append a single dash "-" at the end of the attachment > command to tell "be comment" to read the comment from stdin (see "be help > comment"). > > Also, the second example has not the same formatting as the first one. The > first one seems to have a "code" formatting, while the second is just > indented without any line breaks. > > Thanks! > > Nicolas > > [1] http://docs.bugseverywhere.org/tutorial.html#commenting-on-bugs
* doc:install: we only use CherryPy for HTTPS.W. Trevor King2012-08-291-2/+2
| | | | We use wsgiref.simple_server for HTTP.
* doc:tutorial: document `be serve-storage`.W. Trevor King2012-08-291-3/+17
|
* Update CherryPy dependency package to python-cherrypy3 on Debian.W. Trevor King2012-05-101-8/+8
| | | | | | | | | | | | | | | | Thanks to Tim Mazid for reporting the bug, and Israel Basurto for suggesting the fix. On Wed, May 09, 2012 at 07:26:14PM +1000, Tim Mazid wrote: > $ interfaces/web/cfbe.py ~/projects/proj/ > Bugs Everywhere Directory v1.4 > Traceback (most recent call last): > File "interfaces/web/cfbe.py", line 42, in <module> > cherrypy.quickstart(WebInterface, '/', app_config) > AttributeError: 'module' object has no attribute 'quickstart' > > This is with the latest be from git, and python-cherrypy 2.3.0-3 from > Debian wheezy.
* Fix deb-python -> dev-python typo in doc/install.txt.W. Trevor King2012-04-261-1/+1
|
* Oops, forgot to bump the version and date when tweaking the man page.W. Trevor King2012-02-251-2/+2
|
* Use a bare URL for the link from the man page to online docs.W. Trevor King2012-02-251-4/+3
| | | | | This will make it easier (possible?) for people using the roff version of the man page to follow the link.
* Use $ instead of % for the prompt in the man page bug submission example.W. Trevor King2012-02-251-3/+3
|
* Add CherryPy dependency and minimal install info to doc/install.txt.W. Trevor King2012-02-252-21/+69
| | | | | | | | | | | | | | | | I seem to have left CherryPy out of the earlier list. The extra handholding for minimal installations is an attempt to address problems people have had installing BE on non-Linux systems, where the standard build tools are less common. I also mention my Gentoo overlay and Michel Alexandre Salim's Fedora package, so people running Gentoo and Fedora don't have to bother figuring any of this out ;). Finally, I moved the package information up to the top of the install page, so people on supported systems realize they have an easy out before reading through the install procedure.
* Shuffle doc/conf.py to get the Git revision into the Sphinx documentation.W. Trevor King2012-02-171-10/+12
|
* Ran update-copyright.py.W. Trevor King2012-02-161-10/+10
|
* Mention `~/.local/bin/` when using default `--user` install.W. Trevor King2011-11-081-1/+3
|
* Correct doc/install.txt to refer to INSTALL_OPTIONS instead of PREFIX.W. Trevor King2011-11-081-2/+2
| | | | | | | This catches the docs up with the changes made in: commit a7ad89a6ad7da55089e6f9a4cdd645b7079ee04e Author: W. Trevor King <wking@drexel.edu> Date: Sat Apr 16 21:26:02 2011 -0400
* Add Jinja to the dependency documentation.W. Trevor King2011-09-071-0/+2
|
* Add 'Power features' page to the docs.W. Trevor King2011-05-252-0/+28
|
* Run update_copyright.py.W. Trevor King2011-05-251-1/+2
|
* Mention Stats.print_callees() in doc/hacking.txt.W. Trevor King2011-05-121-0/+4
|
* Mention Stats.print_callers() in doc/hacking.txt.W. Trevor King2011-05-121-3/+7
|
* Fix links to libbe.util.id from doc/tutorial.txt.W. Trevor King2011-05-111-3/+3
|
* Fix `IDs` and `Mercurial guide` links in docs.W. Trevor King2011-02-232-4/+4
|
* Numpydoc is distributed in Gentoo's science overlay.W. Trevor King2011-01-101-1/+4
|
* Update link to Numpy docstring guidelines.W. Trevor King2011-01-101-1/+1
|
* Use Docutils' rst2doc instead of DocBook XML to generate man page.W. Trevor King2011-01-104-170/+86
|
* Bumped to version 1.0.01.0.0Chris Ball2011-01-081-1/+1
|
* Merge branch 'master' of http://www.physics.drexel.edu/~wking/code/git/beChris Ball2011-01-081-7/+6
|\
| * Cleanup linking from doc/tutorial.txt to email and HTTP docs.W. Trevor King2010-12-061-7/+6
| |